A meta grid for dividing an existing DUNE grid into subdomains that can be accessed as a grid in their own right. More...

#include <dune/grid/multidomaingrid/multidomaingrid.hh>

Inheritance diagram for Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >:

Public Types
using	HostGrid = HostGrid_

typedef MultiDomainGridFamily< HostGrid, MDGridTraitsType >	GridFamily

typedef GridFamily::Traits	Traits

typedef MDGridTraitsType	MDGridTraits

typedef HostGrid::ctype	ctype

typedef MDGridTraits::SubDomainIndex	SubDomainIndex
	The (integer) type used to identify subdomains.

typedef subdomain::SubDomainGrid< ThisType >	SubDomainGrid
	The type used for representing the grid of a subdomain, always a specialization of Dune::mdgrid::subdomain::SubDomainGrid.

typedef Traits::LeafSubDomainInterfaceIterator	LeafSubDomainInterfaceIterator
	The type of the iterators over the codim 1 interface between two subdomains on the leaf view.

typedef Traits::LevelSubDomainInterfaceIterator	LevelSubDomainInterfaceIterator
	The type of the iterators over the codim 1 interface between two subdomains on a level view.

typedef Traits::LeafAllSubDomainInterfacesIterator	LeafAllSubDomainInterfacesIterator
	The type of the iterators over the codim 1 interfaces between all subdomains on the leaf view.

typedef Traits::LevelAllSubDomainInterfacesIterator	LevelAllSubDomainInterfacesIterator
	The type of the iterators over the codim 1 interfaces between all subdomains on a level view.

typedef GridFamily::Traits::LeafGridView	LeafGridView

typedef GridFamily::Traits::LevelGridView	LevelGridView

typedef GridFamily::Traits::LeafIntersection	LeafIntersection

typedef GridFamily::Traits::LevelIntersection	LevelIntersection

typedef GridFamily::Traits::LeafIntersectionIterator	LeafIntersectionIterator

typedef GridFamily::Traits::LevelIntersectionIterator	LevelIntersectionIterator

typedef GridFamily::Traits::HierarchicIterator	HierarchicIterator

typedef GridFamily::Traits::LevelIndexSet	LevelIndexSet

typedef GridFamily::Traits::LeafIndexSet	LeafIndexSet

typedef GridFamily::Traits::GlobalIdSet	GlobalIdSet

typedef GridFamily::Traits::LocalIdSet	LocalIdSet

typedef detected_or_fallback_t< DeprecatedCollectiveCommunication_t, Communication_t, typename GridFamily::Traits >	Communication

typedef Communication	CollectiveCommunication

Public Member Functions
const SubDomainIndex	maxSubDomainIndex () const
	The largest allowed index for a subdomain.

Traits::LevelGridView	levelGridView (int level) const

Traits::LeafGridView	leafGridView () const

bool	mark (int refCount, const typename Traits ::template Codim< 0 >::Entity &e)

bool	mark (int refCount, const typename Codim< 0 >::Entity &e)

int	getMark (const typename Traits::template Codim< 0 >::Entity &e) const

int	getMark (const typename Codim< 0 >::Entity &e) const

Constructors
	MultiDomainGrid (const std::shared_ptr< HostGrid > &hostGrid, bool supportLevelIndexSets=true)
	Constructs a new MultiDomainGrid from the given host grid.

	MultiDomainGrid (const std::shared_ptr< HostGrid > &hostGrid, const MDGridTraitsType &traits, bool supportLevelIndexSets=true)
	Constructs a new MultiDomainGrid from the given host grid.

	MultiDomainGrid (HostGrid &hostGrid, bool supportLevelIndexSets=true)
	Constructs a new MultiDomainGrid from the given host grid.

	MultiDomainGrid (HostGrid &hostGrid, const MDGridTraitsType &traits, bool supportLevelIndexSets=true)
	Constructs a new MultiDomainGrid from the given host grid.

Dune grid interface methods
template<typename EntitySeed >
Traits::template Codim< EntitySeed::codimension >::Entity	entity (const EntitySeed &entitySeed) const

int	maxLevel () const
	The current maximum level of the grid.

template<int codim>
Traits::template Codim< codim >::LevelIterator	lbegin (int level) const

template<int codim>
Traits::template Codim< codim >::LevelIterator	lend (int level) const

template<int codim, PartitionIteratorType pitype>
Traits::template Codim< codim >::template Partition< pitype >::LevelIterator	lbegin (int level) const

template<int codim, PartitionIteratorType pitype>
Traits::template Codim< codim >::template Partition< pitype >::LevelIterator	lend (int level) const

template<int codim>
Traits::template Codim< codim >::LeafIterator	leafbegin () const

template<int codim>
Traits::template Codim< codim >::LeafIterator	leafend () const

template<int codim, PartitionIteratorType pitype>
Traits::template Codim< codim >::template Partition< pitype >::LeafIterator	leafbegin () const

template<int codim, PartitionIteratorType pitype>
Traits::template Codim< codim >::template Partition< pitype >::LeafIterator	leafend () const

int	size (int level, int codim) const

int	size (int codim) const

int	size (int level, GeometryType type) const

int	size (GeometryType type) const

const Traits::GlobalIdSet &	globalIdSet () const

const Traits::LocalIdSet &	localIdSet () const

const Traits::LevelIndexSet &	levelIndexSet (int level) const

const Traits::LeafIndexSet &	leafIndexSet () const

void	globalRefine (int refCount)

bool	mark (int refCount, const typename Traits::template Codim< 0 >::Entity &e)

int	getMark (const typename Traits::template Codim< 0 >::Entity &e)

bool	preAdapt ()

bool	adapt ()

void	postAdapt ()

int	overlapSize (int level, int codim) const

int	overlapSize (int codim) const

int	ghostSize (int level, int codim) const

int	ghostSize (int codim) const

const Traits::Communication &	comm () const

template<typename DataHandleImp , typename DataTypeImp >
void	communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir, int level) const

template<typename DataHandleImp , typename DataTypeImp >
void	communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir) const

template<typename DataHandle >
bool	loadBalance (DataHandle &dataHandle)

bool	loadBalance ()

size_t	numBoundarySegments () const

Methods for iterating over subdomain interfaces
LeafSubDomainInterfaceIterator	leafSubDomainInterfaceBegin (SubDomainIndex subDomain1, SubDomainIndex subDomain2) const
	Returns an iterator over the leaf interface of two subdomains.

LeafSubDomainInterfaceIterator	leafSubDomainInterfaceEnd (SubDomainIndex subDomain1, SubDomainIndex subDomain2) const
	Returns the corresponding end iterator for leafSubDomainInterfaceBegin().

LevelSubDomainInterfaceIterator	levelSubDomainInterfaceBegin (SubDomainIndex subDomain1, SubDomainIndex subDomain2, int level) const
	Returns an iterator over the interface of two subdomains at the given level.

LevelSubDomainInterfaceIterator	levelSubDomainInterfaceEnd (SubDomainIndex subDomain1, SubDomainIndex subDomain2, int level) const
	Returns the corresponding end iterator for levelSubDomainInterfaceBegin().

LeafAllSubDomainInterfacesIterator	leafAllSubDomainInterfacesBegin () const
	Returns an iterator over all subdomain interfaces on the leaf view.

LeafAllSubDomainInterfacesIterator	leafAllSubDomainInterfacesEnd () const
	Returns the corresponding end iterator for leafAllSubDomainInterfacesBegin().

LevelAllSubDomainInterfacesIterator	levelAllSubDomainInterfacesBegin (int level) const
	Returns an iterator over all subdomain interfaces on the requested level view.

LevelAllSubDomainInterfacesIterator	levelAllSubDomainInterfacesEnd (int level) const
	Returns the corresponding end iterator for levelAllSubDomainInterfacesBegin().

Subdomain creation- and adaptation methods
void	startSubDomainMarking ()
	Prepares the grid for (re-)assigning cells to subdomains.

void	preUpdateSubDomains ()
	Calculates the new subdomain layout, but does not update the current subdomains yet.

void	updateSubDomains ()
	Switches the subdomain layout over to the new layout.

void	postUpdateSubDomains ()
	clears the saved state of the subdomain layout that was active before the last call to updateSubDomains().

void	addToSubDomain (SubDomainIndex subDomain, const typename Traits::template Codim< 0 >::Entity &e)
	Adds the given leaf entity to the specified subdomain.

