OPM - Reference Documentation for opm-material

Represents a function evaluation and its derivatives w.r.t. a fixed set of variables. More...

#include <Evaluation.hpp>

Public Types
enum	{ size = numVars }

typedef ScalarT	Scalar

Public Member Functions
	Evaluation ()

	Evaluation (const Evaluation &other)

	Evaluation (Scalar c)

void	print (std::ostream &os=std::cout) const

Evaluation &	operator+= (const Evaluation &other)

Evaluation &	operator+= (Scalar other)

Evaluation &	operator-= (const Evaluation &other)

Evaluation &	operator-= (Scalar other)

Evaluation &	operator*= (const Evaluation &other)

Evaluation &	operator*= (Scalar other)

Evaluation &	operator/= (const Evaluation &other)

Evaluation &	operator/= (Scalar other)

Evaluation	operator+ (const Evaluation &other) const

Evaluation	operator+ (Scalar other) const

Evaluation	operator- (const Evaluation &other) const

Evaluation	operator- (Scalar other) const

Evaluation	operator- () const

Evaluation	operator* (const Evaluation &other) const

Evaluation	operator* (Scalar other) const

Evaluation	operator/ (const Evaluation &other) const

Evaluation	operator/ (Scalar other) const

Evaluation &	operator= (Scalar other)

Evaluation &	operator= (const Evaluation &other)

bool	operator== (Scalar other) const

bool	operator== (const Evaluation &other) const

bool	isSame (const Evaluation &other, Scalar tolerance) const

bool	operator!= (const Evaluation &other) const

bool	operator> (Scalar other) const

bool	operator> (const Evaluation &other) const

bool	operator< (Scalar other) const

bool	operator< (const Evaluation &other) const

bool	operator>= (Scalar other) const

bool	operator>= (const Evaluation &other) const

bool	operator<= (Scalar other) const

bool	operator<= (const Evaluation &other) const

Static Public Member Functions
static Evaluation	createVariable (Scalar value, unsigned varPos)

static Evaluation	createConstant (Scalar value)

Public Attributes
Scalar	value

std::array< Scalar, size >	derivatives

Detailed Description

template<class ScalarT, class VarSetTag, int numVars>
class Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >

Represents a function evaluation and its derivatives w.r.t. a fixed set of variables.

Member Typedef Documentation

template<class ScalarT, class VarSetTag, int numVars>

typedef ScalarT Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::Scalar

Member Enumeration Documentation

template<class ScalarT, class VarSetTag, int numVars>

anonymous enum

Enumerator
size

Constructor & Destructor Documentation

template<class ScalarT, class VarSetTag, int numVars>

Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::Evaluation ( )

inline

template<class ScalarT, class VarSetTag, int numVars>

Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::Evaluation ( const Evaluation< ScalarT, VarSetTag, numVars > & other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::Evaluation ( Scalar c )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

Member Function Documentation

template<class ScalarT, class VarSetTag, int numVars>

static Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::createConstant ( Scalar value )

inlinestatic

References Valgrind::CheckDefined(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

static Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::createVariable	(	Scalar	value,
		unsigned	varPos
	)

inlinestatic

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::isSame	(	const Evaluation< ScalarT, VarSetTag, numVars > &	other,
		Scalar	tolerance
	)		const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator!= ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator==().

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator* ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator* ( Scalar other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator*= ( const Evaluation< ScalarT, VarSetTag, numVars > & other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator*= ( Scalar other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator+ ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator+ ( Scalar other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator+= ( const Evaluation< ScalarT, VarSetTag, numVars > & other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator+= ( Scalar other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator- ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator- ( Scalar other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator- ( ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator-= ( const Evaluation< ScalarT, VarSetTag, numVars > & other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator-= ( Scalar other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator/ ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator/ ( Scalar other ) const

inline

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator/= ( const Evaluation< ScalarT, VarSetTag, numVars > & other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator/= ( Scalar other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator< ( Scalar other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator< ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator<= ( Scalar other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator<= ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator= ( Scalar other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

Evaluation& Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator= ( const Evaluation< ScalarT, VarSetTag, numVars > & other )

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator== ( Scalar other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

Referenced by Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator!=().

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator== ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::size, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator> ( Scalar other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator> ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator>= ( Scalar other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

bool Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator>= ( const Evaluation< ScalarT, VarSetTag, numVars > & other ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

template<class ScalarT, class VarSetTag, int numVars>

void Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::print ( std::ostream & os = std::cout ) const

inline

References Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives, and Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value.

Member Data Documentation

template<class ScalarT, class VarSetTag, int numVars>

std::array<Scalar, size> Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::derivatives

Referenced by Opm::LocalAd::abs(), Opm::LocalAd::acos(), Opm::LocalAd::asin(), Opm::LocalAd::atan(), Opm::LocalAd::atan2(), Opm::LocalAd::cos(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::createConstant(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::createVariable(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::Evaluation(), Opm::LocalAd::exp(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::isSame(), Opm::LocalAd::log(), Opm::LocalAd::max(), Opm::LocalAd::min(), Opm::LocalAd::operator*(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator*=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator+=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator-(), Opm::LocalAd::operator-(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator-=(), Opm::LocalAd::operator/(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator/=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator==(), Opm::LocalAd::pow(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::print(), Opm::LocalAd::sin(), Opm::LocalAd::sqrt(), and Opm::LocalAd::tan().

template<class ScalarT, class VarSetTag, int numVars>

Scalar Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::value

Referenced by Opm::LocalAd::abs(), Opm::LocalAd::acos(), Opm::LocalAd::asin(), Opm::LocalAd::atan(), Opm::LocalAd::atan2(), Opm::LocalAd::cos(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::createConstant(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::createVariable(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::Evaluation(), Opm::LocalAd::exp(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::isSame(), Opm::LocalAd::log(), Opm::LocalAd::max(), Opm::LocalAd::min(), Opm::LocalAd::operator!=(), Opm::LocalAd::operator*(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator*=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator+=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator-(), Opm::LocalAd::operator-(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator-=(), Opm::LocalAd::operator/(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator/=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator<(), Opm::LocalAd::operator<<(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator<=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator=(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator==(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator>(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::operator>=(), Opm::LocalAd::pow(), Opm::LocalAd::Evaluation< ScalarT, VarSetTag, numVars >::print(), Opm::LocalAd::sin(), Opm::LocalAd::sqrt(), Opm::LocalAd::tan(), and Opm::MathToolbox< Opm::LocalAd::Evaluation< ScalarT, VariableSetTag, numVars >, false >::value().

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

Evaluation.hpp