#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

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

EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer class.
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

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

static ::ExceptionBase &	ExcIncompatibleGrids ()

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

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

Private Types
using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

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)

void	check_no_subscribers () const noexcept

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

ObserverPointer< const MeshType, InterGridMap< MeshType > >	source_grid

ObserverPointer< const MeshType, InterGridMap< MeshType > >	destination_grid

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

Static Private Attributes
static std::mutex	mutex

Detailed Description

template<typename 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  ------------------>  parent 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 parent 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).

Note: This class, function, or variable is a template, and it can only be instantiated if the following condition is true:
concepts::is_triangulation_or_dof_handler<MeshType>

concepts::is_triangulation_or_dof_handler
Definition template_constraints.h:975

If your compiler supports the C++20 standard, then this constraint will be enforced by a C++20 requires clause.

Definition at line 116 of file intergrid_map.h.

Member Typedef Documentation

◆ cell_iterator

template<typename MeshType >

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

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

Definition at line 122 of file intergrid_map.h.

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ InterGridMap()

template<typename MeshType >

InterGridMap< MeshType >::InterGridMap ( )

Constructor setting the class name arguments in the ObserverPointer members.

Definition at line 38 of file intergrid_map.cc.

Member Function Documentation

◆ make_mapping()

template<typename MeshType >

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

Create the mapping between the two grids.

Definition at line 47 of file intergrid_map.cc.

◆ operator[]()

template<typename 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 159 of file intergrid_map.cc.

◆ clear()

template<typename MeshType >

void InterGridMap< MeshType >::clear ( )

Delete all data of this class.

Definition at line 176 of file intergrid_map.cc.

◆ get_source_grid()

template<typename MeshType >

const MeshType & InterGridMap< MeshType >::get_source_grid ( ) const

Return a reference to the source grid.

Definition at line 187 of file intergrid_map.cc.

◆ get_destination_grid()

template<typename MeshType >

const MeshType & InterGridMap< MeshType >::get_destination_grid ( ) const

Return a reference to the destination grid.

Definition at line 196 of file intergrid_map.cc.

◆ memory_consumption()

template<typename MeshType >

std::size_t InterGridMap< MeshType >::memory_consumption ( ) const

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

Definition at line 205 of file intergrid_map.cc.

◆ set_mapping()

template<typename 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 103 of file intergrid_map.cc.

◆ set_entries_to_cell()

template<typename 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 142 of file intergrid_map.cc.

◆ subscribe()

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

inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

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

inherited

Unsubscribes a user from the object.

Note: The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 151 of file enable_observer_pointer.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::n_subscriptions ( ) const

inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 322 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >

void EnableObserverPointer::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 331 of file enable_observer_pointer.h.

◆ check_no_subscribers()

void EnableObserverPointer::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note: Since this function is just a consistency check it does nothing in release mode.; If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file enable_observer_pointer.cc.

Member Data Documentation

◆ mapping

template<typename 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 186 of file intergrid_map.h.

◆ source_grid

template<typename MeshType >

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

private

Store a pointer to the source grid.

Definition at line 191 of file intergrid_map.h.

◆ destination_grid

template<typename MeshType >

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

private

Likewise for the destination grid.

Definition at line 196 of file intergrid_map.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 227 of file enable_observer_pointer.h.

◆ counter_map

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

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 233 of file enable_observer_pointer.h.

◆ validity_pointers

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

mutableprivateinherited

In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.

Definition at line 249 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 257 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 280 of file enable_observer_pointer.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 Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Usage

Member Typedef Documentation

◆ cell_iterator

◆ map_value_type

◆ map_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()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ mapping

◆ source_grid

◆ destination_grid

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex