Flux

Everything flux related in DuMu^x More...

Description

Everything flux related in DuMu^x

Modules
	Flux related to the Box scheme
	Flux related to the box scheme.
	Flux related to the cell-centered schemes
	Flux related to the cell-centered schemes.
	Flux related to the cell-centered two-point flux approximation schemes
	Flux related to the cell-centered two-point flux approximation schemes.
	Flux related to the cell-centered multi-point flux approximation schemes
	Flux related to the cell-centered multi-point flux approximation schemes.
	Flux related to the staggered scheme
	Flux related to the staggered scheme.
	Flux related to the shallow water model
	Flux related to the shallow water model.

Files
file	flux/darcyslaw.hh
	Darcy's law specialized for different discretization schemes This file contains the data which is required to calculate volume and mass fluxes of fluid phases over a face of a finite volume by means of the Darcy approximation. Specializations are provided for the different discretization methods.
file	effectivestresslaw.hh
	The effective stress law specialized for different discretization schemes. This computes the stress tensor and surface forces resulting from poro-mechanical deformation.
file	fickslaw.hh
	Fick's law specilized for different discretization schemes. This file contains the data which is required to calculate diffusive mass fluxes due to molecular diffusion with Fick's law.
file	fluxvariablesbase.hh
	Base class for the flux variables living on a sub control volume face.
file	fluxvariablescaching.hh
	Classes related to flux variables caching.
file	forchheimerslaw.hh
	Forchheimer's law specialized for different discretization schemes This file contains the data which is required to calculate volume and mass fluxes of fluid phases over a face of a finite volume by means of the Forchheimer approximation. Specializations are provided for the different discretization methods.
file	fourierslaw.hh
	Fourier's law specialized for different discretization schemes This file contains the data which is required to calculate diffusive mass fluxes due to molecular diffusion with Fourier's law.
file	fourierslawnonequilibrium.hh
	This file contains the data which is required to calculate diffusive mass fluxes due to molecular diffusion with Fourier's law.
file	hookeslaw.hh
	Hooke's law specialized for different discretization schemes. This computes the stress tensor and surface forces resulting from mechanical deformation.
file	maxwellstefanslaw.hh
	This file contains the data which is required to calculate diffusive mass fluxes due to molecular diffusion with Fick's law.
file	referencesystemformulation.hh
	The reference frameworks and formulations available for splitting total fluxes into a advective and diffusive part.
file	shallowwaterflux.hh
file	stationaryvelocityfield.hh
	Constant velocity advective law for transport models. This file contains the data which is required to calculate volume and mass fluxes of fluid phases over a face of a finite volume. A stationary velocity field is given by the user for use in tracer models.
file	flux/upwindscheme.hh
	Base class for the upwind scheme.

Classes
class	Dumux::EffectiveStressLaw< StressType, GridGeometry, dm >
	This computes the stress tensor and surface forces resulting from poro-mechanical deformation. More...
class	Dumux::FluxVariablesBase< Problem, FVElementGeometry, ElementVolumeVariables, ElementFluxVariablesCache >
	Base class for the flux variables living on a sub control volume face. More...
class	Dumux::HookesLaw< Scalar, GridGeometry, dm >
	This computes the stress tensor and surface forces resulting from mechanical deformation. More...
class	Dumux::ShallowWaterFlux< NumEqVector >
	Computes the shallow water flux by solving a riemann problem. More...
class	Dumux::StationaryVelocityField< Scalar >
	Evaluates a user given velocity field. More...

Typedefs
template<class TypeTag >
using	Dumux::DarcysLaw = DarcysLawImplementation< TypeTag, GetPropType< TypeTag, Properties::GridGeometry >::discMethod >
	Evaluates the normal component of the Darcy velocity on a (sub)control volume face. More...
