DUNE-FEM (unstable)
[ provides Dune::Grid ] More...
#include <dune/grid/yaspgrid.hh>
Public Types | |
typedef Coordinates::ctype | ctype |
Type used for coordinates. | |
typedef ReservedVector< YGridLevel, 32 >::const_iterator | YGridLevelIterator |
Iterator over the grid levels. | |
typedef YaspGridFamily< dim, Coordinates > | GridFamily |
the GridFamily of this grid | |
Exported types | |
typedef GridFamily::Traits::LeafGridView | LeafGridView |
type of view for leaf grid | |
typedef GridFamily::Traits::LevelGridView | LevelGridView |
type of view for level grid | |
typedef GridFamily::Traits::LeafIntersection | LeafIntersection |
A type that is a model of Dune::Intersection, an intersections of two codimension 1 of two codimension 0 entities in the leaf view. | |
typedef GridFamily::Traits::LevelIntersection | LevelIntersection |
A type that is a model of Dune::Intersection, an intersections of two codimension 1 of two codimension 0 entities in a level view. | |
typedef GridFamily::Traits::LeafIntersectionIterator | LeafIntersectionIterator |
A type that is a model of Dune::IntersectionIterator which is an iterator that allows to examine, but not to modify, the intersections of codimension 1 of an leaf element (entity of codimension 0) with other leaf elements. | |
typedef GridFamily::Traits::LevelIntersectionIterator | LevelIntersectionIterator |
A type that is a model of Dune::IntersectionIterator which is an iterator that allows to examine, but not to modify, the intersections of codimension 1 of an element (entity of codimension 0) with other elements on the same level. | |
typedef GridFamily::Traits::HierarchicIterator | HierarchicIterator |
A type that is a model of Dune::HierarchicIterator A type of iterator that allows to examine, but not to modify, entities of codimension 0 that result from refinement of an entity of codimension 0. | |
typedef GridFamily::Traits::LevelIndexSet | LevelIndexSet |
A type that is a model of Dune::IndexSet which provides a consecutive, but non persistent, numbering for entities on a grid level. | |
typedef GridFamily::Traits::LeafIndexSet | LeafIndexSet |
A type that is a model of Dune::IndexSet which provides a consecutive, but non persistent, numbering for entities in the leaf grid. | |
typedef GridFamily::Traits::GlobalIdSet | GlobalIdSet |
A type that is a model of Dune::IdSet which provides a unique and persistent numbering for all entities in the grid. The numbering is unique over all processes over which the grid is partitioned. The numbering is not necessarily consecutive. | |
typedef GridFamily::Traits::LocalIdSet | LocalIdSet |
A type that is a model of Dune::IdSet which provides a unique and persistent numbering for all entities in the grid. The numbering is only unique in a single process and it is not necessarily consecutive. | |
Public Member Functions | |
const Torus< Communication, dim > & | torus () const |
return reference to torus | |
int | globalSize (int i) const |
return number of cells on finest level in given direction on all processors | |
iTupel | globalSize () const |
return number of cells on finest level on all processors | |
int | levelSize (int l, int i) const |
return size of the grid (in cells) on level l in direction i | |
iTupel | levelSize (int l) const |
return size vector of the grid (in cells) on level l | |
bool | isPeriodic (int i) const |
return whether the grid is periodic in direction i | |
YGridLevelIterator | begin () const |
return iterator pointing to coarsest level | |
YGridLevelIterator | begin (int i) const |
return iterator pointing to given level | |
YGridLevelIterator | end () const |
return iterator pointing to one past the finest level | |
YaspGrid (const Coordinates &coordinates, std::bitset< dim > periodic=std::bitset< dim >(0ULL), int overlap=1, Communication comm=Communication(), const Yasp::Partitioning< dim > *partitioner=defaultPartitioner()) | |
template<class C = Coordinates, typename std::enable_if_t< std::is_same_v< C, EquidistantCoordinates< ctype, dim > >, int > = 0> | |
YaspGrid (Dune::FieldVector< ctype, dim > L, std::array< int, std::size_t{dim}> s, std::bitset< std::size_t{dim}> periodic=std::bitset< std::size_t{dim}>{0ULL}, int overlap=1, Communication comm=Communication(), const Yasp::Partitioning< dim > *partitioner=defaultPartitioner()) | |
template<class C = Coordinates, typename std::enable_if_t< std::is_same_v< C, EquidistantOffsetCoordinates< ctype, dim > >, int > = 0> | |
YaspGrid (Dune::FieldVector< ctype, dim > lowerleft, Dune::FieldVector< ctype, dim > upperright, std::array< int, std::size_t{dim}> s, std::bitset< std::size_t{dim}> periodic=std::bitset< std::size_t{dim}>(0ULL), int overlap=1, Communication comm=Communication(), const Yasp::Partitioning< dim > *partitioner=defaultPartitioner()) | |
template<class C = Coordinates, typename std::enable_if_t< std::is_same_v< C, TensorProductCoordinates< ctype, dim > >, int > = 0> | |
YaspGrid (std::array< std::vector< ctype >, std::size_t{dim}> coords, std::bitset< std::size_t{dim}> periodic=std::bitset< std::size_t{dim}>(0ULL), int overlap=1, Communication comm=Communication(), const Yasp::Partitioning< dim > *partitioner=defaultPartitioner()) | |
Standard constructor for a tensorproduct YaspGrid. More... | |
int | maxLevel () const |
void | globalRefine (int refCount) |
refine the grid refCount times. | |
void | refineOptions (bool keepPhysicalOverlap) |
set options for refinement More... | |
bool | mark (int refCount, const typename Traits::template Codim< 0 >::Entity &e) |
Marks an entity to be refined/coarsened in a subsequent adapt. More... | |
int | getMark (const typename Traits::template Codim< 0 >::Entity &e) const |
returns adaptation mark for given entity More... | |
bool | adapt () |
map adapt to global refine | |
bool | preAdapt () |
returns true, if the grid will be coarsened | |
void | postAdapt () |
clean up some markers | |
template<int cd, PartitionIteratorType pitype> | |
Traits::template Codim< cd >::template Partition< pitype >::LevelIterator | lbegin (int level) const |
one past the end on this level | |
template<int cd, PartitionIteratorType pitype> | |
Traits::template Codim< cd >::template Partition< pitype >::LevelIterator | lend (int level) const |
Iterator to one past the last entity of given codim on level for partition type. | |
template<int cd> | |
Traits::template Codim< cd >::template Partition< All_Partition >::LevelIterator | lbegin (int level) const |
version without second template parameter for convenience | |
template<int cd> | |
Traits::template Codim< cd >::template Partition< All_Partition >::LevelIterator | lend (int level) const |
version without second template parameter for convenience | |
template<int cd, PartitionIteratorType pitype> | |
Traits::template Codim< cd >::template Partition< pitype >::LeafIterator | leafbegin () const |
return LeafIterator which points to the first entity in maxLevel | |
template<int cd, PartitionIteratorType pitype> | |
Traits::template Codim< cd >::template Partition< pitype >::LeafIterator | leafend () const |
return LeafIterator which points behind the last entity in maxLevel | |
template<int cd> | |
Traits::template Codim< cd >::template Partition< All_Partition >::LeafIterator | leafbegin () const |
return LeafIterator which points to the first entity in maxLevel | |
template<int cd> | |
Traits::template Codim< cd >::template Partition< All_Partition >::LeafIterator | leafend () const |
return LeafIterator which points behind the last entity in maxLevel | |
int | overlapSize (int level, int codim) const |
return size (= distance in graph) of overlap region | |
int | overlapSize (int odim) const |
return size (= distance in graph) of overlap region | |
int | ghostSize (int level, int codim) const |
return size (= distance in graph) of ghost region | |
int | ghostSize (int codim) const |
return size (= distance in graph) of ghost region | |
int | size (int level, int codim) const |
number of entities per level and codim in this process | |
int | size (int codim) const |
number of leaf entities per codim in this process | |
int | size (int level, GeometryType type) const |
number of entities per level and geometry type in this process | |
int | size (GeometryType type) const |
number of leaf entities per geometry type in this process | |
size_t | numBoundarySegments () const |
returns the number of boundary segments within the macro grid | |
const Dune::FieldVector< ctype, dim > & | domainSize () const |
returns the size of the physical domain | |
template<class DataHandleImp , class DataType > | |
void | communicate (CommDataHandleIF< DataHandleImp, DataType > &data, InterfaceType iftype, CommunicationDirection dir, int level) const |
template<class DataHandleImp , class DataType > | |
void | communicate (CommDataHandleIF< DataHandleImp, DataType > &data, InterfaceType iftype, CommunicationDirection dir) const |
template<class DataHandle , int codim> | |
void | communicateCodim (DataHandle &data, InterfaceType iftype, CommunicationDirection dir, int level) const |
const Communication & | comm () const |
return a communication object | |
Traits::LevelGridView | levelGridView (int level) const |
View for a grid level for All_Partition. | |
Traits::LeafGridView | leafGridView () const |
View for the leaf grid for All_Partition. | |
Traits::LeafIntersectionIterator | ileafbegin (const typename Traits::template Codim< 0 >::Entity &entity) const |
obtain begin intersection iterator on the leaf level | |
Traits::LeafIntersectionIterator | ileafend (const typename Traits::template Codim< 0 >::Entity &entity) const |
obtain end intersection iterator on the leaf level | |
Traits::LevelIntersectionIterator | ilevelbegin (const typename Traits::template Codim< 0 >::Entity &entity) const |
obtain begin intersection iterator on the entity level | |
Traits::LevelIntersectionIterator | ilevelend (const typename Traits::template Codim< 0 >::Entity &entity) const |
obtain end intersection iterator on the entity level | |
bool | mark (int refCount, const typename Traits ::template Codim< 0 >::Entity &e) |
Marks an entity to be refined/coarsened in a subsequent adapt. More... | |
bool | loadBalance () |
default implementation of load balance does nothing and returns false | |
bool | loadBalance (DataHandle &data) |
default implementation of load balance does nothing and returns false | |
Adaptivity and grid refinement | |
bool | mark (int refCount, const typename Codim< 0 >::Entity &e) |
Marks an entity to be refined/coarsened in a subsequent adapt. More... | |
int | getMark (const typename Codim< 0 >::Entity &e) const |
returns adaptation mark for given entity More... | |
Static Public Attributes | |
Exported constants | |
static constexpr int | dimension |
The dimension of the grid. | |
static constexpr int | dimensionworld |
The dimension of the world the grid lives in. | |
Protected Member Functions | |
void | makelevel (const Coordinates &coords, std::bitset< dim > periodic, iTupel o_interior, int overlap) |
Make a new YGridLevel structure. More... | |
void | intersections (const YGridComponent< Coordinates > &sendgrid, const YGridComponent< Coordinates > &recvgrid, std::deque< Intersection > &sendlist, std::deque< Intersection > &recvlist) |
Construct list of intersections with neighboring processors. More... | |
Parallel data distribution and communication | |
Codim< EntitySeed::codimension >::Entity | entity (const EntitySeed &seed) const |
obtain Entity from EntitySeed. | |
GridImp & | asImp () |
Barton-Nackman trick. | |
const GridImp & | asImp () const |
Barton-Nackman trick. | |
Detailed Description
class Dune::YaspGrid< dim, Coordinates >
[ provides Dune::Grid ]
Provides a distributed structured cube mesh.
YaspGrid stands for yet another structured parallel grid. It implements the dune grid interface for structured grids with arbitrary overlap (including zero), periodic boundaries, and a fast implementation allowing on-the-fly computations.
YaspGrid supports three coordinate modes: EquidistantCoordinates, EquidistantOffsetCoordinates, and Dune::TensorProductCoordinates.
- Template Parameters
-
dim The dimension of the grid and its surrounding world Coordinates The coordinate mode of the grid.
- Examples
- recipe-integration.cc, and recipe-iterate-over-grid.cc.
Constructor & Destructor Documentation
◆ YaspGrid() [1/4]
|
inline |
Standard constructor for a YaspGrid with a given Coordinates object
- Parameters
-
coordinates Object that stores or computes the vertex coordinates periodic tells if direction is periodic or not overlap size of overlap on coarsest grid (same in all directions) comm the communication object for this grid. An MPI communicator can be given here. partitioner pointer to an overloaded Yasp::Partitioning instance
References Dune::back(), Dune::YaspGrid< dim, Coordinates >::begin(), Dune::YaspGrid< dim, Coordinates >::comm(), DUNE_THROW, Dune::YaspGrid< dim, Coordinates >::end(), Dune::front(), Dune::YaspGrid< dim, Coordinates >::makelevel(), Dune::Torus< Communication, d >::partition(), Dune::push_back(), Dune::Torus< Communication, d >::rank(), Dune::ReservedVector< T, n >::resize(), and Dune::FieldVector< K, SIZE >::size().
◆ YaspGrid() [2/4]
|
inline |
Standard constructor for an equidistant YaspGrid
- Parameters
-
L extension of the domain s number of cells on coarse mesh in each direction periodic tells if direction is periodic or not overlap size of overlap on coarsest grid (same in all directions) comm the communication object for this grid. An MPI communicator can be given here. partitioner pointer to an overloaded Yasp::Partitioning instance
◆ YaspGrid() [3/4]
|
inline |
Constructor for an equidistant YaspGrid with non-trivial origin
- Parameters
-
lowerleft Lower left corner of the domain upperright Upper right corner of the domain s number of cells on coarse mesh in each direction periodic tells if direction is periodic or not overlap size of overlap on coarsest grid (same in all directions) comm the communication object for this grid. An MPI communicator can be given here. partitioner pointer to an overloaded Yasp::Partitioning instance
◆ YaspGrid() [4/4]
|
inline |
Standard constructor for a tensorproduct YaspGrid.
- Parameters
-
coords coordinate vectors to be used for coarse grid periodic tells if direction is periodic or not overlap size of overlap on coarsest grid (same in all directions) comm the communication object for this grid. An MPI communicator can be given here. partitioner pointer to an overloaded Yasp::Partitioning instance
Member Function Documentation
◆ communicate() [1/2]
|
inline |
The new communication interface
communicate objects for all codims on the leaf grid
References Dune::YaspGrid< dim, Coordinates >::maxLevel().
◆ communicate() [2/2]
|
inline |
The new communication interface
communicate objects for all codims on a given level
◆ communicateCodim()
|
inline |
The new communication interface
communicate objects for one codim
References Dune::All_All_Interface, Dune::BackwardCommunication, Dune::YaspGrid< dim, Coordinates >::begin(), Dune::YGridList< Coordinates >::begin(), Dune::YGridList< Coordinates >::end(), Dune::Torus< Communication, d >::exchange(), Dune::InteriorBorder_All_Interface, Dune::InteriorBorder_InteriorBorder_Interface, Dune::Overlap_All_Interface, Dune::Overlap_OverlapFront_Interface, Dune::Torus< Communication, d >::recv(), Dune::Torus< Communication, d >::send(), Dune::YGridList< Coordinates >::size(), and Dune::YaspGrid< dim, Coordinates >::torus().
◆ getMark() [1/2]
|
inlineinherited |
◆ getMark() [2/2]
|
inline |
returns adaptation mark for given entity
- Parameters
-
[in] e Entity for which adaptation mark should be determined
- Returns
- int adaptation mark, here the default value 0 is returned
References Dune::YaspGrid< dim, Coordinates >::maxLevel().
◆ intersections()
|
inlineprotected |
Construct list of intersections with neighboring processors.
- Parameters
-
recvgrid the grid stored in this processor sendgrid the subgrid to be sent to neighboring processors sendlist the deque to fill with send intersections recvlist the deque to fill with recv intersections
- Returns
- two lists: Intersections to be sent and Intersections to be received
References Dune::Torus< Communication, d >::coord(), Dune::Torus< Communication, d >::dims(), Dune::Torus< Communication, d >::exchange(), Dune::YaspGrid< dim, Coordinates >::globalSize(), Dune::YGridComponent< Coordinates >::intersection(), Dune::YGridComponent< Coordinates >::move(), Dune::Torus< Communication, d >::neighbors(), Dune::Torus< Communication, d >::recv(), Dune::Torus< Communication, d >::recvbegin(), Dune::Torus< Communication, d >::recvend(), Dune::Torus< Communication, d >::send(), Dune::Torus< Communication, d >::sendbegin(), Dune::Torus< Communication, d >::sendend(), and Dune::YaspGrid< dim, Coordinates >::size().
Referenced by Dune::YaspGrid< dim, Coordinates >::makelevel().
◆ makelevel()
|
inlineprotected |
Make a new YGridLevel structure.
- Parameters
-
coords the coordinate container periodic indicate periodicity for each direction o_interior origin of interior (non-overlapping) cell decomposition overlap to be used on this grid level
References Dune::ReservedVector< T, n >::back(), Dune::YaspGrid< dim, Coordinates >::globalSize(), Dune::YaspGrid< dim, Coordinates >::intersections(), Dune::YaspGrid< dim, Coordinates >::maxLevel(), Dune::power(), and Dune::YaspGrid< dim, Coordinates >::size().
Referenced by Dune::YaspGrid< dim, Coordinates >::globalRefine(), and Dune::YaspGrid< dim, Coordinates >::YaspGrid().
◆ mark() [1/3]
|
inlineinherited |
◆ mark() [2/3]
|
inlineinherited |
Marks an entity to be refined/coarsened in a subsequent adapt.
- Parameters
-
[in] refCount Number of subdivisions that should be applied. Negative value means coarsening. [in] e Entity to Entity that should be refined
- Returns
- true if Entity was marked, false otherwise.
- Note
- default implementation is: return false; for grids with no adaptation.
- for the grid programmer: this method is implemented as a template method, because the Entity type is not defined when the class is instantiated You won't need this trick in the implementation. In your implementation you should use it as typename Traits::template Codim<0>::Entity & e ).bool mark(int refCount, const typename Traits::template Codim< 0 >::Entity &e)Marks an entity to be refined/coarsened in a subsequent adapt.Definition: yaspgrid.hh:1287
◆ mark() [3/3]
|
inline |
Marks an entity to be refined/coarsened in a subsequent adapt.
- Parameters
-
[in] refCount Number of subdivisions that should be applied. Negative value means coarsening. [in] e Entity to Entity that should be refined
- Returns
- true if Entity was marked, false otherwise.
- Note
- On yaspgrid marking one element will mark all other elements of the level as well
- If refCount is lower than refCount of a previous mark-call, nothing is changed
References Dune::YaspGrid< dim, Coordinates >::maxLevel().
◆ maxLevel()
|
inline |
Return maximum level defined in this grid. Levels are numbered 0 ... maxlevel with 0 the coarsest level.
References Dune::ReservedVector< T, n >::size().
Referenced by Dune::BackupRestoreFacility< Dune::YaspGrid< dim, Coordinates > >::backup(), Dune::BackupRestoreFacility< YaspGrid< dim, TensorProductCoordinates< ctype, dim > > >::backup(), Dune::YaspGrid< dim, Coordinates >::begin(), Dune::YaspGrid< dim, Coordinates >::communicate(), Dune::YaspGrid< dim, Coordinates >::getMark(), Dune::YaspGrid< dim, Coordinates >::globalRefine(), Dune::YaspGrid< dim, Coordinates >::globalSize(), Dune::YaspGrid< dim, Coordinates >::leafbegin(), Dune::YaspGrid< dim, Coordinates >::leafend(), Dune::YaspGrid< dim, Coordinates >::makelevel(), Dune::YaspGrid< dim, Coordinates >::mark(), Dune::operator<<(), Dune::YaspGrid< dim, Coordinates >::overlapSize(), and Dune::YaspGrid< dim, Coordinates >::size().
◆ refineOptions()
|
inline |
set options for refinement
- Parameters
-
keepPhysicalOverlap [true] keep the physical size of the overlap, [false] keep the number of cells in the overlap. Default is [true].
Referenced by Dune::BackupRestoreFacility< Dune::YaspGrid< dim, Coordinates > >::restore(), and Dune::BackupRestoreFacility< YaspGrid< dim, TensorProductCoordinates< ctype, dim > > >::restore().
The documentation for this class was generated from the following file:
- dune/grid/yaspgrid.hh