version 3.9-dev
Public Member Functions | List of all members
Dumux::PoreNetwork::GridData< Grid > Class Template Reference
Mathematical models » Pore network

Class for grid data attached to dgf or gmsh grid files.

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

Inheritance diagram for Dumux::PoreNetwork::GridData< Grid >:

Public Member Functions

 GridData (Dune::GridPtr< Grid > grid, const std::string &paramGroup)
 constructor for dgf grid data More...
 
 GridData (std::shared_ptr< Grid > grid, const std::string &paramGroup)
 constructor for non-dgf grid data More...
 
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...
 
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...
 
std::vector< SmallLocalIndex > getCoordinationNumbers () const
 Returns the coordination numbers for all pore bodies. More...
 
void assignParameters ()
 Assign parameters for generically created grids. More...
 
void resizeParameterContainers ()
 
void copyDgfData ()
 
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...
 
Scalar getParameter (const Element &element, const std::string &param) const
 Returns the value of an element parameter. More...
 
Scalar getParameter (const Vertex &vertex, const std::string &param) const
 Returns the value of an vertex parameter. More...
 
int poreLabelAtPosForGenericGrid (const GlobalPosition &pos) const
 Returns the pore label at a given position for a generic grid. This is needed by the grid creator in case not all parameters are initialized yet. 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

◆ GridData() [1/2]

template<class Grid >
Dumux::PoreNetwork::GridData< Grid >::GridData ( Dune::GridPtr< Grid >  grid,
const std::string &  paramGroup 
)
inline

◆ GridData() [2/2]

template<class Grid >
Dumux::PoreNetwork::GridData< Grid >::GridData ( std::shared_ptr< Grid >  grid,
const std::string &  paramGroup 
)
inline

Member Function Documentation

◆ assignParameters()

template<class Grid >
void Dumux::PoreNetwork::GridData< Grid >::assignParameters ( )
inline

◆ copyDgfData()

template<class Grid >
void Dumux::PoreNetwork::GridData< Grid >::copyDgfData ( )
inline

◆ elementParameterNames()

template<class Grid >
const std::vector< std::string > & Dumux::PoreNetwork::GridData< Grid >::elementParameterNames ( ) const
inline

◆ getCoordinationNumbers()

template<class Grid >
std::vector< SmallLocalIndex > Dumux::PoreNetwork::GridData< Grid >::getCoordinationNumbers ( ) const
inline

◆ getParameter() [1/2]

template<class Grid >
Scalar Dumux::PoreNetwork::GridData< Grid >::getParameter ( const Element &  element,
const std::string &  param 
) const
inline

◆ getParameter() [2/2]

template<class Grid >
Scalar Dumux::PoreNetwork::GridData< Grid >::getParameter ( const Vertex &  vertex,
const std::string &  param 
) const
inline

◆ gridHasElementParameter()

template<class Grid >
bool Dumux::PoreNetwork::GridData< Grid >::gridHasElementParameter ( const std::string &  param) const
inline

◆ gridHasVertexParameter()

template<class Grid >
bool Dumux::PoreNetwork::GridData< Grid >::gridHasVertexParameter ( const std::string &  param) const
inline

◆ parameterIndex()

template<class Grid >
int Dumux::PoreNetwork::GridData< Grid >::parameterIndex ( const std::string &  paramName) const
inline

◆ parameters() [1/3]

template<class Grid >
template<class GridImp , class IntersectionImp >
const Dune::DGFBoundaryParameter::type & Dumux::PoreNetwork::GridData< Grid >::parameters ( const Dune::Intersection< GridImp, IntersectionImp > &  intersection) const
inline

◆ parameters() [2/3]

template<class Grid >
const std::vector< double > & Dumux::PoreNetwork::GridData< Grid >::parameters ( const Element &  element) const
inline

◆ parameters() [3/3]

template<class Grid >
const std::vector< double > & Dumux::PoreNetwork::GridData< Grid >::parameters ( const Vertex &  vertex) const
inline
Note
You can only pass vertices that exist on level 0!

◆ paramGroup()

template<class Grid >
const std::string & Dumux::PoreNetwork::GridData< Grid >::paramGroup ( ) const
inline

◆ poreLabelAtPosForGenericGrid()

template<class Grid >
int Dumux::PoreNetwork::GridData< Grid >::poreLabelAtPosForGenericGrid ( const GlobalPosition &  pos) const
inline

◆ resizeParameterContainers()

template<class Grid >
void Dumux::PoreNetwork::GridData< Grid >::resizeParameterContainers ( )
inline

◆ vertexParameterNames()

template<class Grid >
const std::vector< std::string > & Dumux::PoreNetwork::GridData< Grid >::vertexParameterNames ( ) const
inline
The documentation for this class was generated from the following file: