#include <deal.II/grid/intergrid_map.h>

Inheritance diagram for InterGridMap< MeshType >:

Public Types
using	cell_iterator = typename MeshType::cell_iterator

Public Member Functions
	InterGridMap ()

void	make_mapping (const MeshType &source_grid, const MeshType &destination_grid)

cell_iterator	operator[] (const cell_iterator &source_cell) const

void	clear ()

const MeshType &	get_source_grid () const

const MeshType &	get_destination_grid () const

std::size_t	memory_consumption () const

Static Public Member Functions
static ::ExceptionBase &	ExcInvalidKey (cell_iterator arg1)

static ::ExceptionBase &	ExcIncompatibleGrids ()

Private Member Functions
void	set_mapping (const cell_iterator &src_cell, const cell_iterator &dst_cell)

void	set_entries_to_cell (const cell_iterator &src_cell, const cell_iterator &dst_cell)

Private Attributes
std::vector< std::vector< cell_iterator > >	mapping

SmartPointer< const MeshType, InterGridMap< MeshType > >	source_grid

SmartPointer< const MeshType, InterGridMap< MeshType > >	destination_grid

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
std::atomic< unsigned int >	counter

std::map< std::string, unsigned int >	counter_map

std::vector< std::atomic< bool > * >	validity_pointers

const std::type_info *	object_info

void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int	n_subscriptions () const

template<typename StreamType >
void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

void	check_no_subscribers () const noexcept

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

static std::mutex	mutex

Detailed Description

template<class MeshType>
class InterGridMap< MeshType >

This class provides a map between two grids which are derived from the same coarse grid. For each cell iterator of the source map, it provides the respective cell iterator on the destination map, through its operator [].

Usually, the two grids will be refined differently. Then, the value returned for an iterator on the source grid will be either:

The same cell on the destination grid, if it exists there;
The most refined cell of the destination grid from which the pendant of the source cell could be obtained by refinement. This cell is always active and has a refinement level less than that of the source cell.

Keys for this map are all cells on the source grid, whether active or not.

For example, consider these two one-dimensional grids:

* Grid 1:
*   x--x--x-----x-----------x
*    1  2    3        4
*
* Grid 2:
*   x-----x-----x-----x-----x
*      1     2     3     4
*

