Opm::SatFuncInterpolant Class Reference

#include <ECLPropTable.hpp>

Classes
struct	ConvertUnits
struct	InTable
	Wrapper type to disambiguate API usage. Represents a table ID. More...
struct	ResultColumn
	Wrapper type to disambiguate API usage. Represents a column ID. More...

Public Member Functions
	SatFuncInterpolant (const ECLPropTableRawData &raw, const ConvertUnits &convert)
std::vector< double >	interpolate (const InTable &t, const ResultColumn &c, const std::vector< double > &x) const
std::vector< double >	connateSat () const
	Retrieve connate saturation from all tables. More...
std::vector< double >	criticalSat (const ResultColumn &c) const
std::vector< double >	maximumSat () const
	Retrieve maximum saturation in all tables. More...
const std::vector< double > &	saturationPoints (const InTable &t) const
ECLPropTableRawData::SizeType	numTables () const

Detailed Description

Collection of 1D interpolants from tabulated functions (e.g., the saturation functions).

Constructor & Destructor Documentation

SatFuncInterpolant()

Opm::SatFuncInterpolant::SatFuncInterpolant	(	const ECLPropTableRawData &	raw,
		const ConvertUnits &	convert
	)

Constructor.

Parameters

[in]	raw	Raw table data for this collection.
[in]	convert	Unit conversion support. Mostly applicable to capillary pressure. Assumed to convert raw table data to strict SI unit conventions.

Member Function Documentation

connateSat()

std::vector< double > Opm::SatFuncInterpolant::connateSat

(

)

const

Retrieve connate saturation from all tables.

criticalSat()

std::vector< double > Opm::SatFuncInterpolant::criticalSat

(

const ResultColumn &

c

)

const

Retrieve critical saturation for particular result column in all tables.

interpolate()

std::vector< double > Opm::SatFuncInterpolant::interpolate	(	const InTable &	t,
		const ResultColumn &	c,
		const std::vector< double > &	x
	)		const

Evaluate 1D interpolant in sequence of points.

Parameters

[in]	t	ID of sub-table of interpolant.
[in]	c	ID of result column/dependent variable.
[in]	x	Points at which to evaluate interpolant.

Returns

Function values of dependent variable c evaluated at points x in table t.

maximumSat()

std::vector< double > Opm::SatFuncInterpolant::maximumSat

(

)

const

Retrieve maximum saturation in all tables.

numTables()

ECLPropTableRawData::SizeType Opm::SatFuncInterpolant::numTables ( ) const

inline

Retrieve number of internal tables.

Returns

Number of internal tables.

saturationPoints()

const std::vector< double > & Opm::SatFuncInterpolant::saturationPoints

(

const InTable &

t

)

const

Retrieve unscaled sample points of independent variable in particular sub-table (saturation region).

Parameters

[in]

t

ID of sub-table of interpolant.

Returns

Abscissas of tabulated saturation function corresponding to particular saturation region.

---

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

• ECLPropTable.hpp