![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/grid/intergrid_map.h>
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) |
Subscriptor functionality | |
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer 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 |
SmartPointer< const MeshType, InterGridMap< MeshType > > | source_grid |
SmartPointer< 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 |
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:
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.
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.
In practice, use of this class is as follows:
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 116 of file intergrid_map.h.
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.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
InterGridMap< MeshType >::InterGridMap | ( | ) |
Constructor setting the class name arguments in the SmartPointer members.
Definition at line 38 of file intergrid_map.cc.
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.
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.
void InterGridMap< MeshType >::clear | ( | ) |
Delete all data of this class.
Definition at line 176 of file intergrid_map.cc.
const MeshType & InterGridMap< MeshType >::get_source_grid | ( | ) | const |
Return a reference to the source grid.
Definition at line 187 of file intergrid_map.cc.
const MeshType & InterGridMap< MeshType >::get_destination_grid | ( | ) | const |
Return a reference to the destination grid.
Definition at line 196 of file intergrid_map.cc.
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.
|
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.
|
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.
|
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 135 of file subscriptor.cc.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.
|
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 300 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.
|
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 309 of file subscriptor.h.
|
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.
Definition at line 52 of file subscriptor.cc.
|
private |
The actual data. Hold one iterator for each cell on each level.
Definition at line 185 of file intergrid_map.h.
|
private |
Store a pointer to the source grid.
Definition at line 190 of file intergrid_map.h.
|
private |
Likewise for the destination grid.
Definition at line 195 of file intergrid_map.h.
|
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 218 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.h.
|
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 248 of file subscriptor.h.
|
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 271 of file subscriptor.h.