3.4
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Classes | Public Types | Public Member Functions | List of all members
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. More...
 
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. More...
 
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. More...
 

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
elementThe element
considerScvA lambda function to decide whether to consider a scv or not
verboseIf 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
labelsA list of pore labels which will be considered for the flux calculation
verboseIf 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
minMaxConsider bBoxMin or bBoxMax by setting "min" or "max"
coordx, y or z coordinate at which bBoxMin or bBoxMax is evaluated
verboseIf set true, the fluxes at all individual SCVs are printed

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