Implements a function that depends on two variables. More...

#include <IntervalTabulated2DFunction.hpp>

Public Member Functions
	IntervalTabulated2DFunction ()

template<class DataContainer >
	IntervalTabulated2DFunction (const std::vector< Scalar > &xPos, const std::vector< Scalar > &yPos, const DataContainer &data, const bool xExtrapolate=false, const bool yExtrapolate=false)

size_t	numX () const
	Returns the number of sampling points in X direction. More...

size_t	numY () const
	Returns the number of sampling points in Y direction. More...

Scalar	xMin () const
	Returns the minimum of the X coordinate of the sampling points. More...

Scalar	xMax () const
	Returns the maximum of the X coordinate of the sampling points. More...

Scalar	yMin () const
	Returns the minimum of the Y coordinate of the sampling points. More...

Scalar	yMax () const
	Returns the maximum of the Y coordinate of the sampling points. More...

const std::vector< Scalar > &	xPos () const

const std::vector< Scalar > &	yPos () const

const std::vector< std::vector< Scalar > > &	samples () const

bool	xExtrapolate () const

bool	yExtrapolate () const

bool	operator== (const IntervalTabulated2DFunction< Scalar > &data) const

Scalar	valueAt (size_t i, size_t j) const
	Returns the value of a sampling point. More...

template<class Evaluation >
bool	applies (const Evaluation &x, const Evaluation &y) const
	Returns true if a coordinate lies in the tabulated range. More...

template<class Evaluation >
bool	appliesX (const Evaluation &x) const
	Returns true if a coordinate lies in the tabulated range on the x direction. More...

template<class Evaluation >
bool	appliesY (const Evaluation &y) const
	Returns true if a coordinate lies in the tabulated range on the y direction. More...

template<typename Evaluation >
Evaluation	eval (const Evaluation &x, const Evaluation &y) const
	Evaluate the function at a given (x,y) position. More...

Detailed Description

template<class Scalar>
class Opm::IntervalTabulated2DFunction< Scalar >

Implements a function that depends on two variables.

The function is sampled in regular intervals in both directions, i.e., the interpolation cells are rectangles. The table can be extrapolated in either direction.

Constructor & Destructor Documentation

◆ IntervalTabulated2DFunction() [1/2]

template<class Scalar >

Opm::IntervalTabulated2DFunction< Scalar >::IntervalTabulated2DFunction ( )

inline

◆ IntervalTabulated2DFunction() [2/2]

template<class Scalar >

template<class DataContainer >

Opm::IntervalTabulated2DFunction< Scalar >::IntervalTabulated2DFunction	(	const std::vector< Scalar > &	xPos,
		const std::vector< Scalar > &	yPos,
		const DataContainer &	data,
		const bool	xExtrapolate = `false`,
		const bool	yExtrapolate = `false`
	)

inline

References Opm::IntervalTabulated2DFunction< Scalar >::numX(), Opm::IntervalTabulated2DFunction< Scalar >::numY(), Opm::IntervalTabulated2DFunction< Scalar >::xPos(), and Opm::IntervalTabulated2DFunction< Scalar >::yPos().

Member Function Documentation

◆ applies()

template<class Scalar >

template<class Evaluation >

bool Opm::IntervalTabulated2DFunction< Scalar >::applies	(	const Evaluation &	x,
		const Evaluation &	y
	)		const

inline

Returns true if a coordinate lies in the tabulated range.

References Opm::IntervalTabulated2DFunction< Scalar >::appliesX(), and Opm::IntervalTabulated2DFunction< Scalar >::appliesY().

◆ appliesX()

template<class Scalar >

template<class Evaluation >

bool Opm::IntervalTabulated2DFunction< Scalar >::appliesX ( const Evaluation & x ) const

inline

Returns true if a coordinate lies in the tabulated range on the x direction.

References Opm::IntervalTabulated2DFunction< Scalar >::xMax(), and Opm::IntervalTabulated2DFunction< Scalar >::xMin().

Referenced by Opm::IntervalTabulated2DFunction< Scalar >::applies(), and Opm::IntervalTabulated2DFunction< Scalar >::eval().

◆ appliesY()

template<class Scalar >

template<class Evaluation >

bool Opm::IntervalTabulated2DFunction< Scalar >::appliesY ( const Evaluation & y ) const

inline

Returns true if a coordinate lies in the tabulated range on the y direction.

References Opm::IntervalTabulated2DFunction< Scalar >::yMax(), and Opm::IntervalTabulated2DFunction< Scalar >::yMin().

Referenced by Opm::IntervalTabulated2DFunction< Scalar >::applies(), and Opm::IntervalTabulated2DFunction< Scalar >::eval().

◆ eval()

template<class Scalar >

template<typename Evaluation >

Evaluation Opm::IntervalTabulated2DFunction< Scalar >::eval	(	const Evaluation &	x,
		const Evaluation &	y
	)		const

inline

Evaluate the function at a given (x,y) position.

If this method is called for a value outside of the tabulated range, and extrapolation is not allowed in the corresponding direction, a Opm::NumericalIssue exception is thrown.

References Opm::IntervalTabulated2DFunction< Scalar >::appliesX(), Opm::IntervalTabulated2DFunction< Scalar >::appliesY(), Opm::Valgrind::CheckDefined(), and Opm::IntervalTabulated2DFunction< Scalar >::valueAt().