template<class TypeTag , ReferenceSystemFormulation referenceSystem = ReferenceSystemFormulation::massAveraged>
using	Dumux::FicksLaw = FicksLawImplementation< TypeTag, GetPropType< TypeTag, Properties::GridGeometry >::discMethod, referenceSystem >
	Evaluates the diffusive mass flux according to Fick's law. More...
template<class TypeTag >
using	Dumux::ForchheimersLaw = ForchheimersLawImplementation< TypeTag, GetPropType< TypeTag, Properties::GridGeometry >::discMethod >
	Evaluates the normal component of the Forchheimer velocity on a (sub)control volume face. More...
template<class TypeTag >
using	Dumux::FouriersLaw = FouriersLawImplementation< TypeTag, GetPropType< TypeTag, Properties::GridGeometry >::discMethod >
	Evaluates the heat conduction flux according to Fouriers's law. More...
template<class TypeTag >
using	Dumux::FouriersLawNonEquilibrium = FouriersLawNonEquilibriumImplementation< TypeTag, GetPropType< TypeTag, Properties::GridGeometry >::discMethod >
	Evaluates the heat conduction flux according to Fouriers's law. More...
template<class TypeTag , ReferenceSystemFormulation referenceSystem = ReferenceSystemFormulation::massAveraged>
using	Dumux::MaxwellStefansLaw = MaxwellStefansLawImplementation< TypeTag, GetPropType< TypeTag, Properties::GridGeometry >::discMethod, referenceSystem >
	Evaluates the diffusive mass flux according to Maxwell Stafan's law. More...
template<class GridGeometry >
using	Dumux::UpwindScheme = UpwindSchemeImpl< GridGeometry, GridGeometry::discMethod >
	The upwind scheme used for the advective fluxes. This depends on the chosen discretization method. More...

Enumerations
enum class	Dumux::ReferenceSystemFormulation { Dumux::ReferenceSystemFormulation::massAveraged , Dumux::ReferenceSystemFormulation::molarAveraged }
	The formulations available for Fick's law related to the reference system. More...

Functions
template<class VolumeVariables >
VolumeVariables::PrimaryVariables::value_type	Dumux::massOrMolarDensity (const VolumeVariables &volVars, ReferenceSystemFormulation referenceSys, const int phaseIdx)
	evaluates the density to be used in Fick's law based on the reference system More...
template<class VolumeVariables >
VolumeVariables::PrimaryVariables::value_type	Dumux::massOrMoleFraction (const VolumeVariables &volVars, ReferenceSystemFormulation referenceSys, const int phaseIdx, const int compIdx)
	returns the mass or mole fraction to be used in Fick's law based on the reference system More...
template<class Problem , class FVElementGeometry , class ElementVolumeVariables >
static NumEqVector	Dumux::ShallowWaterFlux< NumEqVector >::flux (const Problem &problem, const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const typename FVElementGeometry::SubControlVolumeFace &scvf)
	Prepares the riemann problem for the advective flux for the shallow water model. The actual model uses an exact Riemann solver after Torro and the reconstruction after Audusse and a flux limiter for small water depths. More...

Typedef Documentation

DarcysLaw

template<class TypeTag >

using Dumux::DarcysLaw = typedef DarcysLawImplementation<TypeTag, GetPropType<TypeTag, Properties::GridGeometry>::discMethod>

Evaluates the normal component of the Darcy velocity on a (sub)control volume face.

Note

Specializations are provided for the different discretization methods. These specializations are found in the headers included below.

FicksLaw

template<class TypeTag , ReferenceSystemFormulation referenceSystem = ReferenceSystemFormulation::massAveraged>

using Dumux::FicksLaw = typedef FicksLawImplementation<TypeTag, GetPropType<TypeTag, Properties::GridGeometry>::discMethod, referenceSystem>

Evaluates the diffusive mass flux according to Fick's law.

ForchheimersLaw

template<class TypeTag >

using Dumux::ForchheimersLaw = typedef ForchheimersLawImplementation<TypeTag, GetPropType<TypeTag, Properties::GridGeometry>::discMethod>

