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

void Doxygen::areaFluxParam

(

RateVector &

flux

)

Parameters

flux	Area-specific flux over the phase.

void Doxygen::compIdxParam

(

int

compIdx

)

Parameters

compIdx

The index of the (pseudo-)component of interest.

void Doxygen::compIIdxParam

(

int

compIIdx

)

Parameters

compIIdx

The index of the first (pseudo-)component of interest.

void Doxygen::compJIdxParam

(

int

compJIdx

)

Parameters

compJIdx

The index of the second (pseudo-)component of interest.

template<class Context >

void Doxygen::contextParams	(	const Context &	context,
		int	spaceIdx,
		int	timeIdx
	)

Template Parameters

Context

The type of the execution context.

Parameters

context	The execution context.
spaceIdx	The local index used by the space discretization.
timeIdx	The index used by the time discretization.

void Doxygen::defaultProblemConstructor

(

TimeManager &

timeManager

)

void Doxygen::elementParam

(

Element &

element

)

Parameters

element

The DUNE element (i.e. the codim-0 entity) of interest.

template<class FluidState >

void Doxygen::fluidSystemBaseParams	(	const FluidState &	fluidState,
		const ParameterCache &	paramCache
	)

Template Parameters

FluidState

The type of the fluid state.

Parameters

fluidState	The object expressing the termodynamic state of the system.
paramCache	The fluid system's parameter cache

void Doxygen::phaseIdxParam

(

int

phaseIdx

)

Parameters

phaseIdx

The index of the fluid phase of interest.

void Doxygen::problemParam

(

Problem &

problem

)

Parameters

problem

The physical problem which ought to be solved.

void Doxygen::residualParam

(

EqVector &

residual

)

Parameters

residual

Stores the residual of each conserved quantity.

void Doxygen::sourceParam

(

RateVector &

source

)

Parameters

source

The values of the source term.

void Doxygen::storageParam

(

EqVector &

storage

)

Parameters

storage

Stores the total amount of each conserved quantity inside the domain.

void Doxygen::temperatureParam

(

Scalar

temperature

)

Parameters

temperature

The temperature of interest [K]

void Doxygen::timeIdxParam

(

int

timeIdx

)

Parameters

timeIdx

The index used by the time discretization.

void Doxygen::TpParams	(	Scalar	temperature,
		Scalar	pressure
	)

Parameters

temperature	The temperature of interest [K]
pressure	The pressure of interest [Pa]

template<class TypeTag >

void Doxygen::typeTagTParam

(

)

Template Parameters

TypeTag

The type tag on which all required properties are defined.

void Doxygen::vcfvElemCtxParam

(

const ElementContext &

elemCtx

)

Parameters

elemCtx

The element execution context of the vcfv scheme.

void Doxygen::vcfvScvCtxParams	(	const ElementContext &	elemCtx,
		int	scvIdx,
		int	timeIdx
	)

Parameters

scvIdx	The local sub-control volume index of interest (equivalent to the local vertex index of the element).
elemCtx	The element execution context of the vcfv scheme.
timeIdx	The index used by the time discretization.

void Doxygen::vcfvScvfCtxParams	(	const ElementContext &	elemCtx,
		int	scvfIdx,
		int	timeIdx
	)

Parameters

elemCtx	The element execution context of the vcfv scheme.
scvfIdx	The local sub-control volume face index of interest (equivalent to the local edge index of the element).
timeIdx	The index used by the time discretization.

void Doxygen::vcfvScvfIdxParam

(

int

scvfIdx

)

Parameters

scvfIdx

The local sub-control volume face index of interest (equivalent to the local edge index of the element).

void Doxygen::vcfvScvIdxParam

(

int

scvIdx

)

Parameters

scvIdx

The 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:

• templates.dox