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

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

#include <tutorial1problem.hh>

Inheritance diagram for Opm::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 &, unsigned, unsigned) const
 Returns the temperature at a given position. More...
 
template<class Context >
const DimMatrix & intrinsicPermeability (const Context &, unsigned, unsigned) const
 Returns the intrinsic permeability tensor [m^2] at a position. More...
 
template<class Context >
Scalar porosity (const Context &, unsigned, unsigned) const
 Defines the porosity [-] of the medium at a given position. More...
 
template<class Context >
const MaterialLawParams & materialLawParams (const Context &, unsigned, unsigned) const
 Returns the parameter object for the material law at a given position. More...
 
template<class Context >
void boundary (BoundaryRateVector &values, const Context &context, unsigned spaceIdx, unsigned timeIdx) const
 Evaluates the boundary conditions. More...
 
template<class Context >
void source (RateVector &sourceRate, const Context &, unsigned, unsigned) const
 
template<class Context >
void initial (PrimaryVariables &values, const Context &context, unsigned spaceIdx, unsigned timeIdx) const
 Evaluates the initial value at a given position in the domain. More...
 

Static Public Member Functions

static void registerParameters ()
 

Detailed Description

template<class TypeTag>
class Opm::Tutorial1Problem< TypeTag >

Tutorial problem using the "immiscible" model.

Constructor & Destructor Documentation

◆ Tutorial1Problem()

template<class TypeTag >
Opm::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

◆ boundary()

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

Evaluates the boundary conditions.

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

◆ finishInit()

template<class TypeTag >
void Opm::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.

◆ initial()

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

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

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

◆ intrinsicPermeability()

template<class TypeTag >
template<class Context >
const DimMatrix & Opm::Tutorial1Problem< TypeTag >::intrinsicPermeability ( const Context &  ,
unsigned  ,
unsigned   
) const
inline

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

◆ materialLawParams()

template<class TypeTag >
template<class Context >
const MaterialLawParams & Opm::Tutorial1Problem< TypeTag >::materialLawParams ( const Context &  ,
unsigned  ,
unsigned   
) const
inline

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

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

◆ name()

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

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

◆ porosity()

template<class TypeTag >
template<class Context >
Scalar Opm::Tutorial1Problem< TypeTag >::porosity ( const Context &  ,
unsigned  ,
unsigned   
) const
inline

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

◆ registerParameters()

template<class TypeTag >
static void Opm::Tutorial1Problem< TypeTag >::registerParameters ( )
inlinestatic

◆ source()

template<class TypeTag >
template<class Context >
void Opm::Tutorial1Problem< TypeTag >::source ( RateVector &  sourceRate,
const Context &  ,
unsigned  ,
unsigned   
) 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.

◆ temperature()

template<class TypeTag >
template<class Context >
Scalar Opm::Tutorial1Problem< TypeTag >::temperature ( const Context &  ,
unsigned  ,
unsigned   
) const
inline

Returns the temperature at a given position.

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

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