My Project
Loading...
Searching...
No Matches
Opm::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 Opm::MultiPhaseBaseProblem< TypeTag >:
Opm::FvBaseProblem< TypeTag > Opm::BlackOilProblem< TypeTag > Opm::DiscreteFractureProblem< TypeTag >

Public Member Functions

 MultiPhaseBaseProblem (Simulator &simulator)
 
template<class Context >
void intersectionIntrinsicPermeability (DimMatrix &result, const Context &context, unsigned intersectionIdx, unsigned timeIdx) const
 Returns the intrinsic permeability of an intersection.
 
- Public Member Functions inherited from Opm::FvBaseProblem< TypeTag >
 FvBaseProblem (Simulator &simulator)
 
bool recycleFirstIterationStorage () const
 Return if the storage term of the first iteration is identical to the storage term for the solution of the previous time step.
 
std::string outputDir () const
 Determine the directory for simulation output.
 
void finishInit ()
 Called by the Opm::Simulator in order to initialize the problem.
 
void prefetch (const Element &) const
 Allows to improve the performance by prefetching all data which is associated with a given element.
 
void gridChanged ()
 Handle changes of the grid.
 
template<class Context >
void boundary (BoundaryRateVector &, const Context &, unsigned, unsigned) const
 Evaluate the boundary conditions for a boundary segment.
 
template<class Context >
void constraints (Constraints &, const Context &, unsigned, unsigned) const
 Evaluate the constraints for a control volume.
 
template<class Context >
void source (RateVector &, const Context &, unsigned, unsigned) const
 Evaluate the source term for all phases within a given sub-control-volume.
 
template<class Context >
void initial (PrimaryVariables &, const Context &, unsigned, unsigned) const
 Evaluate the initial value for a control volume.
 
template<class Context >
Scalar extrusionFactor (const Context &, unsigned, unsigned) const
 Return how much the domain is extruded at a given sub-control volume.
 
Scalar extrusionFactor () const
 
void initialSolutionApplied ()
 Callback used by the model to indicate that the initial solution has been determined for all degrees of freedom.
 
void beginEpisode ()
 Called at the beginning of an simulation episode.
 
void beginTimeStep ()
 Called by the simulator before each time integration.
 
void beginIteration ()
 Called by the simulator before each Newton-Raphson iteration.
 
void endIteration ()
 Called by the simulator after each Newton-Raphson update.
 
void endTimeStep ()
 Called by the simulator after each time integration.
 
void endEpisode ()
 Called when the end of an simulation episode is reached.
 
void finalize ()
 Called after the simulation has been run sucessfully.
 
void timeIntegration ()
 Called by Opm::Simulator in order to do a time integration on the model.
 
Scalar minTimeStepSize () const
 Returns the minimum allowable size of a time step.
 
unsigned maxTimeIntegrationFailures () const
 Returns the maximum number of subsequent failures for the time integration before giving up.
 
bool continueOnConvergenceError () const
 Returns if we should continue with a non-converged solution instead of giving up if we encounter a time step size smaller than the minimum time step size.
 
void setNextTimeStepSize (Scalar dt)
 Impose the next time step size to be used externally.
 
Scalar nextTimeStepSize () const
 Called by Opm::Simulator whenever a solution for a time step has been computed and the simulation time has been updated.
 
bool shouldWriteRestartFile () const
 Returns true if a restart file should be written to disk.
 
bool shouldWriteOutput () const
 Returns true if the current solution should be written to disk (i.e.
 
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.
 
std::string name () const
 The problem name.
 
const GridView & gridView () const
 The GridView which used by the problem.
 
const GlobalPosition & boundingBoxMin () const
 The coordinate of the corner of the GridView's bounding box with the smallest values.
 
const GlobalPosition & boundingBoxMax () const
 The coordinate of the corner of the GridView's bounding box with the largest values.
 
const VertexMapper & vertexMapper () const
 Returns the mapper for vertices to indices.
 
const ElementMapper & elementMapper () const
 Returns the mapper for elements to indices.
 
Simulator & simulator ()
 Returns Simulator object used by the simulation.
 
const Simulator & simulator () const
 Returns Simulator object used by the simulation.
 
Model & model ()
 Returns numerical model used for the problem.
 
const Model & model () const
 Returns numerical model used for the problem.
 
NewtonMethod & newtonMethod ()
 Returns object which implements the Newton method.
 
const NewtonMethod & newtonMethod () const
 Returns object which implements the Newton method.
 
RestrictProlongOperator restrictProlongOperator ()
 return restriction and prolongation operator
 
unsigned markForGridAdaptation ()
 Mark grid cells for refinement or coarsening.
 
template<class Restarter >
void serialize (Restarter &res)
 This method writes the complete state of the problem to the harddisk.
 
template<class Restarter >
void deserialize (Restarter &res)
 This method restores the complete state of the problem from disk.
 
void writeOutput (bool verbose=true)
 Write the relevant secondary variables of the current solution into an VTK output file.
 
VtkMultiWriterdefaultVtkWriter () const
 Method to retrieve the VTK writer which should be used to write the default ouput after each time step to disk.
 

Static Public Member Functions

static void registerParameters ()
 Register all run-time parameters for the problem and the model.
 
- Static Public Member Functions inherited from Opm::FvBaseProblem< TypeTag >
static void registerParameters ()
 Registers all available parameters for the problem and the model.
 
static std::string helpPreamble (int, const char **argv)
 Returns the string that is printed before the list of command line parameters in the help message.
 
static std::string briefDescription ()
 Returns a human readable description of the problem for the help message.
 
static int handlePositionalParameter (std::function< void(const std::string &, const std::string &)>, std::set< std::string > &, std::string &errorMsg, int, const char **argv, int paramIdx, int)
 Handles positional command line parameters.
 

Problem parameters

DimVector gravity_
 
template<class Context >
const DimMatrix & intrinsicPermeability (const Context &, unsigned, unsigned) const
 Returns the intrinsic permeability tensor $[m^2]$ at a given position.
 
template<class Context >
Scalar porosity (const Context &, unsigned, unsigned) const
 Returns the porosity [] of the porous medium for a given control volume.
 
template<class Context >
const SolidEnergyLawParams & solidEnergyParams (const Context &, unsigned, unsigned) const
 Returns the parameter object for the energy storage law of the solid in a sub-control volume.
 
template<class Context >
const ThermalConductionLawParams & thermalConductionParams (const Context &, unsigned, unsigned) const
 Returns the parameter object for the thermal conductivity law in a sub-control volume.
 
template<class Context >
Scalar tortuosity (const Context &, unsigned, unsigned) const
 Define the tortuosity.
 
template<class Context >
Scalar dispersivity (const Context &, unsigned, unsigned) const
 Define the dispersivity.
 
template<class Context >
const MaterialLawParams & materialLawParams (const Context &, unsigned, unsigned) const
 Returns the material law parameters $\mathrm{[K]}$ within a control volume.
 
template<class FluidState >
void updateRelperms (std::array< Evaluation, numPhases > &mobility, DirectionalMobilityPtr &dirMob, FluidState &fluidState, unsigned globalSpaceIdx) const
 
template<class Context >
Scalar temperature (const Context &, unsigned, unsigned) const
 Returns the temperature $\mathrm{[K]}$ within a control volume.
 
Scalar temperature () const
 Returns the temperature $\mathrm{[K]}$ for an isothermal problem.
 
template<class Context >
const DimVector & gravity (const Context &, unsigned, unsigned) const
 Returns the acceleration due to gravity $\mathrm{[m/s^2]}$.
 
const DimVector & gravity () const
 Returns the acceleration due to gravity $\mathrm{[m/s^2]}$.
 
unsigned markForGridAdaptation ()
 Mark grid cells for refinement or coarsening.
 
DimMatrix toDimMatrix_ (Scalar val) const
 Converts a Scalar value to an isotropic Tensor.
 

Additional Inherited Members

- Public Types inherited from Opm::FvBaseProblem< TypeTag >
using RestrictProlongOperator = EmptyRestrictProlong
 
- Protected Attributes inherited from Opm::FvBaseProblem< TypeTag >
Scalar nextTimeStepSize_
 

Detailed Description

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

◆ MultiPhaseBaseProblem()

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

Member Function Documentation

◆ dispersivity()

template<class TypeTag >
template<class Context >
Scalar Opm::MultiPhaseBaseProblem< TypeTag >::dispersivity ( const Context ,
unsigned  ,
unsigned   
) 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.

◆ gravity() [1/2]

template<class TypeTag >
const DimVector & Opm::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 $.

◆ gravity() [2/2]

template<class TypeTag >
template<class Context >
const DimVector & Opm::MultiPhaseBaseProblem< TypeTag >::gravity ( const Context ,
unsigned  ,
unsigned   
) 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.

◆ intersectionIntrinsicPermeability()

template<class TypeTag >
template<class Context >
void Opm::MultiPhaseBaseProblem< TypeTag >::intersectionIntrinsicPermeability ( DimMatrix &  result,
const Context context,
unsigned  intersectionIdx,
unsigned  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).

◆ intrinsicPermeability()

template<class TypeTag >
template<class Context >
const DimMatrix & Opm::MultiPhaseBaseProblem< TypeTag >::intrinsicPermeability ( const Context ,
unsigned  ,
unsigned   
) 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.

◆ markForGridAdaptation()

template<class TypeTag >
unsigned Opm::MultiPhaseBaseProblem< TypeTag >::markForGridAdaptation ( )
inline

Mark grid cells for refinement or coarsening.

Returns
The number of elements marked for refinement or coarsening.

◆ materialLawParams()

template<class TypeTag >
template<class Context >
const MaterialLawParams & Opm::MultiPhaseBaseProblem< TypeTag >::materialLawParams ( const Context ,
unsigned  ,
unsigned   
) 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.

◆ porosity()

template<class TypeTag >
template<class Context >
Scalar Opm::MultiPhaseBaseProblem< TypeTag >::porosity ( const Context ,
unsigned  ,
unsigned   
) 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.

◆ solidEnergyParams()

template<class TypeTag >
template<class Context >
const SolidEnergyLawParams & Opm::MultiPhaseBaseProblem< TypeTag >::solidEnergyParams ( const Context ,
unsigned  ,
unsigned   
) const
inline

Returns the parameter object for the energy storage law of the solid 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.

◆ temperature() [1/2]

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

◆ temperature() [2/2]

template<class TypeTag >
template<class Context >
Scalar Opm::MultiPhaseBaseProblem< TypeTag >::temperature ( const Context ,
unsigned  ,
unsigned   
) 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.

◆ thermalConductionParams()

template<class TypeTag >
template<class Context >
const ThermalConductionLawParams & Opm::MultiPhaseBaseProblem< TypeTag >::thermalConductionParams ( const Context ,
unsigned  ,
unsigned   
) const
inline

Returns the parameter object for the thermal 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.

◆ toDimMatrix_()

template<class TypeTag >
DimMatrix Opm::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);
DimMatrix toDimMatrix_(Scalar val) const
Converts a Scalar value to an isotropic Tensor.
Definition multiphasebaseproblem.hh:380
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:242
Parameters
valThe scalar value which should be expressed as a tensor

◆ tortuosity()

template<class TypeTag >
template<class Context >
Scalar Opm::MultiPhaseBaseProblem< TypeTag >::tortuosity ( const Context ,
unsigned  ,
unsigned   
) 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.

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