void	removeFromSubDomain (SubDomainIndex subDomain, const typename Traits::template Codim< 0 >::Entity &e)
	Removes the given leaf entity from the specified subdomain.

void	assignToSubDomain (SubDomainIndex subDomain, const typename Traits::template Codim< 0 >::Entity &e)
	Assigns the given leaf entity to the specified subdomain, clearing any previous subdomain assignments.

void	removeFromAllSubDomains (const typename Traits::template Codim< 0 >::Entity &e)
	Removes the given leaf entity from all subdomains it currently belongs to.

Access to the subdomain grids
const SubDomainGrid &	subDomain (SubDomainIndex subDomain) const
	Returns a reference to the SubDomainGrid associated with the given subdomain.

SubDomainGrid &	subDomain (SubDomainIndex subDomain)
	Returns a reference to the SubDomainGrid associated with the given subdomain.

SubDomainIndex	maxAssignedSubDomainIndex () const
	Returns the largest subdomain index that was ever assigned to a cell in this grid.

bool	supportLevelIndexSets () const
	Indicates whether this MultiDomainGrid instance supports level index sets on its SubDomainGrids.

Static Public Member Functions
static constexpr bool	maxSubDomainIndexIsStatic ()

Static Public Attributes
static const std::size_t	maxNumberOfSubDomains = MDGridTraits::maxSubDomainsPerCell
	The largest number of subdomains any given grid cell may belong to.

static constexpr int	dimension

static constexpr int	dimensionworld

Protected Types
typedef typename T::Communication	Communication_t

typedef typename T::CollectiveCommunication	DeprecatedCollectiveCommunication_t

Protected Member Functions
GridImp &	asImp ()

const GridImp &	asImp () const

Entity conversion methods
const MDGridTraits &	traits () const

template<typename Entity >
Traits::template Codim< Entity::codimension >::Entity	wrapHostEntity (const Entity &e) const

template<int codim>
Traits::template Codim< codim >::Entity	wrapHostEntity (const typename HostGrid::template Codim< codim >::Entity &e) const

template<typename EntityType >
static const HostEntity< EntityType >::type &	hostEntity (const EntityType &e)
	Returns a reference to the corresponding host entity.

template<typename EntityType >
static const MultiDomainEntity< EntityType >::type &	multiDomainEntity (const EntityType &e)

template<typename IntersectionType >
static const auto &	multiDomainIntersection (const IntersectionType &is)

Detailed Description

template<typename HostGrid_, typename MDGridTraitsType>
class Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >

A meta grid for dividing an existing DUNE grid into subdomains that can be accessed as a grid in their own right.

Template Parameters

HostGrid	The type of the underlying grid implementation.
MDGridTraitsType	A traits type for customizing how the MultiDomainGrid manages the partitioning information.

Member Typedef Documentation

◆ ctype

template<typename HostGrid_ , typename MDGridTraitsType >

typedef HostGrid::ctype Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::ctype

◆ GridFamily

template<typename HostGrid_ , typename MDGridTraitsType >

typedef MultiDomainGridFamily<HostGrid,MDGridTraitsType> Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::GridFamily

◆ HostGrid

template<typename HostGrid_ , typename MDGridTraitsType >

using Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::HostGrid = HostGrid_

◆ LeafAllSubDomainInterfacesIterator

template<typename HostGrid_ , typename MDGridTraitsType >

typedef Traits::LeafAllSubDomainInterfacesIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::LeafAllSubDomainInterfacesIterator

The type of the iterators over the codim 1 interfaces between all subdomains on the leaf view.

◆ LeafSubDomainInterfaceIterator

template<typename HostGrid_ , typename MDGridTraitsType >

typedef Traits::LeafSubDomainInterfaceIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::LeafSubDomainInterfaceIterator

The type of the iterators over the codim 1 interface between two subdomains on the leaf view.

◆ LevelAllSubDomainInterfacesIterator

template<typename HostGrid_ , typename MDGridTraitsType >

typedef Traits::LevelAllSubDomainInterfacesIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::LevelAllSubDomainInterfacesIterator

The type of the iterators over the codim 1 interfaces between all subdomains on a level view.

◆ LevelSubDomainInterfaceIterator

template<typename HostGrid_ , typename MDGridTraitsType >

typedef Traits::LevelSubDomainInterfaceIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::LevelSubDomainInterfaceIterator

The type of the iterators over the codim 1 interface between two subdomains on a level view.

◆ MDGridTraits

template<typename HostGrid_ , typename MDGridTraitsType >

typedef MDGridTraitsType Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::MDGridTraits

◆ SubDomainGrid

template<typename HostGrid_ , typename MDGridTraitsType >

typedef subdomain::SubDomainGrid<ThisType> Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::SubDomainGrid

The type used for representing the grid of a subdomain, always a specialization of Dune::mdgrid::subdomain::SubDomainGrid.

◆ SubDomainIndex

template<typename HostGrid_ , typename MDGridTraitsType >

typedef MDGridTraits::SubDomainIndex Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::SubDomainIndex

The (integer) type used to identify subdomains.

◆ Traits

template<typename HostGrid_ , typename MDGridTraitsType >

typedef GridFamily::Traits Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::Traits

Constructor & Destructor Documentation

◆ MultiDomainGrid() [1/4]

template<typename HostGrid_ , typename MDGridTraitsType >

Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::MultiDomainGrid	(	const std::shared_ptr< HostGrid > &	hostGrid,
		bool	supportLevelIndexSets = `true`
	)

inlineexplicit

Constructs a new MultiDomainGrid from the given host grid.

Parameters

hostGrid	the host grid that will be wrapped by the MultiDomainGrid
supportLevelIndexSets	flag indicating support for level index sets on subdomains

◆ MultiDomainGrid() [2/4]

template<typename HostGrid_ , typename MDGridTraitsType >

Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::MultiDomainGrid	(	const std::shared_ptr< HostGrid > &	hostGrid,
		const MDGridTraitsType &	traits,
		bool	supportLevelIndexSets = `true`
	)

inlineexplicit

Constructs a new MultiDomainGrid from the given host grid.

Parameters

hostGrid	the host grid that will be wrapped by the MultiDomainGrid
traits	an instance of the grid traits, which might contain runtime information
supportLevelIndexSets	flag indicating support for level index sets on subdomains

◆ MultiDomainGrid() [3/4]

template<typename HostGrid_ , typename MDGridTraitsType >

Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::MultiDomainGrid	(	HostGrid &	hostGrid,
		bool	supportLevelIndexSets = `true`
	)

inlineexplicit

Constructs a new MultiDomainGrid from the given host grid.

Parameters

hostGrid	the host grid that will be wrapped by the MultiDomainGrid
supportLevelIndexSets	flag indicating support for level index sets on subdomains

◆ MultiDomainGrid() [4/4]

template<typename HostGrid_ , typename MDGridTraitsType >

Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::MultiDomainGrid	(	HostGrid &	hostGrid,
		const MDGridTraitsType &	traits,
		bool	supportLevelIndexSets = `true`
	)

inlineexplicit

Constructs a new MultiDomainGrid from the given host grid.

Parameters

hostGrid	the host grid that will be wrapped by the MultiDomainGrid
traits	an instance of the grid traits, which might contain runtime information
supportLevelIndexSets	flag indicating support for level index sets on subdomains

Member Function Documentation

◆ adapt()

template<typename HostGrid_ , typename MDGridTraitsType >

bool Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::adapt ( )

inline

◆ addToSubDomain()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::addToSubDomain	(	SubDomainIndex	subDomain,
		const typename Traits::template Codim< 0 >::Entity &	e
	)

inline

Adds the given leaf entity to the specified subdomain.

◆ assignToSubDomain()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::assignToSubDomain	(	SubDomainIndex	subDomain,
		const typename Traits::template Codim< 0 >::Entity &	e
	)

inline

Assigns the given leaf entity to the specified subdomain, clearing any previous subdomain assignments.

◆ comm()

template<typename HostGrid_ , typename MDGridTraitsType >

const Traits::Communication & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::comm ( ) const

inline

◆ communicate() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename DataHandleImp , typename DataTypeImp >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::communicate	(	CommDataHandleIF< DataHandleImp, DataTypeImp > &	data,
		InterfaceType	iftype,
		CommunicationDirection	dir
	)		const

inline

