Dumux::PoreNetwork::ParametersForGeneratedGrid< Grid, Scalar > Class Template Reference

Helper class to assign parameters to a generated grid. More...

#include <dumux/io/grid/porenetwork/parametersforgeneratedgrid.hh>

Description

template<class Grid, class Scalar>
class Dumux::PoreNetwork::ParametersForGeneratedGrid< Grid, Scalar >

Helper class to assign parameters to a generated grid.

Public Member Functions
	ParametersForGeneratedGrid (const GridView &gridView, const std::string &paramGroup)
int	boundaryFaceMarkerAtPos (const GlobalPosition &pos) const
	Returns the boundary face marker index at given position.
int	throatLabel (const std::array< int, 2 > &poreLabels) const
	Computes and returns the label of a given throat.
template<class SetParameter, class GetParameter>
void	assignParameters (const SetParameter &setParameter, const GetParameter &getParameter, const std::size_t numSubregions)
	Assign parameters for generically created grids.

Constructor & Destructor Documentation

ParametersForGeneratedGrid()

template<class Grid, class Scalar>

Dumux::PoreNetwork::ParametersForGeneratedGrid< Grid, Scalar >::ParametersForGeneratedGrid ( const GridView & gridView, const std::string & paramGroup )

inline

Member Function Documentation

assignParameters()

template<class Grid, class Scalar>

template<class SetParameter, class GetParameter>

void Dumux::PoreNetwork::ParametersForGeneratedGrid< Grid, Scalar >::assignParameters ( const SetParameter & setParameter, const GetParameter & getParameter, const std::size_t numSubregions )

inline

Assign parameters for generically created grids.

boundaryFaceMarkerAtPos()

template<class Grid, class Scalar>

int Dumux::PoreNetwork::ParametersForGeneratedGrid< Grid, Scalar >::boundaryFaceMarkerAtPos ( const GlobalPosition & pos ) const

inline

Returns the boundary face marker index at given position.

Parameters

pos	The current position

throatLabel()

template<class Grid, class Scalar>

int Dumux::PoreNetwork::ParametersForGeneratedGrid< Grid, Scalar >::throatLabel ( const std::array< int, 2 > & poreLabels ) const

inline

Computes and returns the label of a given throat.

Parameters

poreLabels

The labels of the pores adjacent to the throat.

---

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

• parametersforgeneratedgrid.hh