Doxygen Class Reference

Public Member Functions

void defaultProblemConstructor (TimeManager &timeManager)
 
void timeIdxParam (int timeIdx)
 
template<class Context >
void contextParams (const Context &context, int spaceIdx, int timeIdx)
 
void problemParam (Problem &problem)
 
void elementParam (Element &element)
 
void vcfvScvIdxParam (int scvIdx)
 
void vcfvScvfIdxParam (int scvfIdx)
 
void sourceParam (RateVector &source)
 
void storageParam (EqVector &storage)
 
void areaFluxParam (RateVector &flux)
 
void residualParam (EqVector &residual)
 
void vcfvElemCtxParam (const ElementContext &elemCtx)
 
void vcfvScvCtxParams (const ElementContext &elemCtx, int scvIdx, int timeIdx)
 
void vcfvScvfCtxParams (const ElementContext &elemCtx, int scvfIdx, int timeIdx)
 
template<class FluidState >
void fluidSystemBaseParams (const FluidState &fluidState, const ParameterCache &paramCache)
 
void phaseIdxParam (int phaseIdx)
 
void compIdxParam (int compIdx)
 
void compIIdxParam (int compIIdx)
 
void compJIdxParam (int compJIdx)
 
void temperatureParam (Scalar temperature)
 
void TpParams (Scalar temperature, Scalar pressure)
 
template<class TypeTag >
void typeTagTParam ()
 

Member Function Documentation

◆ areaFluxParam()

void Doxygen::areaFluxParam ( RateVector &  flux)
Parameters
fluxArea-specific flux over the phase.

◆ compIdxParam()

void Doxygen::compIdxParam ( int  compIdx)
Parameters
compIdxThe index of the (pseudo-)component of interest.

◆ compIIdxParam()

void Doxygen::compIIdxParam ( int  compIIdx)
Parameters
compIIdxThe index of the first (pseudo-)component of interest.

◆ compJIdxParam()

void Doxygen::compJIdxParam ( int  compJIdx)
Parameters
compJIdxThe index of the second (pseudo-)component of interest.

◆ contextParams()

template<class Context >
void Doxygen::contextParams ( const Context &  context,
int  spaceIdx,
int  timeIdx 
)
Template Parameters
ContextThe type of the execution context.
Parameters
contextThe execution context.
spaceIdxThe local index used by the space discretization.
timeIdxThe index used by the time discretization.

◆ defaultProblemConstructor()

void Doxygen::defaultProblemConstructor ( TimeManager &  timeManager)

◆ elementParam()

void Doxygen::elementParam ( Element &  element)
Parameters
elementThe DUNE element (i.e. the codim-0 entity) of interest.

◆ fluidSystemBaseParams()

template<class FluidState >
void Doxygen::fluidSystemBaseParams ( const FluidState &  fluidState,
const ParameterCache &  paramCache 
)
Template Parameters
FluidStateThe type of the fluid state.
Parameters
fluidStateThe object expressing the termodynamic state of the system.
paramCacheThe fluid system's parameter cache

◆ phaseIdxParam()

void Doxygen::phaseIdxParam ( int  phaseIdx)
Parameters
phaseIdxThe index of the fluid phase of interest.

◆ problemParam()

void Doxygen::problemParam ( Problem &  problem)
Parameters
problemThe physical problem which ought to be solved.

◆ residualParam()

void Doxygen::residualParam ( EqVector &  residual)
Parameters
residualStores the residual of each conserved quantity.

◆ sourceParam()

void Doxygen::sourceParam ( RateVector &  source)
Parameters
sourceThe values of the source term.

◆ storageParam()

void Doxygen::storageParam ( EqVector &  storage)
Parameters
storageStores the total amount of each conserved quantity inside the domain.

◆ temperatureParam()

void Doxygen::temperatureParam ( Scalar  temperature)
Parameters
temperatureThe temperature of interest [K]

◆ timeIdxParam()

void Doxygen::timeIdxParam ( int  timeIdx)
Parameters
timeIdxThe index used by the time discretization.

◆ TpParams()

void Doxygen::TpParams ( Scalar  temperature,
Scalar  pressure 
)
Parameters
temperatureThe temperature of interest [K]
pressureThe pressure of interest [Pa]

◆ typeTagTParam()

template<class TypeTag >
void Doxygen::typeTagTParam ( )
Template Parameters
TypeTagThe type tag on which all required properties are defined.

◆ vcfvElemCtxParam()

void Doxygen::vcfvElemCtxParam ( const ElementContext &  elemCtx)
Parameters
elemCtxThe element execution context of the vcfv scheme.

◆ vcfvScvCtxParams()

void Doxygen::vcfvScvCtxParams ( const ElementContext &  elemCtx,
int  scvIdx,
int  timeIdx 
)
Parameters
scvIdxThe local sub-control volume index of interest (equivalent to the local vertex index of the element).
elemCtxThe element execution context of the vcfv scheme.
timeIdxThe index used by the time discretization.

◆ vcfvScvfCtxParams()

void Doxygen::vcfvScvfCtxParams ( const ElementContext &  elemCtx,
int  scvfIdx,
int  timeIdx 
)
Parameters
elemCtxThe element execution context of the vcfv scheme.
scvfIdxThe local sub-control volume face index of interest (equivalent to the local edge index of the element).
timeIdxThe index used by the time discretization.

◆ vcfvScvfIdxParam()

void Doxygen::vcfvScvfIdxParam ( int  scvfIdx)
Parameters
scvfIdxThe local sub-control volume face index of interest (equivalent to the local edge index of the element).

◆ vcfvScvIdxParam()

void Doxygen::vcfvScvIdxParam ( int  scvIdx)
Parameters
scvIdxThe local sub-control volume index of interest (equivalent to the local vertex index of the element).

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