Ewoms::MultiPhaseBaseProblem< TypeTag > Class Template Reference

The base class for the problems of ECFV discretizations which deal with a multi-phase flow through a porous medium. More...

#include <multiphasebaseproblem.hh>

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

Public Member Functions

 MultiPhaseBaseProblem (Simulator &simulator)
 
template<class Context >
void intersectionIntrinsicPermeability (DimMatrix &result, const Context &context, int intersectionIdx, int timeIdx) const
 Returns the intrinsic permeability of an intersection. More...
 
void finishInit ()
 Called by the Ewoms::Simulator in order to initialize the problem. More...
 
Scalar solveTime () const
 Returns the total wall time spend on solving the system [s]. More...
 
Scalar updateTime () const
 Returns the total wall time spend on updating the iterative solutions [s]. More...
 
template<class Context >
void boundary (BoundaryRateVector &values, const Context &context, int spaceIdx, int timeIdx) const
 Evaluate the boundary conditions for a boundary segment. More...
 
template<class Context >
void constraints (Constraints &constraints, const Context &context, int spaceIdx, int timeIdx) const
 Evaluate the constraints for a control volume. More...
 
template<class Context >
void source (RateVector &rate, const Context &context, int spaceIdx, int timeIdx) const
 Evaluate the source term for all phases within a given sub-control-volume. More...
 
template<class Context >
void initial (PrimaryVariables &values, const Context &context, int spaceIdx, int timeIdx) const
 Evaluate the initial value for a control volume. More...
 
template<class Context >
Scalar extrusionFactor (const Context &context, int spaceIdx, int timeIdx) const
 Return how much the domain is extruded at a given sub-control volume. More...
 
Scalar extrusionFactor () const
 
void initialSolutionApplied ()
 Callback used by the model to indicate that the initial solution has been determined for all degrees of freedom. More...
 
void beginEpisode ()
 Called at the beginning of an simulation episode. More...
 
void beginTimeStep ()
 Called by the simulator before each time integration. More...
 
void beginIteration ()
 Called by the simulator before each Newton-Raphson iteration. More...
 
void endIteration ()
 Called by the simulator after each Newton-Raphson update. More...
 
void endTimeStep ()
 Called by the simulator after each time integration. More...
 
void endEpisode ()
 Called when the end of an simulation episode is reached. More...
 
void finalize ()
 Called after the simulation has been run sucessfully. More...
 
void timeIntegration ()
 Called by Ewoms::Simulator in order to do a time integration on the model. More...
 
Scalar nextTimeStepSize ()
 Called by Ewoms::Simulator whenever a solution for a time step has been computed and the simulation time has been updated. More...
 
bool shouldWriteRestartFile () const
 Returns true if a restart file should be written to disk. More...
 
bool shouldWriteOutput () const
 Returns true if the current solution should be written to disk (i.e. as a VTK file) More...
 
void advanceTimeLevel ()
 Called by the simulator after everything which can be done about the current time step is finished and the model should be prepared to do the next time integration. More...
 
std::string name () const
 The problem name. More...
 
const GridView & gridView () const
 The GridView which used by the problem. More...
 
const GlobalPosition & boundingBoxMin () const
 The coordinate of the corner of the GridView's bounding box with the smallest values. More...
 
const GlobalPosition & boundingBoxMax () const
 The coordinate of the corner of the GridView's bounding box with the largest values. More...
 
const VertexMapper & vertexMapper () const
 Returns the mapper for vertices to indices. More...
 
const ElementMapper & elementMapper () const
 Returns the mapper for elements to indices. More...
 
Simulatorsimulator ()
 Returns Simulator object used by the simulation. More...
 
const Simulatorsimulator () const
 Returns Simulator object used by the simulation. More...
 
Model & model ()
 Returns numerical model used for the problem. More...
 
const Model & model () const
 Returns numerical model used for the problem. More...
 
NewtonMethodnewtonMethod ()
 Returns object which implements the Newton method. More...
 
const NewtonMethodnewtonMethod () const
 Returns object which implements the Newton method. More...
 
template<class Restarter >
void serialize (Restarter &res)
 This method writes the complete state of the problem to the harddisk. More...
 
template<class Restarter >
void deserialize (Restarter &res)
 This method restores the complete state of the problem from disk. More...
 
void writeOutput (bool verbose=true)
 Write the relevant secondary variables of the current solution into an VTK output file. More...
 
VtkMultiWriterdefaultVtkWriter () const
 Method to retrieve the VTK writer which should be used to write the default ouput after each time step to disk. More...
 
Problem parameters
template<class Context >
const DimMatrix & intrinsicPermeability (const Context &context, int spaceIdx, int timeIdx) const
 Returns the intrinsic permeability tensor $[m^2]$ at a given position. More...
 
