Reference documentation for deal.II version Git aa2075a 2017-04-21 00:33:12 +0200
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
InterGridMap< MeshType > Class Template Reference

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

Inheritance diagram for InterGridMap< MeshType >:
[legend]

Public Types

typedef MeshType::cell_iterator 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
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Public Member Functions

static::ExceptionBase & ExcInvalidKey (cell_iterator arg1)
 
static::ExceptionBase & ExcIncompatibleGrids ()
 
- Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)
 

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
 

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:

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
MeshTypeThis 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, PersistentTriangulation, or hp::DoFHandler).

Author
Wolfgang Bangerth, 1999

Definition at line 45 of file dof_tools.h.

Member Typedef Documentation

template<class MeshType>
typedef MeshType::cell_iterator InterGridMap< MeshType >::cell_iterator

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

Definition at line 119 of file intergrid_map.h.

Constructor & Destructor Documentation

template<class MeshType >
InterGridMap< MeshType >::InterGridMap ( )

Constructor setting the class name arguments in the SmartPointer members.

Definition at line 33 of file intergrid_map.cc.

Member Function Documentation

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 43 of file intergrid_map.cc.

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 158 of file intergrid_map.cc.

template<class MeshType >
void InterGridMap< MeshType >::clear ( )

Delete all data of this class.

Definition at line 173 of file intergrid_map.cc.

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

Return a pointer to the source grid.

Definition at line 184 of file intergrid_map.cc.

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

Return a pointer to the destination grid.

Definition at line 193 of file intergrid_map.cc.

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

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

Definition at line 202 of file intergrid_map.cc.

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 101 of file intergrid_map.cc.

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

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 177 of file intergrid_map.h.

template<class MeshType>
SmartPointer<const MeshType,InterGridMap<MeshType> > InterGridMap< MeshType >::source_grid
private

Store a pointer to the source grid.

Definition at line 182 of file intergrid_map.h.

template<class MeshType>
SmartPointer<const MeshType,InterGridMap<MeshType> > InterGridMap< MeshType >::destination_grid
private

Likewise for the destination grid.

Definition at line 187 of file intergrid_map.h.


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