Dumux::PoreNetwork::BoundaryFlux< GridVariables, LocalResidual, SolutionVector > Class Template Reference

Class for the calculation of fluxes at the boundary of pore-network models. More...

#include <dumux/porenetwork/common/boundaryflux.hh>

Description

template<class GridVariables, class LocalResidual, class SolutionVector>
class Dumux::PoreNetwork::BoundaryFlux< GridVariables, LocalResidual, SolutionVector >

Class for the calculation of fluxes at the boundary of pore-network models.

Public Types
using	Scalar = typename GridVariables::Scalar

Public Member Functions
	BoundaryFlux (const GridVariables &gridVariables, const LocalResidual &localResidual, const SolutionVector &sol)
template<class Label>
Result	getFlux (const std::vector< Label > &labels, const bool verbose=false) const
	Returns the cumulative flux in \(\mathrm{[\frac{kg}{s}]}\), \(\mathrm{[\frac{mole}{s}]}\) or \(\mathrm{[\frac{J}{s}]}\) of several pore throats for a given list of pore labels to consider.
Result	getFlux (std::string_view minMax, const int coord, const bool verbose=false) const
	Returns the cumulative flux in \(\mathrm{[\frac{kg}{s}]}\), \(\mathrm{[\frac{mole}{s}]}\) or \(\mathrm{[\frac{J}{s}]}\) of several pore throats at a given location on the boundary.
template<class RestrictingFunction>
NumEqVector	getFlux (const Element &element, RestrictingFunction considerScv, const bool verbose=false) const
	Returns the cumulative flux in \(\mathrm{[\frac{kg}{s}]}\), \(\mathrm{[\frac{mole}{s}]}\) or \(\mathrm{[\frac{J}{s}]}\) of several pore throats at a given location on the boundary.

Member Typedef Documentation

Scalar

template<class GridVariables, class LocalResidual, class SolutionVector>

using Dumux::PoreNetwork::BoundaryFlux< GridVariables, LocalResidual, SolutionVector >::Scalar = typename GridVariables::Scalar

Constructor & Destructor Documentation

BoundaryFlux()

template<class GridVariables, class LocalResidual, class SolutionVector>

Dumux::PoreNetwork::BoundaryFlux< GridVariables, LocalResidual, SolutionVector >::BoundaryFlux ( const GridVariables & gridVariables, const LocalResidual & localResidual, const SolutionVector & sol )

inline

Member Function Documentation

getFlux() [1/3]

template<class GridVariables, class LocalResidual, class SolutionVector>

template<class RestrictingFunction>

NumEqVector Dumux::PoreNetwork::BoundaryFlux< GridVariables, LocalResidual, SolutionVector >::getFlux ( const Element & element, RestrictingFunction considerScv, const bool verbose = false ) const

inline

Returns the cumulative flux in \(\mathrm{[\frac{kg}{s}]}\), \(\mathrm{[\frac{mole}{s}]}\) or \(\mathrm{[\frac{J}{s}]}\) of several pore throats at a given location on the boundary.

Parameters

element	The element
considerScv	A lambda function to decide whether to consider a scv or not
verbose	If set true, the fluxes at all individual SCVs are printed

getFlux() [2/3]

template<class GridVariables, class LocalResidual, class SolutionVector>

template<class Label>

Result Dumux::PoreNetwork::BoundaryFlux< GridVariables, LocalResidual, SolutionVector >::getFlux ( const std::vector< Label > & labels, const bool verbose = false ) const

inline

Returns the cumulative flux in \(\mathrm{[\frac{kg}{s}]}\), \(\mathrm{[\frac{mole}{s}]}\) or \(\mathrm{[\frac{J}{s}]}\) of several pore throats for a given list of pore labels to consider.

Parameters

labels	A list of pore labels which will be considered for the flux calculation
verbose	If set true, the fluxes at all individual SCVs are printed

getFlux() [3/3]

template<class GridVariables, class LocalResidual, class SolutionVector>

Result Dumux::PoreNetwork::BoundaryFlux< GridVariables, LocalResidual, SolutionVector >::getFlux ( std::string_view minMax, const int coord, const bool verbose = false ) const

inline

Returns the cumulative flux in \(\mathrm{[\frac{kg}{s}]}\), \(\mathrm{[\frac{mole}{s}]}\) or \(\mathrm{[\frac{J}{s}]}\) of several pore throats at a given location on the boundary.

Parameters

minMax	Consider bBoxMin or bBoxMax by setting "min" or "max"
coord	x, y or z coordinate at which bBoxMin or bBoxMax is evaluated
verbose	If set true, the fluxes at all individual SCVs are printed

---

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

• boundaryflux.hh