Evaluates the normal component of the Forchheimer velocity on a (sub)control volume face.

Note

Specializations are provided for the different discretization methods. These specializations are found in the headers included below.

FouriersLaw

template<class TypeTag >

using Dumux::FouriersLaw = typedef FouriersLawImplementation<TypeTag, GetPropType<TypeTag, Properties::GridGeometry>::discMethod>

Evaluates the heat conduction flux according to Fouriers's law.

FouriersLawNonEquilibrium

template<class TypeTag >

using Dumux::FouriersLawNonEquilibrium = typedef FouriersLawNonEquilibriumImplementation<TypeTag, GetPropType<TypeTag, Properties::GridGeometry>::discMethod>

Evaluates the heat conduction flux according to Fouriers's law.

MaxwellStefansLaw

template<class TypeTag , ReferenceSystemFormulation referenceSystem = ReferenceSystemFormulation::massAveraged>

using Dumux::MaxwellStefansLaw = typedef MaxwellStefansLawImplementation<TypeTag, GetPropType<TypeTag, Properties::GridGeometry>::discMethod, referenceSystem>

Evaluates the diffusive mass flux according to Maxwell Stafan's law.

UpwindScheme

template<class GridGeometry >

using Dumux::UpwindScheme = typedef UpwindSchemeImpl<GridGeometry, GridGeometry::discMethod>

The upwind scheme used for the advective fluxes. This depends on the chosen discretization method.

Enumeration Type Documentation

ReferenceSystemFormulation

enum class Dumux::ReferenceSystemFormulation

strong

The formulations available for Fick's law related to the reference system.

Note

The total flux of a component can be split into an advective and a diffusive part. In our framework, the advective part is based on a momentum balance. Standard momentum balances, e.g., the Navier-Stokes equations or Darcy's law yield mass-averaged velocities (see Multicomponent Mass Transfer, Taylor & Krishna, 1993 [70]), therefore we use the appropriate formulation of Fick's law (mass averaged formulation) per default.

This means that the diffusive fluxes are calculated with the mass fraction gradients and the unit of the fluxes is kg/s. It is also possible to use a molar-averaged reference system, which can be beneficial, e.g., when it is known that the molar-averaged advective velocity would be zero. When using a molar-averaged reference velocity, Fick's law is formulated with mole fraction gradients and the unit of the flux is moles/s. This means that depending on the reference system, the units of the fluxes need to be adapted to be used in mass or mole balances.

Enumerator
massAveraged
molarAveraged

Function Documentation

flux()

template<class NumEqVector >

template<class Problem , class FVElementGeometry , class ElementVolumeVariables >

static NumEqVector Dumux::ShallowWaterFlux< NumEqVector >::flux ( const Problem &  problem, const typename FVElementGeometry::GridGeometry::GridView::template Codim< 0 >::Entity &  element, const FVElementGeometry &  fvGeometry, const ElementVolumeVariables &  elemVolVars, const typename FVElementGeometry::SubControlVolumeFace &  scvf  )

inlinestatic

Prepares the riemann problem for the advective flux for the shallow water model. The actual model uses an exact Riemann solver after Torro and the reconstruction after Audusse and a flux limiter for small water depths.

Todo:

The choice of the Riemann solver should be more flexible

massOrMolarDensity()

template<class VolumeVariables >

VolumeVariables::PrimaryVariables::value_type Dumux::massOrMolarDensity	(	const VolumeVariables &	volVars,
		ReferenceSystemFormulation	referenceSys,
		const int	phaseIdx
	)

evaluates the density to be used in Fick's law based on the reference system

massOrMoleFraction()

template<class VolumeVariables >

VolumeVariables::PrimaryVariables::value_type Dumux::massOrMoleFraction	(	const VolumeVariables &	volVars,
		ReferenceSystemFormulation	referenceSys,
		const int	phaseIdx,
		const int	compIdx
	)

returns the mass or mole fraction to be used in Fick's law based on the reference system