My Project
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Opm::DenseAd::Evaluation< ValueT, DynamicSize, staticSize > Class Template Reference

Represents a function evaluation and its derivatives w.r.t. More...

#include <DynamicEvaluation.hpp>

Public Types

typedef ValueT ValueType
 field type
 

Public Member Functions

int size () const
 number of derivatives
 
 Evaluation ()
 default constructor
 
 Evaluation (const Evaluation &other)=default
 copy other function evaluation
 
 Evaluation (Evaluation &&other)
 move other function evaluation (this only makes sense for dynamically allocated Evaluations)
 
Evaluation & operator= (Evaluation &&other)
 move assignment
 
 Evaluation (int numDerivatives)
 
template<class RhsValueType >
 Evaluation (int numDerivatives, const RhsValueType &c)
 
template<class RhsValueType >
 Evaluation (int nVars, const RhsValueType &c, int varPos)
 
void clearDerivatives ()
 
void print (std::ostream &os=std::cout) const
 
void copyDerivatives (const Evaluation &other)
 
Evaluation & operator+= (const Evaluation &other)
 
template<class RhsValueType >
Evaluation & operator+= (const RhsValueType &other)
 
Evaluation & operator-= (const Evaluation &other)
 
template<class RhsValueType >
Evaluation & operator-= (const RhsValueType &other)
 
Evaluation & operator*= (const Evaluation &other)
 
template<class RhsValueType >
Evaluation & operator*= (const RhsValueType &other)
 
Evaluation & operator/= (const Evaluation &other)
 
template<class RhsValueType >
Evaluation & operator/= (const RhsValueType &other)
 
Evaluation operator+ (const Evaluation &other) const
 
template<class RhsValueType >
Evaluation operator+ (const RhsValueType &other) const
 
Evaluation operator- (const Evaluation &other) const
 
template<class RhsValueType >
Evaluation operator- (const RhsValueType &other) const
 
Evaluation operator- () const
 
Evaluation operator* (const Evaluation &other) const
 
template<class RhsValueType >
Evaluation operator* (const RhsValueType &other) const
 
Evaluation operator/ (const Evaluation &other) const
 
template<class RhsValueType >
Evaluation operator/ (const RhsValueType &other) const
 
template<class RhsValueType >
Evaluation & operator= (const RhsValueType &other)
 
Evaluation & operator= (const Evaluation &other)=default
 
template<class RhsValueType >
bool operator== (const RhsValueType &other) const
 
bool operator== (const Evaluation &other) const
 
bool operator!= (const Evaluation &other) const
 
template<class RhsValueType >
bool operator!= (const RhsValueType &other) const
 
template<class RhsValueType >
bool operator> (RhsValueType other) const
 
bool operator> (const Evaluation &other) const
 
template<class RhsValueType >
bool operator< (RhsValueType other) const
 
bool operator< (const Evaluation &other) const
 
template<class RhsValueType >
bool operator>= (RhsValueType other) const
 
bool operator>= (const Evaluation &other) const
 
template<class RhsValueType >
bool operator<= (RhsValueType other) const
 
bool operator<= (const Evaluation &other) const
 
const ValueType & value () const
 
template<class RhsValueType >
void setValue (const RhsValueType &val)
 
const ValueType & derivative (int varIdx) const
 
void setDerivative (int varIdx, const ValueType &derVal)
 

Static Public Member Functions

static Evaluation createBlank (const Evaluation &x)
 
static Evaluation createConstantZero (const Evaluation &x)
 
static Evaluation createConstantOne (const Evaluation &x)
 
template<class RhsValueType >
static Evaluation createVariable (const RhsValueType &, int)
 
template<class RhsValueType >
static Evaluation createVariable (int nVars, const RhsValueType &value, int varPos)
 
template<class RhsValueType >
static Evaluation createVariable (const Evaluation &x, const RhsValueType &value, int varPos)
 
template<class RhsValueType >
static Evaluation createConstant (int nVars, const RhsValueType &value)
 
template<class RhsValueType >
static Evaluation createConstant (const RhsValueType &)
 
template<class RhsValueType >
static Evaluation createConstant (const Evaluation &x, const RhsValueType &value)
 

Static Public Attributes

static const int numVars = DynamicSize
 the template argument which specifies the number of derivatives (-1 == "DynamicSize" means runtime determined)
 

Protected Member Functions

int length_ () const
 length of internal data vector
 
constexpr int valuepos_ () const
 position index for value
 
constexpr int dstart_ () const
 start index for derivatives
 
int dend_ () const
 end+1 index for derivatives
 
void checkDefined_ () const
 instruct valgrind to check that the value and all derivatives of the Evaluation object are well-defined.
 

Detailed Description

template<class ValueT, unsigned staticSize>
class Opm::DenseAd::Evaluation< ValueT, DynamicSize, staticSize >

Represents a function evaluation and its derivatives w.r.t.

a run-time specified set of variables.

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