template<class Context >
Scalar porosity (const Context &context, int spaceIdx, int timeIdx) const
 Returns the porosity [] of the porous medium for a given control volume. More...
 
template<class Context >
Scalar heatCapacitySolid (const Context &context, int spaceIdx, int timeIdx) const
 Returns the heat capacity [J/(K m^3)] of the solid phase with no pores in the sub-control volume. More...
 
template<class Context >
const HeatConductionLawParams & heatConductionParams (const Context &context, int spaceIdx, int timeIdx) const
 Returns the parameter object for the heat conductivity law in a sub-control volume. More...
 
template<class Context >
Scalar tortuosity (const Context &context, int spaceIdx, int timeIdx) const
 Define the tortuosity. More...
 
template<class Context >
Scalar dispersivity (const Context &context, int spaceIdx, int timeIdx) const
 Define the dispersivity. More...
 
template<class Context >
const MaterialLawParams & materialLawParams (const Context &context, int spaceIdx, int timeIdx) const
 Returns the material law parameters $\mathrm{[K]}$ within a control volume. More...
 
template<class Context >
Scalar temperature (const Context &context, int spaceIdx, int timeIdx) const
 Returns the temperature $\mathrm{[K]}$ within a control volume. More...
 
Scalar temperature () const
 Returns the temperature $\mathrm{[K]}$ for an isothermal problem. More...
 
template<class Context >
const DimVector & gravity (const Context &context, int spaceIdx, int timeIdx) const
 Returns the acceleration due to gravity $\mathrm{[m/s^2]}$. More...
 
const DimVector & gravity () const
 Returns the acceleration due to gravity $\mathrm{[m/s^2]}$. More...
 

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the problem and the model. More...
 

Protected Member Functions

DimMatrix toDimMatrix_ (Scalar val) const
 Converts a Scalar value to an isotropic Tensor. More...
 

Protected Attributes

DimVector gravity_
 

Detailed Description

template<class TypeTag>
class Ewoms::MultiPhaseBaseProblem< TypeTag >

The base class for the problems of ECFV discretizations which deal with a multi-phase flow through a porous medium.

Constructor & Destructor Documentation

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

Member Function Documentation

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::advanceTimeLevel ( )
inlineinherited

Called by the simulator after everything which can be done about the current time step is finished and the model should be prepared to do the next time integration.

References Ewoms::FvBaseProblem< TypeTag >::model().

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::beginEpisode ( )
inlineinherited

Called at the beginning of an simulation episode.

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::beginIteration ( )
inlineinherited

Called by the simulator before each Newton-Raphson iteration.

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::beginTimeStep ( )
inlineinherited

Called by the simulator before each time integration.

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

Evaluate the boundary conditions for a boundary segment.

Parameters
valuesStores the fluxes over the boundary segment.
contextThe object representing the execution context from which this method is called.
spaceIdxThe local index of the spatial entity which represents the boundary segment.
timeIdxThe index used for the time discretization
template<class TypeTag >
const GlobalPosition& Ewoms::FvBaseProblem< TypeTag >::boundingBoxMax ( ) const
inlineinherited

The coordinate of the corner of the GridView's bounding box with the largest values.

template<class TypeTag >
const GlobalPosition& Ewoms::FvBaseProblem< TypeTag >::boundingBoxMin ( ) const
inlineinherited

The coordinate of the corner of the GridView's bounding box with the smallest values.

