Dumux::FacetCouplingGridManager< Grids > Class Template Reference

Creates the grids in the context of hybrid-dimensional coupled models, where the (n-1)-dimensional domains live on the element facets of the n-dimensional domains. More...

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

Description

template<typename... Grids>
class Dumux::FacetCouplingGridManager< Grids >

Creates the grids in the context of hybrid-dimensional coupled models, where the (n-1)-dimensional domains live on the element facets of the n-dimensional domains.

Template Parameters

Grids

the types of the grid hierarchy

Note

Grids must be ordered in descending grid dimension

Public Types
template<std::size_t id>
using	Grid = typename std::tuple_element_t< id, std::tuple< Grids... > >
	export the i-th grid type More...
template<std::size_t id>
using	GridPtr = typename std::shared_ptr< Grid< id > >
	export the i-th grid pointer type More...
using	GridData = GridDataWrapper
	export the grid data (wrapper) type, i.e. parameters/markers More...
using	Embeddings = FacetCouplingEmbeddings< Grids... >
	export the type storing the embeddings More...

Public Member Functions
template<std::size_t id>
const Grid< id > &	grid () const
	returns the i-th grid More...
std::shared_ptr< const GridData >	getGridData () const
	return a pointer to the grid data object More...
std::shared_ptr< const Embeddings >	getEmbeddings () const
	return a pointer to the object containing embeddings More...
void	init (const std::string &paramGroup="")
	creates the grids from a file given in parameter tree More...
void	loadBalance ()
	Distributes the grid on all processes of a parallel computation. More...

Static Public Attributes
static constexpr std::size_t	numGrids = sizeof...(Grids)
	export the number of created grids More...
static constexpr int	bulkGridId = 0
	export the grid id of the bulk grid (descending grid dim -> always zero!) More...

Protected Member Functions
template<std::size_t id>
Grid< id > &	grid_ ()
	return non-const reference to i-th grid More...
std::shared_ptr< Embeddings >	getEmbeddings_ ()
	return non-const pointer to the object containing embeddings More...

Member Typedef Documentation

Embeddings

template<typename... Grids>

using Dumux::FacetCouplingGridManager< Grids >::Embeddings = FacetCouplingEmbeddings<Grids...>

export the type storing the embeddings

Grid

template<typename... Grids>

template<std::size_t id>

using Dumux::FacetCouplingGridManager< Grids >::Grid = typename std::tuple_element_t<id, std::tuple<Grids...> >

export the i-th grid type

GridData

template<typename... Grids>

using Dumux::FacetCouplingGridManager< Grids >::GridData = GridDataWrapper

export the grid data (wrapper) type, i.e. parameters/markers

GridPtr

template<typename... Grids>

template<std::size_t id>

using Dumux::FacetCouplingGridManager< Grids >::GridPtr = typename std::shared_ptr< Grid<id> >

export the i-th grid pointer type

Member Function Documentation

getEmbeddings()

template<typename... Grids>

std::shared_ptr< const Embeddings > Dumux::FacetCouplingGridManager< Grids >::getEmbeddings ( ) const

inline

return a pointer to the object containing embeddings

getEmbeddings_()

template<typename... Grids>

std::shared_ptr< Embeddings > Dumux::FacetCouplingGridManager< Grids >::getEmbeddings_ ( )

inlineprotected

return non-const pointer to the object containing embeddings

getGridData()

template<typename... Grids>

std::shared_ptr< const GridData > Dumux::FacetCouplingGridManager< Grids >::getGridData ( ) const

inline

return a pointer to the grid data object

grid()

template<typename... Grids>

template<std::size_t id>

const Grid< id > & Dumux::FacetCouplingGridManager< Grids >::grid ( ) const

inline

returns the i-th grid

grid_()

template<typename... Grids>

template<std::size_t id>

Grid< id > & Dumux::FacetCouplingGridManager< Grids >::grid_ ( )

inlineprotected

return non-const reference to i-th grid

init()

template<typename... Grids>

void Dumux::FacetCouplingGridManager< Grids >::init ( const std::string &  paramGroup = "" )

inline

creates the grids from a file given in parameter tree

loadBalance()

template<typename... Grids>

void Dumux::FacetCouplingGridManager< Grids >::loadBalance ( )

inline

Distributes the grid on all processes of a parallel computation.

Member Data Documentation

bulkGridId

template<typename... Grids>

constexpr int Dumux::FacetCouplingGridManager< Grids >::bulkGridId = 0

staticconstexpr

export the grid id of the bulk grid (descending grid dim -> always zero!)

numGrids

template<typename... Grids>

constexpr std::size_t Dumux::FacetCouplingGridManager< Grids >::numGrids = sizeof...(Grids)

staticconstexpr

export the number of created grids

---

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

• multidomain/facet/gridmanager.hh