(Cell numbers are only given as an example and will not correspond to real cell iterator's indices.) The mapping from grid 1 to grid 2 will then be as follows:

*    Cell on grid 1         Cell on grid 2
*          1  ------------------>  1
*          2  ------------------>  1
*          3  ------------------>  2
*          4  ------------------>  mother cell of cells 3 and 4
*                                  (a non-active cell, not shown here)
*

Besides the mappings shown here, the non-active cells on grid 1 are also valid keys. For example, the mapping for the mother cell of cells 1 and 2 on the first grid will point to cell 1 on the second grid.

Template Parameters

MeshType This class may be used with any class that satisfies the MeshType concept. The extension to other classes offering iterator functions and some minor additional requirements is simple.

Note that this class could in principle be based on the C++ std::map<Key,Value> data type. Instead, it uses another data format which is more effective both in terms of computing time for access as well as with regard to memory consumption.

Usage

In practice, use of this class is as follows:

// have two grids, which are derived from the same coarse grid
Triangulation<dim> tria1, tria2;
DoFHandler<dim> dof_handler_1 (tria1), dof_handler_2 (tria2);
...
// do something with these objects, e.g. refine the triangulations
// differently, distribute degrees of freedom, etc
...
// create the mapping
InterGridMap<DoFHandler<dim> > grid_1_to_2_map;
grid_1_to_2_map.make_mapping (dof_handler_1,
                              dof_handler_2);
...
typename DoFHandler<dim>::cell_iterator cell = dof_handler_1.begin(),
                                        endc = dof_handler_1.end();
for (; cell!=endc; ++cell)
  // now do something with the cell of dof_handler_2 corresponding to
  // cell (which is one of dof_handler_1's cells)
  f (grid_1_to_2_map[cell]);

Note that the template parameters to this class have to be given as InterGridMap<DoFHandler<2> >, which here is DoFHandler (and could equally well be Triangulation or PersistentTriangulation).

Definition at line 114 of file intergrid_map.h.

Member Typedef Documentation

◆ cell_iterator

template<class MeshType >

using InterGridMap< MeshType >::cell_iterator = typename MeshType::cell_iterator

Typedef to the iterator type of the grid class under consideration.

Definition at line 120 of file intergrid_map.h.

Constructor & Destructor Documentation

◆ InterGridMap()

template<class MeshType >

InterGridMap< MeshType >::InterGridMap

Constructor setting the class name arguments in the SmartPointer members.

Definition at line 37 of file intergrid_map.cc.

Member Function Documentation

◆ make_mapping()

template<class MeshType >

void InterGridMap< MeshType >::make_mapping	(	const MeshType &	source_grid,
		const MeshType &	destination_grid
	)

Create the mapping between the two grids.

Definition at line 46 of file intergrid_map.cc.

◆ operator[]()

template<class MeshType >

InterGridMap< MeshType >::cell_iterator InterGridMap< MeshType >::operator[] ( const cell_iterator & source_cell ) const

Access operator: give a cell on the source grid and receive the respective cell on the other grid, or if that does not exist, the most refined cell of which the source cell would be created if it were further refined.

Definition at line 157 of file intergrid_map.cc.

◆ clear()

template<class MeshType >

void InterGridMap< MeshType >::clear

Delete all data of this class.

Definition at line 174 of file intergrid_map.cc.

◆ get_source_grid()

template<class MeshType >

const MeshType & InterGridMap< MeshType >::get_source_grid

Return a reference to the source grid.

Definition at line 185 of file intergrid_map.cc.

◆ get_destination_grid()

template<class MeshType >

const MeshType & InterGridMap< MeshType >::get_destination_grid

Return a reference to the destination grid.

Definition at line 194 of file intergrid_map.cc.

◆ memory_consumption()

template<class MeshType >

std::size_t InterGridMap< MeshType >::memory_consumption

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 203 of file intergrid_map.cc.

◆ set_mapping()

template<class MeshType >

void InterGridMap< MeshType >::set_mapping	(	const cell_iterator &	src_cell,
		const cell_iterator &	dst_cell
	)

private

Set the mapping for the pair of cells given. These shall match in level of refinement and all other properties.

Definition at line 102 of file intergrid_map.cc.

◆ set_entries_to_cell()

template<class MeshType >

void InterGridMap< MeshType >::set_entries_to_cell	(	const cell_iterator &	src_cell,
		const cell_iterator &	dst_cell
	)

private

Set the value of the key src_cell to dst_cell. Do so as well for all the children and their children of src_cell. This function is used for cells which are more refined on src_grid than on dst_grid; then all values of the hierarchy of cells and their children point to one cell on the dst_grid.

Definition at line 141 of file intergrid_map.cc.

Member Data Documentation

◆ mapping

template<class MeshType >

std::vector<std::vector<cell_iterator> > InterGridMap< MeshType >::mapping

private

The actual data. Hold one iterator for each cell on each level.

Definition at line 183 of file intergrid_map.h.

◆ source_grid

template<class MeshType >

SmartPointer<const MeshType, InterGridMap<MeshType> > InterGridMap< MeshType >::source_grid

private

Store a pointer to the source grid.

Definition at line 188 of file intergrid_map.h.

◆ destination_grid

template<class MeshType >

SmartPointer<const MeshType, InterGridMap<MeshType> > InterGridMap< MeshType >::destination_grid

private

Likewise for the destination grid.

Definition at line 193 of file intergrid_map.h.

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

include/deal.II/grid/intergrid_map.h
source/grid/intergrid_map.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Subscriptor functionality

Detailed Description

Usage

Member Typedef Documentation

◆ cell_iterator

Constructor & Destructor Documentation

◆ InterGridMap()

Member Function Documentation

◆ make_mapping()

◆ operator[]()

◆ clear()

◆ get_source_grid()

◆ get_destination_grid()

◆ memory_consumption()

◆ set_mapping()

◆ set_entries_to_cell()

Member Data Documentation

◆ mapping

◆ source_grid

◆ destination_grid