template<class TypeTag >
template<class Context >
void Ewoms::FvBaseProblem< TypeTag >::constraints ( Constraints &  constraints,
const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inlineinherited

Evaluate the constraints for a control volume.

Parameters
constraintsStores the values of the primary variables at a given spatial and temporal location.
contextThe object representing the execution context from which this method is called.
spaceIdxThe local index of the spatial entity which represents the boundary segment.
timeIdxThe index used for the time discretization
template<class TypeTag >
VtkMultiWriter& Ewoms::FvBaseProblem< TypeTag >::defaultVtkWriter ( ) const
inlineinherited

Method to retrieve the VTK writer which should be used to write the default ouput after each time step to disk.

template<class TypeTag >
template<class Restarter >
void Ewoms::FvBaseProblem< TypeTag >::deserialize ( Restarter &  res)
inlineinherited

This method restores the complete state of the problem from disk.

It is the inverse of the serialize() method.

Template Parameters
RestarterThe deserializer type
Parameters
resThe deserializer object

References Ewoms::VtkMultiWriter< GridView, vtkFormat >::deserialize().

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

Define the dispersivity.

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
const ElementMapper& Ewoms::FvBaseProblem< TypeTag >::elementMapper ( ) const
inlineinherited

Returns the mapper for elements to indices.

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::endEpisode ( )
inlineinherited

Called when the end of an simulation episode is reached.

Typically, a new episode is started in this method.

References Ewoms::Simulator< TypeTag >::episodeIndex(), and Ewoms::FvBaseProblem< TypeTag >::simulator().

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::endIteration ( )
inlineinherited

Called by the simulator after each Newton-Raphson update.

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::endTimeStep ( )
inlineinherited

Called by the simulator after each time integration.

This method is intended to do some post processing of the solution. (e.g., some additional output)

template<class TypeTag >
template<class Context >
Scalar Ewoms::FvBaseProblem< TypeTag >::extrusionFactor ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inlineinherited

Return how much the domain is extruded at a given sub-control volume.

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

Parameters
contextThe object representing the execution context from which this method is called.
spaceIdxThe local index of the spatial entity which represents the boundary segment.
timeIdxThe index used for the time discretization
template<class TypeTag >
Scalar Ewoms::FvBaseProblem< TypeTag >::extrusionFactor ( ) const
inlineinherited
template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::finishInit ( )
inlineinherited

Called by the Ewoms::Simulator in order to initialize the problem.

If you overload this method don't forget to call ParentType::finishInit()

template<class TypeTag >
template<class Context >
const DimVector& Ewoms::MultiPhaseBaseProblem< TypeTag >::gravity ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the acceleration due to gravity $\mathrm{[m/s^2]}$.

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
const DimVector& Ewoms::MultiPhaseBaseProblem< TypeTag >::gravity ( ) const
inline

Returns the acceleration due to gravity $\mathrm{[m/s^2]}$.

This method is used for problems where the gravitational acceleration does not depend on the spatial position. The default behaviour is that if the EnableGravity property is true, $\boldsymbol{g} = ( 0,\dots,\ -9.81)^T $ holds, else $\boldsymbol{g} = ( 0,\dots, 0)^T $.

References Ewoms::MultiPhaseBaseProblem< TypeTag >::gravity_.

template<class TypeTag >
const GridView& Ewoms::FvBaseProblem< TypeTag >::gridView ( ) const
inlineinherited
template<class TypeTag >
template<class Context >
Scalar Ewoms::MultiPhaseBaseProblem< TypeTag >::heatCapacitySolid ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the heat capacity [J/(K m^3)] of the solid phase with no pores in the sub-control volume.

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
template<class Context >
const HeatConductionLawParams& Ewoms::MultiPhaseBaseProblem< TypeTag >::heatConductionParams ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the parameter object for the heat conductivity law in a sub-control volume.

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
template<class Context >
void Ewoms::FvBaseProblem< TypeTag >::initial ( PrimaryVariables &  values,
const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inlineinherited

Evaluate the initial value for a control volume.

Parameters
valuesStores the primary variables.
contextThe object representing the execution context from which this method is called.
spaceIdxThe local index of the spatial entity which represents the boundary segment.
timeIdxThe index used for the time discretization
template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::initialSolutionApplied ( )
inlineinherited

Callback used by the model to indicate that the initial solution has been determined for all degrees of freedom.

template<class TypeTag >
template<class Context >
void Ewoms::MultiPhaseBaseProblem< TypeTag >::intersectionIntrinsicPermeability ( DimMatrix &  result,
const Context &  context,
int  intersectionIdx,
int  timeIdx 
) const
inline

Returns the intrinsic permeability of an intersection.

This method is specific to the finite volume discretizations. If left unspecified, it calls the intrinsicPermeability() method for the intersection's interior and exterior finite volumes and averages them harmonically. Note that if this function is defined, the intrinsicPermeability() method does not need to be defined by the problem (if a finite-volume discretization is used).

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

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

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
template<class Context >
const MaterialLawParams& Ewoms::MultiPhaseBaseProblem< TypeTag >::materialLawParams ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the material law parameters $\mathrm{[K]}$ within a control volume.

If you get a compiler error at this method, you set the MaterialLaw property to something different than Opm::NullMaterialLaw. In this case, you have to overload the matererialLaw() method in the derived class!

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
const Model& Ewoms::FvBaseProblem< TypeTag >::model ( ) const
inlineinherited

Returns numerical model used for the problem.

References Ewoms::Simulator< TypeTag >::model().

template<class TypeTag >
std::string Ewoms::FvBaseProblem< TypeTag >::name ( ) const
inlineinherited

The problem name.

This is used as a prefix for files generated by the simulation. It is highly recommend to overwrite this method in the concrete problem which is simulated.

Referenced by Ewoms::FvBaseProblem< TypeTag >::FvBaseProblem().

template<class TypeTag >
NewtonMethod& Ewoms::FvBaseProblem< TypeTag >::newtonMethod ( )
inlineinherited
template<class TypeTag >
const NewtonMethod& Ewoms::FvBaseProblem< TypeTag >::newtonMethod ( ) const
inlineinherited

Returns object which implements the Newton method.

References Ewoms::FvBaseProblem< TypeTag >::model().

template<class TypeTag >
Scalar Ewoms::FvBaseProblem< TypeTag >::nextTimeStepSize ( )
inlineinherited

Called by Ewoms::Simulator whenever a solution for a time step has been computed and the simulation time has been updated.

References EWOMS_GET_PARAM, Ewoms::Simulator< TypeTag >::maxTimeStepSize(), Ewoms::FvBaseProblem< TypeTag >::newtonMethod(), and Ewoms::FvBaseProblem< TypeTag >::simulator().

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

Returns the porosity [] of the porous medium for a given control volume.

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
static void Ewoms::MultiPhaseBaseProblem< TypeTag >::registerParameters ( )
inlinestatic

Register all run-time parameters for the problem and the model.

References EWOMS_REGISTER_PARAM.

template<class TypeTag >
template<class Restarter >
void Ewoms::FvBaseProblem< TypeTag >::serialize ( Restarter &  res)
inlineinherited

This method writes the complete state of the problem to the harddisk.

The file will start with the prefix returned by the name() method, has the current time of the simulation clock in it's name and uses the extension .ers. (Ewoms ReStart file.) See Ewoms::Restart for details.

Template Parameters
RestarterThe serializer type
Parameters
resThe serializer object

References Ewoms::VtkMultiWriter< GridView, vtkFormat >::serialize().

template<class TypeTag >
bool Ewoms::FvBaseProblem< TypeTag >::shouldWriteOutput ( ) const
inlineinherited

Returns true if the current solution should be written to disk (i.e. as a VTK file)

The default behavior is to write out the solution for every time step. This method is should be overwritten by the implementation if the default behavior is deemed insufficient.

template<class TypeTag >
bool Ewoms::FvBaseProblem< TypeTag >::shouldWriteRestartFile ( ) const
inlineinherited

Returns true if a restart file should be written to disk.

The default behavior is to write one restart file every 10 time steps. This method should be overwritten by the implementation if the default behavior is deemed insufficient.

References Ewoms::FvBaseProblem< TypeTag >::simulator(), and Ewoms::Simulator< TypeTag >::timeStepIndex().

template<class TypeTag >
const Simulator& Ewoms::FvBaseProblem< TypeTag >::simulator ( ) const
inlineinherited

Returns Simulator object used by the simulation.

template<class TypeTag >
Scalar Ewoms::FvBaseProblem< TypeTag >::solveTime ( ) const
inlineinherited

Returns the total wall time spend on solving the system [s].

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

Evaluate the source term for all phases within a given sub-control-volume.

Parameters
rateStores the values of the volumetric creation/anihilition rates of the conserved quantities.
contextThe object representing the execution context from which this method is called.
spaceIdxThe local index of the spatial entity which represents the boundary segment.
timeIdxThe index used for the time discretization
template<class TypeTag >
template<class Context >
Scalar Ewoms::MultiPhaseBaseProblem< TypeTag >::temperature ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Returns the temperature $\mathrm{[K]}$ within a control volume.

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
Scalar Ewoms::MultiPhaseBaseProblem< TypeTag >::temperature ( ) const
inline

Returns the temperature $\mathrm{[K]}$ for an isothermal problem.

This is not specific to the discretization. By default it just throws an exception so it must be overloaded by the problem if no energy equation is to be used.

template<class TypeTag >
DimMatrix Ewoms::MultiPhaseBaseProblem< TypeTag >::toDimMatrix_ ( Scalar  val) const
inlineprotected

Converts a Scalar value to an isotropic Tensor.

This is convenient e.g. for specifying intrinsic permebilities:

auto permTensor = this->toDimMatrix_(1e-12);
Parameters
valThe scalar value which should be expressed as a tensor
template<class TypeTag >
template<class Context >
Scalar Ewoms::MultiPhaseBaseProblem< TypeTag >::tortuosity ( const Context &  context,
int  spaceIdx,
int  timeIdx 
) const
inline

Define the tortuosity.

Parameters
contextReference to the object which represents the current execution context.
spaceIdxThe local index of spatial entity defined by the context
timeIdxThe index used by the time discretization.
template<class TypeTag >
Scalar Ewoms::FvBaseProblem< TypeTag >::updateTime ( ) const
inlineinherited

Returns the total wall time spend on updating the iterative solutions [s].

template<class TypeTag >
const VertexMapper& Ewoms::FvBaseProblem< TypeTag >::vertexMapper ( ) const
inlineinherited

Returns the mapper for vertices to indices.

template<class TypeTag >
void Ewoms::FvBaseProblem< TypeTag >::writeOutput ( bool  verbose = true)
inlineinherited

Member Data Documentation

template<class TypeTag >
DimVector Ewoms::MultiPhaseBaseProblem< TypeTag >::gravity_
protected

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