Ewoms::FvBasePrimaryVariables< TypeTag > Class Template Reference

Represents the primary variables used by the a model. More...

#include <fvbaseprimaryvariables.hh>

Inheritance diagram for Ewoms::FvBasePrimaryVariables< TypeTag >:
Inheritance graph

Public Member Functions

 FvBasePrimaryVariables ()
 
 FvBasePrimaryVariables (Scalar value)
 Construction from a scalar value. More...
 
 FvBasePrimaryVariables (const FvBasePrimaryVariables &value)
 Assignment from another primary variables object. More...
 
Evaluation makeEvaluation (int varIdx, int timeIdx) const
 Return a primary variable intensive evaluation. More...
 
template<class FluidState >
void assignNaive (const FluidState &fluidState)
 Assign the primary variables "somehow" from a fluid state. More...
 
void checkDefined () const
 Instruct valgrind to check the definedness of all attributes of this class. More...
 

Detailed Description

template<class TypeTag>
class Ewoms::FvBasePrimaryVariables< TypeTag >

Represents the primary variables used by the a model.

Constructor & Destructor Documentation

template<class TypeTag >
Ewoms::FvBasePrimaryVariables< TypeTag >::FvBasePrimaryVariables ( )
inline
template<class TypeTag >
Ewoms::FvBasePrimaryVariables< TypeTag >::FvBasePrimaryVariables ( Scalar  value)
inline

Construction from a scalar value.

template<class TypeTag >
Ewoms::FvBasePrimaryVariables< TypeTag >::FvBasePrimaryVariables ( const FvBasePrimaryVariables< TypeTag > &  value)
inline

Assignment from another primary variables object.

Member Function Documentation

template<class TypeTag >
template<class FluidState >
void Ewoms::FvBasePrimaryVariables< TypeTag >::assignNaive ( const FluidState &  fluidState)
inline

Assign the primary variables "somehow" from a fluid state.

That is without considering any consistency issues which the fluid state might have. This method is guaranteed to produce consistent results if the fluid state is consistent to the properties at a given spatial location. (Where "consistent results" means that the same fluid state can be reconstructed from the primary variables.)

template<class TypeTag >
void Ewoms::FvBasePrimaryVariables< TypeTag >::checkDefined ( ) const
inline

Instruct valgrind to check the definedness of all attributes of this class.

template<class TypeTag >
Evaluation Ewoms::FvBasePrimaryVariables< TypeTag >::makeEvaluation ( int  varIdx,
int  timeIdx 
) const
inline

Return a primary variable intensive evaluation.

i.e., the result represents the function f = x_i if the time index is zero, else it represents the a constant f = x_i. (the difference is that in the first case, the derivative w.r.t. x_i is 1, while it is 0 in the second case.


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