This class uses linear interpolation to compute the value (and its derivative) of a function f sampled at uniform points. More...

#include <UniformTableLinear.hpp>

Public Types
enum	RangePolicy { Throw = 0 , ClosestValue = 1 , Extrapolate = 2 }
	Policies for how to behave when trying to evaluate outside the domain. More...

Public Member Functions
	UniformTableLinear ()
	Default constructor. More...

	UniformTableLinear (double xmin, double xmax, const std::vector< T > &y_values)
	Construct from vector of y-values. More...

	UniformTableLinear (double xmin, double xmax, const T *y_values, int num_y_values)
	Construct from array of y-values. More...

std::pair< double, double >	domain ()
	Get the domain. More...

void	rescaleDomain (std::pair< double, double > new_domain)
	Rescale the domain. More...

double	operator() (const double x) const
	Evaluate the value at x. More...

double	derivative (const double x) const
	Evaluate the derivative at x. More...

bool	operator== (const UniformTableLinear &other) const
	Equality operator. More...

void	setLeftPolicy (RangePolicy rp)
	Sets the behavioural policy for evaluation to the left of the domain. More...

void	setRightPolicy (RangePolicy rp)
	Sets the behavioural policy for evaluation to the right of the domain. More...

Protected Attributes
double	xmin_

double	xmax_

double	xdelta_

std::vector< T >	y_values_

RangePolicy	left_

RangePolicy	right_

Friends
template<typename U >
std::ostream &	operator<< (std::ostream &os, const UniformTableLinear< U > &t)

Detailed Description

template<typename T>
class Opm::UniformTableLinear< T >

This class uses linear interpolation to compute the value (and its derivative) of a function f sampled at uniform points.

Template Parameters

T	the range type of the function (should be an algebraic ring type)

Member Enumeration Documentation

◆ RangePolicy

template<typename T >

enum Opm::UniformTableLinear::RangePolicy

Policies for how to behave when trying to evaluate outside the domain.

Enumerator
Throw
ClosestValue
Extrapolate

Constructor & Destructor Documentation

◆ UniformTableLinear() [1/3]

template<typename T >

Opm::UniformTableLinear< T >::UniformTableLinear

inline

Default constructor.

◆ UniformTableLinear() [2/3]

template<typename T >

Opm::UniformTableLinear< T >::UniformTableLinear	(	double	xmin,
		double	xmax,
		const std::vector< T > &	y_values
	)

inline

Construct from vector of y-values.

Parameters

xmin	the x value corresponding to the first y value.
xmax	the x value corresponding to the last y value.
y_values	vector of range values.

References Opm::UniformTableLinear< T >::xdelta_.

◆ UniformTableLinear() [3/3]

template<typename T >

Opm::UniformTableLinear< T >::UniformTableLinear	(	double	xmin,
		double	xmax,
		const T *	y_values,
		int	num_y_values
	)

inline

Construct from array of y-values.

Parameters

xmin	the x value corresponding to the first y value.
xmax	the x value corresponding to the last y value.
y_values	array of range values.
num_y_values	the number of values in y_values.

References Opm::UniformTableLinear< T >::xdelta_, and Opm::UniformTableLinear< T >::y_values_.

Member Function Documentation

◆ derivative()

template<typename T >

double Opm::UniformTableLinear< T >::derivative ( const double x ) const

inline

Evaluate the derivative at x.

Parameters

x	a domain value

Returns: f'(x)

References exprtk::details::numeric::max(), exprtk::details::numeric::min(), exprtk::details::value(), and exprtk::details::x().

◆ domain()

template<typename T >

std::pair< double, double > Opm::UniformTableLinear< T >::domain

inline

Get the domain.

Returns: the domain as a pair of doubles.

◆ operator()()

template<typename T >

double Opm::UniformTableLinear< T >::operator() ( const double x ) const

inline

Evaluate the value at x.

Parameters

x	a domain value

Returns: f(x)

References exprtk::details::numeric::max(), exprtk::details::numeric::min(), and exprtk::details::x().

◆ operator==()

template<typename T >

bool Opm::UniformTableLinear< T >::operator== ( const UniformTableLinear< T > & other ) const

inline

Equality operator.

Parameters

other another UniformTableLinear.

Returns: true if they are represented exactly alike.

References Opm::UniformTableLinear< T >::left_, Opm::UniformTableLinear< T >::right_, Opm::UniformTableLinear< T >::xdelta_, Opm::UniformTableLinear< T >::xmin_, and Opm::UniformTableLinear< T >::y_values_.

◆ rescaleDomain()

template<typename T >

void Opm::UniformTableLinear< T >::rescaleDomain ( std::pair< double, double > new_domain )

inline

Rescale the domain.

Parameters

new_domain the new domain as a pair of doubles.

◆ setLeftPolicy()

template<typename T >

void Opm::UniformTableLinear< T >::setLeftPolicy ( RangePolicy rp )

inline

Sets the behavioural policy for evaluation to the left of the domain.

Parameters

rp	the policy

References OPM_THROW.

◆ setRightPolicy()

template<typename T >

void Opm::UniformTableLinear< T >::setRightPolicy ( RangePolicy rp )

inline

Sets the behavioural policy for evaluation to the right of the domain.

Parameters

rp	the policy

References OPM_THROW.

Friends And Related Function Documentation

◆ operator<<

template<typename T >

template<typename U >

std::ostream & operator<<	(	std::ostream &	os,
		const UniformTableLinear< U > &	t
	)

Referenced by Opm::UniformTableLinear< T >::operator==(), and Opm::UniformTableLinear< T >::UniformTableLinear().

The documentation for this class was generated from the following file:

UniformTableLinear.hpp

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ RangePolicy

Constructor & Destructor Documentation

◆ UniformTableLinear() [1/3]

◆ UniformTableLinear() [2/3]

◆ UniformTableLinear() [3/3]

Member Function Documentation

◆ derivative()

◆ domain()

◆ operator()()

◆ operator==()

◆ rescaleDomain()

◆ setLeftPolicy()

◆ setRightPolicy()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ left_

◆ right_

◆ xdelta_

◆ xmax_

◆ xmin_

◆ y_values_