Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid > Class Template Reference

wrapper for subgrid data More...

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

Description

template<class HostGrid, class SubGrid>
class Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >

wrapper for subgrid data

Public Member Functions
	SubGridData (const SubGrid &subGrid, std::shared_ptr< const GridData< HostGrid > > hostGridData)
const std::vector< double > &	parameters (const Vertex &vertex) const
	Call the parameters function of the DGF grid pointer if available for vertex data. More...
const std::vector< double > &	parameters (const Element &element) const
	Call the parameters function of the DGF grid pointer if available for element data. More...
auto	getParameter (const Element &element, const std::string &param) const
	Returns the value of an element parameter. More...
auto	getParameter (const Vertex &vertex, const std::string &param) const
	Returns the value of an vertex parameter. More...
template<class GridImp , class IntersectionImp >
const Dune::DGFBoundaryParameter::type &	parameters (const Dune::Intersection< GridImp, IntersectionImp > &intersection) const
	Call the parameters function of the DGF grid pointer if available. More...
auto	throatLabel (const Element &element) const
	Computes and returns the label of a given throat. More...
int	boundaryFaceMarkerAtPos (const GlobalPosition &pos) const
	Returns the boundary face marker index at given position. More...
std::vector< SmallLocalIndex >	getCoordinationNumbers () const
	Returns the coordination numbers for all pore bodies. More...
int	parameterIndex (const std::string &paramName) const
	Return the index for a given parameter name. More...
const std::string &	paramGroup () const
	Return the parameter group. More...
bool	gridHasElementParameter (const std::string &param) const
	Return if a given element parameter is provided by the grid. More...
bool	gridHasVertexParameter (const std::string &param) const
	Return if a given vertex parameter is provided by the grid. More...
const std::vector< std::string > &	vertexParameterNames () const
	Returns the names of the vertex parameters. More...
const std::vector< std::string > &	elementParameterNames () const
	Returns the names of the element parameters. More...

Constructor & Destructor Documentation

SubGridData()

template<class HostGrid , class SubGrid >

Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::SubGridData ( const SubGrid &  subGrid, std::shared_ptr< const GridData< HostGrid > >  hostGridData  )

inline

Member Function Documentation

boundaryFaceMarkerAtPos()

template<class HostGrid , class SubGrid >

int Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::boundaryFaceMarkerAtPos ( const GlobalPosition &  pos ) const

inline

Returns the boundary face marker index at given position.

Parameters

pos	The current position

elementParameterNames()

template<class HostGrid , class SubGrid >

const std::vector< std::string > & Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::elementParameterNames ( ) const

inline

Returns the names of the element parameters.

getCoordinationNumbers()

template<class HostGrid , class SubGrid >

std::vector< SmallLocalIndex > Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::getCoordinationNumbers ( ) const

inline

Returns the coordination numbers for all pore bodies.

getParameter() [1/2]

template<class HostGrid , class SubGrid >

auto Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::getParameter ( const Element &  element, const std::string &  param  ) const

inline

Returns the value of an element parameter.

getParameter() [2/2]

template<class HostGrid , class SubGrid >

auto Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::getParameter ( const Vertex &  vertex, const std::string &  param  ) const

inline

Returns the value of an vertex parameter.

gridHasElementParameter()

template<class HostGrid , class SubGrid >

bool Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::gridHasElementParameter ( const std::string &  param ) const

inline

Return if a given element parameter is provided by the grid.

gridHasVertexParameter()

template<class HostGrid , class SubGrid >

bool Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::gridHasVertexParameter ( const std::string &  param ) const

inline

Return if a given vertex parameter is provided by the grid.

parameterIndex()

template<class HostGrid , class SubGrid >

int Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::parameterIndex ( const std::string &  paramName ) const

inline

Return the index for a given parameter name.

parameters() [1/3]

template<class HostGrid , class SubGrid >

template<class GridImp , class IntersectionImp >

const Dune::DGFBoundaryParameter::type & Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::parameters ( const Dune::Intersection< GridImp, IntersectionImp > &  intersection ) const

inline

Call the parameters function of the DGF grid pointer if available.

parameters() [2/3]

template<class HostGrid , class SubGrid >

const std::vector< double > & Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::parameters ( const Element &  element ) const

inline

Call the parameters function of the DGF grid pointer if available for element data.

parameters() [3/3]

template<class HostGrid , class SubGrid >

const std::vector< double > & Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::parameters ( const Vertex &  vertex ) const

inline

Call the parameters function of the DGF grid pointer if available for vertex data.

Note

You can only pass vertices that exist on level 0!

paramGroup()

template<class HostGrid , class SubGrid >

const std::string & Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::paramGroup ( ) const

inline

Return the parameter group.

Todo:

For now we don't support two different parameter groups for the subgrids

throatLabel()

template<class HostGrid , class SubGrid >

auto Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::throatLabel ( const Element &  element ) const

inline

Computes and returns the label of a given throat.

Parameters

element

The element (throat)

vertexParameterNames()

template<class HostGrid , class SubGrid >

const std::vector< std::string > & Dumux::PoreNetwork::SubGridData< HostGrid, SubGrid >::vertexParameterNames ( ) const

inline

Returns the names of the vertex parameters.

---

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

• subgriddata.hh