Opm::FIBlackOilModel< TypeTag > Class Template Reference

#include <FIBlackoilModel.hpp>

Inheritance diagram for Opm::FIBlackOilModel< TypeTag >:

Public Types
using	Indices = GetPropType< TypeTag, Properties::Indices >
using	FluidSystem = GetPropType< TypeTag, Properties::FluidSystem >
using	PrimaryVariables = GetPropType< TypeTag, Properties::PrimaryVariables >
using	LocalResidual = GetPropType< TypeTag, Properties::LocalResidual >

Public Member Functions
	FIBlackOilModel (Simulator &simulator)
void	invalidateAndUpdateIntensiveQuantities (unsigned timeIdx) const
void	invalidateAndUpdateIntensiveQuantitiesOverlap (unsigned timeIdx) const
template<class GridSubDomain >
void	invalidateAndUpdateIntensiveQuantities (unsigned timeIdx, const GridSubDomain &gridSubDomain) const
void	updateFailed ()
	Called by the update() method if it was unsuccessful. This is primary a hook which the actual model can overload. More...
const IntensiveQuantities &	intensiveQuantities (unsigned globalIdx, unsigned timeIdx) const
std::string	primaryVarName (int pvIdx) const
	Given an primary variable index, return a human readable name. More...
std::string	eqName (int eqIdx) const
	Given an equation index, return a human readable name. More...
Scalar	primaryVarWeight (unsigned globalDofIdx, unsigned pvIdx) const
	Returns the relative weight of a primary variable for calculating relative errors. More...
Scalar	eqWeight (unsigned globalDofIdx, unsigned eqIdx) const
	Returns the relative weight of an equation. More...
void	setEqWeight (unsigned eqIdx, Scalar value)
template<class DofEntity >
void	serializeEntity (std::ostream &outstream, const DofEntity &dof)
	Write the current solution for a degree of freedom to a restart file. More...
template<class DofEntity >
void	deserializeEntity (std::istream &instream, const DofEntity &dof)
	Reads the current solution variables for a degree of freedom from a restart file. More...
template<class Restarter >
void	deserialize (Restarter &res)
	Deserializes the state of the model. More...
template<class Context >
void	supplementInitialSolution_ (PrimaryVariables &priVars, const Context &context, unsigned dofIdx, unsigned timeIdx)
void	registerOutputModules_ ()
bool	phaseIsConsidered (unsigned) const
	Returns true iff a fluid phase is used by the model. More...
void	globalPhaseStorage (EqVector &storage, unsigned phaseIdx)
	Compute the total storage inside one phase of all conservation quantities. More...

Static Public Member Functions
static void	registerParameters ()
	Register all run-time parameters for the immiscible model. More...
static std::string	name ()

Member Typedef Documentation

FluidSystem

template<class TypeTag >

using Opm::BlackOilModel< TypeTag >::FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>

inherited

Indices

template<class TypeTag >

using Opm::BlackOilModel< TypeTag >::Indices = GetPropType<TypeTag, Properties::Indices>

inherited

LocalResidual

template<class TypeTag >

using Opm::BlackOilModel< TypeTag >::LocalResidual = GetPropType<TypeTag, Properties::LocalResidual>

inherited

PrimaryVariables

template<class TypeTag >

using Opm::BlackOilModel< TypeTag >::PrimaryVariables = GetPropType<TypeTag, Properties::PrimaryVariables>

inherited

Constructor & Destructor Documentation

FIBlackOilModel()

template<typename TypeTag >

Opm::FIBlackOilModel< TypeTag >::FIBlackOilModel ( Simulator &  simulator )

inline

Member Function Documentation

deserialize()

template<class TypeTag >

template<class Restarter >

void Opm::BlackOilModel< TypeTag >::deserialize ( Restarter &  res )

inlineinherited

Deserializes the state of the model.

Template Parameters

Restarter

The type of the serializer class

Parameters

res	The serializer object

deserializeEntity()

template<class TypeTag >

template<class DofEntity >

void Opm::BlackOilModel< TypeTag >::deserializeEntity ( std::istream &  instream, const DofEntity &  dof  )

inlineinherited