◆ communicate() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename DataHandleImp , typename DataTypeImp >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::communicate	(	CommDataHandleIF< DataHandleImp, DataTypeImp > &	data,
		InterfaceType	iftype,
		CommunicationDirection	dir,
		int	level
	)		const

inline

◆ entity()

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename EntitySeed >

Traits::template Codim< EntitySeed::codimension >::Entity Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::entity ( const EntitySeed & entitySeed ) const

inline

◆ getMark()

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::getMark ( const typename Traits::template Codim< 0 >::Entity & e )

inline

◆ ghostSize() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::ghostSize ( int codim ) const

inline

◆ ghostSize() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::ghostSize	(	int	level,
		int	codim
	)		const

inline

◆ globalIdSet()

template<typename HostGrid_ , typename MDGridTraitsType >

const Traits::GlobalIdSet & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::globalIdSet ( ) const

inline

◆ globalRefine()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::globalRefine ( int refCount )

inline

◆ hostEntity()

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename EntityType >

static const HostEntity< EntityType >::type & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::hostEntity ( const EntityType & e )

inlinestatic

Returns a reference to the corresponding host entity.

Warning: The returned reference will only be valid as long as the passed-in reference to the MultiDomainGrid entity! If you need a persistent host entity object , copy the returned reference.

◆ lbegin() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim>

Traits::template Codim< codim >::LevelIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::lbegin ( int level ) const

inline

◆ lbegin() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim, PartitionIteratorType pitype>

Traits::template Codim< codim >::template Partition< pitype >::LevelIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::lbegin ( int level ) const

inline

◆ leafAllSubDomainInterfacesBegin()

template<typename HostGrid_ , typename MDGridTraitsType >

LeafAllSubDomainInterfacesIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafAllSubDomainInterfacesBegin ( ) const

inline

Returns an iterator over all subdomain interfaces on the leaf view.

This method returns an iterator that will visit all pairwise surface interfaces between subdomains on the leaf view. In particular, given to adjacent cells \(e_1\) and \(e_2\) and two subdomains \(s_1\) and \(s_2\), this iterator will visit the intersection between \(e_1\) and \(e_2\) iff all of the following hold:

\begin{eqnarray*} e_1 \in s_1,\ e_1 \not\in s_2,\\ e_2 \not\in s_1,\ e_1 \in s_2.\end{eqnarray*}

In essence, the two subdomains have to be locally disjoint on \(e_1\) and \(e_2\).

The iterator will only traverse the host grid once for visiting all subdomain interfaces. Incrementing the iterator might thus result in an iterator pointing to the same grid intersection, but to a different pair of subdomains. The subdomains pointed to by the iterator can be retrieved by calling LeafAllSubDomainInterfacesIterator::subDomain1() and LeafAllSubDomainInterfacesIterator::subDomain2(), respectively.

◆ leafAllSubDomainInterfacesEnd()

template<typename HostGrid_ , typename MDGridTraitsType >

LeafAllSubDomainInterfacesIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafAllSubDomainInterfacesEnd ( ) const

inline

Returns the corresponding end iterator for leafAllSubDomainInterfacesBegin().

◆ leafbegin() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim>

Traits::template Codim< codim >::LeafIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafbegin ( ) const

inline

◆ leafbegin() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim, PartitionIteratorType pitype>

Traits::template Codim< codim >::template Partition< pitype >::LeafIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafbegin ( ) const

inline

◆ leafend() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim>

Traits::template Codim< codim >::LeafIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafend ( ) const

inline

◆ leafend() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim, PartitionIteratorType pitype>

Traits::template Codim< codim >::template Partition< pitype >::LeafIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafend ( ) const

inline

◆ leafIndexSet()

template<typename HostGrid_ , typename MDGridTraitsType >

const Traits::LeafIndexSet & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafIndexSet ( ) const

inline

◆ leafSubDomainInterfaceBegin()

template<typename HostGrid_ , typename MDGridTraitsType >

LeafSubDomainInterfaceIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafSubDomainInterfaceBegin	(	SubDomainIndex	subDomain1,
		SubDomainIndex	subDomain2
	)		const

inline

Returns an iterator over the leaf interface of two subdomains.

The resulting iterator will visit all cell intersections that are part of both subdomains.

Attention: The iterator assumes the two subdomains to be non-overlapping! If there is an overlap, some intersections will be iterated over twice!

Parameters

subDomain1	the first subdomain
subDomain2	the second subdomain

◆ leafSubDomainInterfaceEnd()

template<typename HostGrid_ , typename MDGridTraitsType >

LeafSubDomainInterfaceIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::leafSubDomainInterfaceEnd	(	SubDomainIndex	subDomain1,
		SubDomainIndex	subDomain2
	)		const

inline

Returns the corresponding end iterator for leafSubDomainInterfaceBegin().

◆ lend() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim>

Traits::template Codim< codim >::LevelIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::lend ( int level ) const

inline

◆ lend() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim, PartitionIteratorType pitype>

Traits::template Codim< codim >::template Partition< pitype >::LevelIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::lend ( int level ) const

inline

◆ levelAllSubDomainInterfacesBegin()

template<typename HostGrid_ , typename MDGridTraitsType >

LevelAllSubDomainInterfacesIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::levelAllSubDomainInterfacesBegin ( int level ) const

inline

Returns an iterator over all subdomain interfaces on the requested level view.

This method returns an iterator that will visit all pairwise surface interfaces between subdomains on the requested level view. In particular, given to adjacent cells \(e_1\) and \(e_2\) and two subdomains \(s_1\) and \(s_2\), this iterator will visit the intersection between \(e_1\) and \(e_2\) iff all of the following hold:

\begin{eqnarray*} e_1 \in s_1,\ e_1 \not\in s_2,\\ e_2 \not\in s_1,\ e_1 \in s_2.\end{eqnarray*}

In essence, the two subdomains have to be locally disjoint on \(e_1\) and \(e_2\).

The iterator will only traverse the host grid once for visiting all subdomain interfaces. Incrementing the iterator might thus result in an iterator pointing to the same grid intersection, but to a different pair of subdomains. The subdomains pointed to by the iterator can be retrieved by calling LevelAllSubDomainInterfacesIterator::subDomain1() and LevelAllSubDomainInterfacesIterator::subDomain2(), respectively.

Parameters

level the grid level to be iterated over.

◆ levelAllSubDomainInterfacesEnd()

template<typename HostGrid_ , typename MDGridTraitsType >

LevelAllSubDomainInterfacesIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::levelAllSubDomainInterfacesEnd ( int level ) const

inline

Returns the corresponding end iterator for levelAllSubDomainInterfacesBegin().

Parameters

level the grid level to be iterated over.

◆ levelIndexSet()

template<typename HostGrid_ , typename MDGridTraitsType >

const Traits::LevelIndexSet & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::levelIndexSet ( int level ) const

inline

◆ levelSubDomainInterfaceBegin()

template<typename HostGrid_ , typename MDGridTraitsType >

LevelSubDomainInterfaceIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::levelSubDomainInterfaceBegin	(	SubDomainIndex	subDomain1,
		SubDomainIndex	subDomain2,
		int	level
	)		const

inline

Returns an iterator over the interface of two subdomains at the given level.

The resulting iterator will visit all cell intersections that are part of both subdomains.

Attention: The iterator assumes the two subdomains to be non-overlapping! If there is an overlap, some intersections will be iterated over twice!

Parameters

subDomain1	the first subdomain
subDomain2	the second subdomain
level	the grid level over which to iterate

◆ levelSubDomainInterfaceEnd()

template<typename HostGrid_ , typename MDGridTraitsType >

LevelSubDomainInterfaceIterator Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::levelSubDomainInterfaceEnd	(	SubDomainIndex	subDomain1,
		SubDomainIndex	subDomain2,
		int	level
	)		const

inline

Returns the corresponding end iterator for levelSubDomainInterfaceBegin().

Parameters

level the grid level to be iterated over.

◆ loadBalance() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

bool Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::loadBalance ( )

inline

◆ loadBalance() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename DataHandle >

bool Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::loadBalance ( DataHandle & dataHandle )

inline

◆ localIdSet()

template<typename HostGrid_ , typename MDGridTraitsType >

const Traits::LocalIdSet & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::localIdSet ( ) const

inline

◆ mark()

template<typename HostGrid_ , typename MDGridTraitsType >

bool Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::mark	(	int	refCount,
		const typename Traits::template Codim< 0 >::Entity &	e
	)

inline

◆ maxAssignedSubDomainIndex()

template<typename HostGrid_ , typename MDGridTraitsType >

SubDomainIndex Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::maxAssignedSubDomainIndex ( ) const

inline

Returns the largest subdomain index that was ever assigned to a cell in this grid.

This method returns the largest subdomain index that was passed to addToSubDomain() or assignToSubDomain() since this MultiDomainGrid was created. Keep in mind that the subdomain belonging to that index might not contain any entities anymore if all entities have been removed from it at a later point.

◆ maxLevel()

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::maxLevel ( ) const

inline

The current maximum level of the grid.

◆ maxSubDomainIndex()

template<typename HostGrid_ , typename MDGridTraitsType >

const SubDomainIndex Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::maxSubDomainIndex ( ) const

inline

The largest allowed index for a subdomain.

Note: As subdomain indices always start at 0, this also determines the maximum number of possible subdomains.

◆ maxSubDomainIndexIsStatic()

template<typename HostGrid_ , typename MDGridTraitsType >

static constexpr bool Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::maxSubDomainIndexIsStatic ( )

inlinestaticconstexpr

◆ multiDomainEntity()

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename EntityType >

static const MultiDomainEntity< EntityType >::type & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::multiDomainEntity ( const EntityType & e )

inlinestatic

◆ multiDomainIntersection()

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename IntersectionType >

static const auto & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::multiDomainIntersection ( const IntersectionType & is )

inlinestatic

◆ numBoundarySegments()

template<typename HostGrid_ , typename MDGridTraitsType >

size_t Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::numBoundarySegments ( ) const

inline

◆ overlapSize() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::overlapSize ( int codim ) const

inline

◆ overlapSize() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::overlapSize	(	int	level,
		int	codim
	)		const

inline

◆ postAdapt()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::postAdapt ( )

inline

◆ postUpdateSubDomains()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::postUpdateSubDomains ( )

inline

clears the saved state of the subdomain layout that was active before the last call to updateSubDomains().

◆ preAdapt()

template<typename HostGrid_ , typename MDGridTraitsType >

bool Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::preAdapt ( )

inline

◆ preUpdateSubDomains()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::preUpdateSubDomains ( )

inline

Calculates the new subdomain layout, but does not update the current subdomains yet.

After calling this method, you can query the grid for the changes that will occur when the new subdomain layout becomes active. This includes the possibility to obtain the new indices entities will be assigned in the modified subdomains.

To switch the grid over to the new layout, call updateSubDomains().

◆ removeFromAllSubDomains()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::removeFromAllSubDomains ( const typename Traits::template Codim< 0 >::Entity & e )

inline

Removes the given leaf entity from all subdomains it currently belongs to.

◆ removeFromSubDomain()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::removeFromSubDomain	(	SubDomainIndex	subDomain,
		const typename Traits::template Codim< 0 >::Entity &	e
	)

inline

Removes the given leaf entity from the specified subdomain.

◆ size() [1/4]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::size ( GeometryType type ) const

inline

◆ size() [2/4]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::size ( int codim ) const

inline

◆ size() [3/4]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::size	(	int	level,
		GeometryType	type
	)		const

inline

◆ size() [4/4]

template<typename HostGrid_ , typename MDGridTraitsType >

int Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::size	(	int	level,
		int	codim
	)		const

inline

◆ startSubDomainMarking()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::startSubDomainMarking ( )

inline

Prepares the grid for (re-)assigning cells to subdomains.

After calling this method, it becomes possible to invoke the various methods for cell assignment to subdomains. When you are done marking, call preUpdateSubDomains().

IMPORTANT: Reassigning subdomains and grid adaptation are mutually exclusive, it is not possibly to do both at the same time. This restriction is enforced by the grid.

◆ subDomain() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

SubDomainGrid & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::subDomain ( SubDomainIndex subDomain )

inline

Returns a reference to the SubDomainGrid associated with the given subdomain.

◆ subDomain() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

const SubDomainGrid & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::subDomain ( SubDomainIndex subDomain ) const

inline

Returns a reference to the SubDomainGrid associated with the given subdomain.

◆ supportLevelIndexSets()

template<typename HostGrid_ , typename MDGridTraitsType >

bool Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::supportLevelIndexSets ( ) const

inline

Indicates whether this MultiDomainGrid instance supports level index sets on its SubDomainGrids.

◆ traits()

template<typename HostGrid_ , typename MDGridTraitsType >

const MDGridTraits & Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::traits ( ) const

inline

◆ updateSubDomains()

template<typename HostGrid_ , typename MDGridTraitsType >

void Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::updateSubDomains ( )

inline

Switches the subdomain layout over to the new layout.

◆ wrapHostEntity() [1/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<typename Entity >

Traits::template Codim< Entity::codimension >::Entity Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::wrapHostEntity ( const Entity & e ) const

inline

◆ wrapHostEntity() [2/2]

template<typename HostGrid_ , typename MDGridTraitsType >

template<int codim>

Traits::template Codim< codim >::Entity Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::wrapHostEntity ( const typename HostGrid::template Codim< codim >::Entity & e ) const

inline

Member Data Documentation

◆ dimension

template<typename HostGrid_ , typename MDGridTraitsType >

static constexpr int Dune::GridDefaultImplementation< int dim, int dimworld, class ct, class GridFamily >::dimension

static

◆ dimensionworld

template<typename HostGrid_ , typename MDGridTraitsType >

static constexpr int Dune::GridDefaultImplementation< int dim, int dimworld, class ct, class GridFamily >::dimensionworld

static

◆ maxNumberOfSubDomains

template<typename HostGrid_ , typename MDGridTraitsType >

const std::size_t Dune::mdgrid::MultiDomainGrid< HostGrid_, MDGridTraitsType >::maxNumberOfSubDomains = MDGridTraits::maxSubDomainsPerCell

static

The largest number of subdomains any given grid cell may belong to.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Entity conversion methods

Detailed Description

Member Typedef Documentation

◆ ctype

◆ GridFamily

◆ HostGrid

◆ LeafAllSubDomainInterfacesIterator

◆ LeafSubDomainInterfaceIterator

◆ LevelAllSubDomainInterfacesIterator

◆ LevelSubDomainInterfaceIterator

◆ MDGridTraits

◆ SubDomainGrid

◆ SubDomainIndex

◆ Traits

Constructor & Destructor Documentation

◆ MultiDomainGrid() [1/4]

◆ MultiDomainGrid() [2/4]

◆ MultiDomainGrid() [3/4]

◆ MultiDomainGrid() [4/4]

Member Function Documentation

◆ adapt()

◆ addToSubDomain()

◆ assignToSubDomain()

◆ comm()

◆ communicate() [1/2]

◆ communicate() [2/2]

◆ entity()

◆ getMark()

◆ ghostSize() [1/2]

◆ ghostSize() [2/2]

◆ globalIdSet()

◆ globalRefine()

◆ hostEntity()

◆ lbegin() [1/2]

◆ lbegin() [2/2]

◆ leafAllSubDomainInterfacesBegin()

◆ leafAllSubDomainInterfacesEnd()

◆ leafbegin() [1/2]

◆ leafbegin() [2/2]

◆ leafend() [1/2]

◆ leafend() [2/2]

◆ leafIndexSet()

◆ leafSubDomainInterfaceBegin()

◆ leafSubDomainInterfaceEnd()

◆ lend() [1/2]

◆ lend() [2/2]

◆ levelAllSubDomainInterfacesBegin()

◆ levelAllSubDomainInterfacesEnd()

◆ levelIndexSet()

◆ levelSubDomainInterfaceBegin()

◆ levelSubDomainInterfaceEnd()

◆ loadBalance() [1/2]

◆ loadBalance() [2/2]

◆ localIdSet()

◆ mark()

◆ maxAssignedSubDomainIndex()

◆ maxLevel()

◆ maxSubDomainIndex()

◆ maxSubDomainIndexIsStatic()

◆ multiDomainEntity()

◆ multiDomainIntersection()

◆ numBoundarySegments()

◆ overlapSize() [1/2]

◆ overlapSize() [2/2]

◆ postAdapt()

◆ postUpdateSubDomains()

◆ preAdapt()

◆ preUpdateSubDomains()

◆ removeFromAllSubDomains()

◆ removeFromSubDomain()

◆ size() [1/4]

◆ size() [2/4]

◆ size() [3/4]

◆ size() [4/4]