Public Member Functions | List of all members
Ewoms::Tutorial1Problem< TypeTag > Class Template Reference

Tutorial problem using the "immiscible" model. More...

#include <tutorial1problem.hh>

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

Public Member Functions

 Tutorial1Problem (Simulator &simulator)
 
void finishInit ()
 
std::string name () const
 Specifies the problem name. This is used for files generated by the simulation. More...
 
template<class Context >
Scalar temperature (const Context &context, int spaceIdx, int timeIdx) const
 Returns the temperature at a given position. More...
 
template<class Context >
const DimMatrix & intrinsicPermeability (const Context &context, int spaceIdx, int timeIdx) const
 Returns the intrinsic permeability tensor [m^2] at a position. More...
 
template<class Context >
Scalar porosity (const Context &context, int spaceIdx, int timeIdx) const
 Defines the porosity [-] of the medium at a given position. More...
 
template<class Context >
const MaterialLawParams & materialLawParams (const Context &context, int spaceIdx, int timeIdx) const
 Returns the parameter object for the material law at a given position. More...
 
template<class Context >
void boundary (BoundaryRateVector &values, const Context &context, int spaceIdx, int timeIdx) const
 Evaluates the boundary conditions. More...
 
template<class Context >
void source (RateVector &source, const Context &context, int spaceIdx, int timeIdx) const
 
template<class Context >
void initial (PrimaryVariables &values, const Context &context, int spaceIdx, int timeIdx) const
 Evaluates the initial value at a given position in the domain. More...
 

Detailed Description

template<class TypeTag>
class Ewoms::Tutorial1Problem< TypeTag >

Tutorial problem using the "immiscible" model.

Constructor & Destructor Documentation

template<class TypeTag >
Ewoms::Tutorial1Problem< TypeTag >::Tutorial1Problem ( Simulator &  simulator)
inline

The constructor of the problem. This only allocates the memory required by the problem. The constructor is supposed to never ever throw an exception.

Member Function Documentation

template<class TypeTag >
template<class Context >
void Ewoms::Tutorial1Problem< TypeTag >::boundary ( BoundaryRateVector &  values,
const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Evaluates the boundary conditions.

References Ewoms::Tutorial1Problem< TypeTag >::materialLawParams(), and Ewoms::Tutorial1Problem< TypeTag >::temperature().

template<class TypeTag >
void Ewoms::Tutorial1Problem< TypeTag >::finishInit ( )
inline

This method initializes the data structures allocated by the problem constructor. In contrast to the constructor, exceptions thrown from within this method won't lead to segmentation faults.

template<class TypeTag >
template<class Context >
void Ewoms::Tutorial1Problem< TypeTag >::initial ( PrimaryVariables &  values,
const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Evaluates the initial value at a given position in the domain.

References Ewoms::Tutorial1Problem< TypeTag >::materialLawParams(), and Ewoms::Tutorial1Problem< TypeTag >::temperature().

template<class TypeTag >
template<class Context >
const DimMatrix& Ewoms::Tutorial1Problem< TypeTag >::intrinsicPermeability ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the intrinsic permeability tensor [m^2] at a position.

template<class TypeTag >
template<class Context >
const MaterialLawParams& Ewoms::Tutorial1Problem< TypeTag >::materialLawParams ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the parameter object for the material law at a given position.

Referenced by Ewoms::Tutorial1Problem< TypeTag >::boundary(), and Ewoms::Tutorial1Problem< TypeTag >::initial().

template<class TypeTag >
std::string Ewoms::Tutorial1Problem< TypeTag >::name ( ) const
inline

Specifies the problem name. This is used for files generated by the simulation.

template<class TypeTag >
template<class Context >
Scalar Ewoms::Tutorial1Problem< TypeTag >::porosity ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Defines the porosity [-] of the medium at a given position.

template<class TypeTag >
template<class Context >
void Ewoms::Tutorial1Problem< TypeTag >::source ( RateVector &  source,
const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Evaluates the source term for all conserved quantities at a given position of the domain [kg/(m^3 * s)]. Positive values mean that mass is created.

template<class TypeTag >
template<class Context >
Scalar Ewoms::Tutorial1Problem< TypeTag >::temperature ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the temperature at a given position.

Referenced by Ewoms::Tutorial1Problem< TypeTag >::boundary(), and Ewoms::Tutorial1Problem< TypeTag >::initial().

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