Dumux::FacetCouplingGmshReader< BulkGrid, numGrids > Class Template Reference

Reads gmsh files where (n-1)-dimensional grids are defined on the faces or edges of n-dimensional grids. More...

#include <dumux/multidomain/facet/gmshreader.hh>

Description

template<class BulkGrid, int numGrids>
class Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >

Reads gmsh files where (n-1)-dimensional grids are defined on the faces or edges of n-dimensional grids.

Note

Lower-dimensional entities appearing in the grid file are interpreted either as parts of a lower-dimensional grid living on the sub-entities of the grids with higher dimension, or as boundary segments. Per default, we consider all entities as part of the lower-dimensional grids. If you want to specify boundary segments as well, provide a threshold physical entity index. All entities with physical entity indices below this threshold will then be interpreted as boundary segments. Use respective physical entity indexing in your grid file in that case.

Template Parameters

BulkGrid	The type of the highest-dimensional grid in the hierachy
numGrids	The number of grids to be considered in the hierarchy

Public Member Functions
void	read (const std::string &fileName, bool verbose=false)
void	read (const std::string &fileName, std::size_t boundarySegThresh, bool verbose=false)
	Reads the data from a given mesh file. More...
const std::vector< GlobalPosition > &	gridVertices () const
	Returns the vector with all grid vertices (entire hierarchy) More...
VertexIndexSet &	vertexIndices (std::size_t id)
	Returns a grid's vertex indices. More...
const std::vector< ElementData > &	elementData (std::size_t id) const
	Returns the vector of read elements for a grid. More...
const std::vector< VertexIndexSet > &	boundarySegmentData (std::size_t id) const
	Returns the vector of read elements for a grid. More...
std::vector< int > &	elementMarkerMap (std::size_t id)
	Returns the maps of element markers. More...
std::vector< int > &	boundaryMarkerMap (std::size_t id)
	Returns the maps of domain markers. More...
std::unordered_map< GridIndexType, std::vector< GridIndexType > > &	embeddedEntityMap (std::size_t id)
	Returns the maps of the embedded entities. More...
std::unordered_map< GridIndexType, std::vector< GridIndexType > > &	adjoinedEntityMap (std::size_t id)
	Returns the maps of the embedments. More...

Member Function Documentation

adjoinedEntityMap()

template<class BulkGrid , int numGrids>

std::unordered_map< GridIndexType, std::vector< GridIndexType > > & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::adjoinedEntityMap ( std::size_t  id )

inline

Returns the maps of the embedments.

boundaryMarkerMap()

template<class BulkGrid , int numGrids>

std::vector< int > & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::boundaryMarkerMap ( std::size_t  id )

inline

Returns the maps of domain markers.

boundarySegmentData()

template<class BulkGrid , int numGrids>

const std::vector< VertexIndexSet > & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::boundarySegmentData ( std::size_t  id ) const

inline

Returns the vector of read elements for a grid.

elementData()

template<class BulkGrid , int numGrids>

const std::vector< ElementData > & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::elementData ( std::size_t  id ) const

inline

Returns the vector of read elements for a grid.

elementMarkerMap()

template<class BulkGrid , int numGrids>

std::vector< int > & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::elementMarkerMap ( std::size_t  id )

inline

Returns the maps of element markers.

embeddedEntityMap()

template<class BulkGrid , int numGrids>

std::unordered_map< GridIndexType, std::vector< GridIndexType > > & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::embeddedEntityMap ( std::size_t  id )

inline

Returns the maps of the embedded entities.

gridVertices()

template<class BulkGrid , int numGrids>

const std::vector< GlobalPosition > & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::gridVertices ( ) const

inline

Returns the vector with all grid vertices (entire hierarchy)

read() [1/2]

template<class BulkGrid , int numGrids>

void Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::read ( const std::string &  fileName, bool  verbose = false  )

inline

Reads the data from a given mesh file Use this routine if you don't specify boundary segments in the grid file

read() [2/2]

template<class BulkGrid , int numGrids>

void Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::read ( const std::string &  fileName, std::size_t  boundarySegThresh, bool  verbose = false  )

inline

Reads the data from a given mesh file.

vertexIndices()

template<class BulkGrid , int numGrids>

VertexIndexSet & Dumux::FacetCouplingGmshReader< BulkGrid, numGrids >::vertexIndices ( std::size_t  id )

inline

Returns a grid's vertex indices.

---

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

• gmshreader.hh