Reads the current solution variables for a degree of freedom from a restart file.

Parameters

instream	The stream from which the vertex data should be deserialized from
dof	The Dune entity which's data should be deserialized

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::deserializeEntity(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::deserializeEntity(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::deserializeEntity(), Opm::BlackOilSolventModule< TypeTag, enableSolventV >::deserializeEntity(), and Opm::to_string().

eqName()

template<class TypeTag >

std::string Opm::BlackOilModel< TypeTag >::eqName ( int  eqIdx ) const

inlineinherited

Given an equation index, return a human readable name.

Parameters

eqIdx

The index of the conservation equation of interest.

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqApplies(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::eqApplies(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqApplies(), Opm::BlackOilSolventModule< TypeTag, enableSolventV >::eqApplies(), Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::eqName(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::eqName(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::eqName(), and Opm::BlackOilSolventModule< TypeTag, enableSolventV >::eqName().

eqWeight()

template<class TypeTag >

Scalar Opm::BlackOilModel< TypeTag >::eqWeight ( unsigned  globalDofIdx, unsigned  eqIdx  ) const

inlineinherited

Returns the relative weight of an equation.

Parameters

globalVertexIdx	The global index of the vertex
eqIdx	The index of the equation

globalPhaseStorage()

template<class TypeTag >

void Opm::MultiPhaseBaseModel< TypeTag >::globalPhaseStorage ( EqVector &  storage, unsigned  phaseIdx  )

inlineinherited

Compute the total storage inside one phase of all conservation quantities.

References Opm::ThreadedEntityIterator< GridView, codim >::beginParallel(), Opm::ThreadedEntityIterator< GridView, codim >::increment(), Opm::ThreadedEntityIterator< GridView, codim >::isFinished(), and Opm::ThreadManager::threadId().

intensiveQuantities()

template<typename TypeTag >

const IntensiveQuantities & Opm::FIBlackOilModel< TypeTag >::intensiveQuantities ( unsigned  globalIdx, unsigned  timeIdx  ) const

inline

invalidateAndUpdateIntensiveQuantities() [1/2]

template<typename TypeTag >

void Opm::FIBlackOilModel< TypeTag >::invalidateAndUpdateIntensiveQuantities ( unsigned  timeIdx ) const

inline

References Opm::ThreadedEntityIterator< GridView, codim >::beginParallel(), Opm::ThreadedEntityIterator< GridView, codim >::increment(), Opm::ThreadedEntityIterator< GridView, codim >::isFinished(), OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH.

Referenced by Opm::FIBlackOilModel< TypeTag >::updateFailed().

invalidateAndUpdateIntensiveQuantities() [2/2]

template<typename TypeTag >

template<class GridSubDomain >

void Opm::FIBlackOilModel< TypeTag >::invalidateAndUpdateIntensiveQuantities ( unsigned  timeIdx, const GridSubDomain &  gridSubDomain  ) const

inline

References Opm::ThreadedEntityIterator< GridView, codim >::beginParallel(), Opm::ThreadedEntityIterator< GridView, codim >::increment(), and Opm::ThreadedEntityIterator< GridView, codim >::isFinished().

invalidateAndUpdateIntensiveQuantitiesOverlap()

template<typename TypeTag >

void Opm::FIBlackOilModel< TypeTag >::invalidateAndUpdateIntensiveQuantitiesOverlap ( unsigned  timeIdx ) const

inline

References Opm::ThreadedEntityIterator< GridView, codim >::beginParallel(), Opm::ThreadedEntityIterator< GridView, codim >::increment(), Opm::ThreadedEntityIterator< GridView, codim >::isFinished(), OPM_BEGIN_PARALLEL_TRY_CATCH, and OPM_END_PARALLEL_TRY_CATCH.

name()

template<class TypeTag >

static std::string Opm::BlackOilModel< TypeTag >::name ( )

inlinestaticinherited

phaseIsConsidered()

template<class TypeTag >

bool Opm::MultiPhaseBaseModel< TypeTag >::phaseIsConsidered ( unsigned  ) const

inlineinherited

Returns true iff a fluid phase is used by the model.

Parameters

phaseIdx

The index of the fluid phase in question

primaryVarName()

template<class TypeTag >

std::string Opm::BlackOilModel< TypeTag >::primaryVarName ( int  pvIdx ) const

inlineinherited

Given an primary variable index, return a human readable name.

Parameters

pvIdx

The index of the primary variable of interest.

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarApplies(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::primaryVarApplies(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarApplies(), Opm::BlackOilSolventModule< TypeTag, enableSolventV >::primaryVarApplies(), Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarName(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::primaryVarName(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarName(), and Opm::BlackOilSolventModule< TypeTag, enableSolventV >::primaryVarName().

primaryVarWeight()

template<class TypeTag >

Scalar Opm::BlackOilModel< TypeTag >::primaryVarWeight ( unsigned  globalDofIdx, unsigned  pvIdx  ) const

inlineinherited

Returns the relative weight of a primary variable for calculating relative errors.

Parameters

globalDofIdx	The global index of the degree of freedom
pvIdx	The index of the primary variable

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarApplies(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::primaryVarApplies(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarApplies(), Opm::BlackOilSolventModule< TypeTag, enableSolventV >::primaryVarApplies(), Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::primaryVarWeight(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::primaryVarWeight(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::primaryVarWeight(), and Opm::BlackOilSolventModule< TypeTag, enableSolventV >::primaryVarWeight().

registerOutputModules_()

template<class TypeTag >

void Opm::BlackOilModel< TypeTag >::registerOutputModules_ ( )

inlineinherited

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::registerOutputModules(), Opm::BlackOilMICPModule< TypeTag, enableMICPV >::registerOutputModules(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::registerOutputModules(), Opm::BlackOilSolventModule< TypeTag, enableSolventV >::registerOutputModules(), and Opm::MultiPhaseBaseModel< TypeTag >::registerOutputModules_().

registerParameters()

template<class TypeTag >

static void Opm::BlackOilModel< TypeTag >::registerParameters ( )

inlinestaticinherited

Register all run-time parameters for the immiscible model.

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::registerParameters(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::registerParameters(), Opm::BlackOilMICPModule< TypeTag, enableMICPV >::registerParameters(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::registerParameters(), Opm::BlackOilSolventModule< TypeTag, enableSolventV >::registerParameters(), Opm::MultiPhaseBaseModel< TypeTag >::registerParameters(), Opm::VtkBlackOilModule< TypeTag >::registerParameters(), Opm::VtkCompositionModule< TypeTag >::registerParameters(), and Opm::VtkDiffusionModule< TypeTag >::registerParameters().

serializeEntity()

template<class TypeTag >

template<class DofEntity >

void Opm::BlackOilModel< TypeTag >::serializeEntity ( std::ostream &  outstream, const DofEntity &  dof  )

inlineinherited

Write the current solution for a degree of freedom to a restart file.

Parameters

outstream	The stream into which the vertex data should be serialized to
dof	The Dune entity which's data should be serialized

References Opm::BlackOilEnergyModule< TypeTag, enableEnergyV >::serializeEntity(), Opm::BlackOilExtboModule< TypeTag, enableExtboV >::serializeEntity(), Opm::BlackOilPolymerModule< TypeTag, enablePolymerV >::serializeEntity(), Opm::BlackOilSolventModule< TypeTag, enableSolventV >::serializeEntity(), and Opm::to_string().

setEqWeight()

template<class TypeTag >

void Opm::BlackOilModel< TypeTag >::setEqWeight ( unsigned  eqIdx, Scalar  value  )

inlineinherited

supplementInitialSolution_()

template<class TypeTag >

template<class Context >

void Opm::BlackOilModel< TypeTag >::supplementInitialSolution_ ( PrimaryVariables &  priVars, const Context &  context, unsigned  dofIdx, unsigned  timeIdx  )

inlineinherited

updateFailed()

template<typename TypeTag >

void Opm::FIBlackOilModel< TypeTag >::updateFailed ( )

inline

Called by the update() method if it was unsuccessful. This is primary a hook which the actual model can overload.

References Opm::FIBlackOilModel< TypeTag >::invalidateAndUpdateIntensiveQuantities().

---

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

• FIBlackoilModel.hpp