Dune::RefinementImp::HCube::RefinementGrid< dimension > Class Template Reference
Inheritance diagram for Dune::RefinementImp::HCube::RefinementGrid< dimension >:

Detailed Description
template<int dimension>
class Dune::RefinementImp::HCube::RefinementGrid< dimension >
Backend grid for hypercube refinement.
- Parameters:
-
dimension Dimension of the refined hypercube
Public Types | |
typedef RefinementGrid< dimension > | This |
Know yourself. | |
typedef SGrid< dimension, dimension > | BaseType |
Know your base class. | |
enum | |
maximum number of levels allowed | |
typedef SGridFamily< dim, dimworld >::Traits | Traits |
the traits of this class | |
typedef sgrid_ctype | ctype |
define type used for coordinates in grid module | |
Exported constants | |
enum | { dimension = dim } |
A constant that exports the template parameter dim. More... | |
enum | { dimensionworld = dimworld } |
A constant that exports the template parameter dimworld. More... | |
Public Member Functions | |
void | refineTo (int level) |
Make sure the grid as at least the given refinement level. | |
std::string | name () const |
return the name of this grid | |
int | maxLevel () const |
Traits::template Codim< cd >::template Partition< pitype >::LevelIterator | lbegin (int level) const |
Iterator to first entity of given codim on level. | |
Traits::template Codim< cd >::template Partition< All_Partition >::LevelIterator | lbegin (int level) const |
Iterator to first entity of given codim on level. | |
Traits::template Codim< cd >::template Partition< pitype >::LevelIterator | lend (int level) const |
one past the end on this level | |
Traits::template Codim< cd >::template Partition< All_Partition >::LevelIterator | lend (int level) const |
one past the end on this level | |
Traits::template Codim< cd >::template Partition< pitype >::LeafIterator | leafbegin () const |
return LeafIterator which points to the first entity | |
Traits::template Codim< cd >::template Partition< All_Partition >::LeafIterator | leafbegin () const |
return LeafIterator which points to the first entity | |
Traits::template Codim< cd >::template Partition< pitype >::LeafIterator | leafend () const |
one past the end on the leaf level | |
Traits::template Codim< cd >::template Partition< All_Partition >::LeafIterator | leafend () const |
return LeafIterator which points behind the last entity | |
void | communicate (T &t, InterfaceType iftype, CommunicationDirection dir, int level) |
template<class DataHandleImp, class DataTypeImp> | |
void | communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir, int level) const |
template<class DataHandleImp, class DataTypeImp> | |
void | communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir) const |
int | size (int level, int codim) const |
number of grid entities per level and codim | |
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 codim and geometry type in this process | |
int | global_size (int codim) const |
number of grid entities of all level for given codim | |
int | overlapSize (int level, int codim) |
return size (= distance in graph) of overlap region | |
int | overlapSize (int level, int codim) const |
return size (= distance in graph) of overlap region | |
int | overlapSize (int codim) const |
return size (= distance in graph) of overlap region | |
int | ghostSize (int level, int codim) |
return size (= distance in graph) of ghost 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 | |
void | globalRefine (int refCount) |
Refine mesh globally by one refCount levels. | |
const FixedArray< int, dim > & | dims (int level) const |
Get number of elements in each coordinate direction. | |
const FieldVector< sgrid_ctype, dimworld > & | lowerLeft () const |
Get lower left corner. | |
FieldVector< sgrid_ctype, dimworld > | upperRight () const |
Get upper right corner. | |
bool | adapt () |
map adapt to global refine | |
FieldVector< sgrid_ctype, dim > | pos (int level, FixedArray< int, dim > &z) const |
map expanded coordinates to position | |
int | calc_codim (int level, const FixedArray< int, dim > &z) const |
compute codim from coordinate | |
int | n (int level, const FixedArray< int, dim > z) const |
compute number from expanded coordinate | |
FixedArray< int, dim > | z (int level, int i, int codim) const |
compute coordinates from number and codimension | |
FixedArray< int, dim > | compress (int level, const FixedArray< int, dim > &z) const |
compress from expanded coordinates to grid for a single partition number | |
FixedArray< int, dim > | expand (int level, const FixedArray< int, dim > &r, int b) const |
expand with respect to partition number | |
int | partition (int level, const FixedArray< int, dim > &z) const |
bool | exists (int level, const FixedArray< int, dim > &zred) const |
given reduced coordinates of an element, determine if element is in the grid | |
const Traits::GlobalIdSet & | globalIdSet () const |
return const reference to the grids global id set | |
const Traits::LocalIdSet & | localIdSet () const |
return const reference to the grids local id set | |
const Traits::LevelIndexSet & | levelIndexSet (int level) const |
return const reference to the grids level index set for level level | |
const Traits::LeafIndexSet & | leafIndexSet () const |
return const reference to the grids leaf index set | |
const CollectiveCommunication< SGrid > & | comm () const |
return const reference to a collective communication object. The return type is a model of Dune::CollectiveCommunication. | |
template<class T> | |
bool | mark (int refCount, T &e) |
Marks an entity to be refined/coarsened in a subsequent adapt. | |
template<class T> | |
int | getMark (T &) const |
returns adaptation mark for given entity, i.e. here the default implementation returns 0. | |
bool | preAdapt () |
returns true, if at least one entity is marked for adaption | |
void | postAdapt () |
clean up some markers | |
bool | loadBalance () |
default implementation of load balance does nothing and returns false | |
template<class DataHandle> | |
bool | loadBalance (DataHandle &data) |
default implementation of load balance does nothing and returns false | |
Static Public Member Functions | |
static This & | instance () |
Return the singleton instance. | |
Protected Member Functions | |
template<class InterfaceType> | |
ReturnImplementationType< InterfaceType >::ImplementationType & | getRealImplementation (InterfaceType &i) const |
return real implementation of interface class | |
GridImp & | asImp () |
Barton-Nackman trick. | |
const GridImp & | asImp () const |
Barton-Nackman trick. |
Member Enumeration Documentation
anonymous enum [inherited] |
anonymous enum [inherited] |
Member Function Documentation
void Dune::RefinementImp::HCube::RefinementGrid< dimension >::refineTo | ( | int | level | ) |
Make sure the grid as at least the given refinement level.
This simply wraps the globalRefine() method of SGrid.
- Parameters:
-
level The refinement level to enforce
RefinementGrid< dimension > & Dune::RefinementImp::HCube::RefinementGrid< dimension >::instance | ( | ) | [static] |
Return the singleton instance.
Return the singleton instance of the RefinementGrid. Create it if neccessary.
int Dune::SGrid< dim, dimworld >::maxLevel | ( | ) | const [inherited] |
Return maximum level defined in this grid. Levels are numbered 0 ... maxLevel with 0 the coarsest level.
Reimplemented from Dune::Grid< dim, dimworld, ct, GridFamily >.
void Dune::SGrid< dim, dimworld >::communicate | ( | T & | t, | |
InterfaceType | iftype, | |||
CommunicationDirection | dir, | |||
int | level | |||
) | [inline, inherited] |
The communication interface
- Parameters:
-
T,: array class holding data associated with the entities P,: type used to gather/scatter data in and out of the message buffer codim,: communicate entites of given codim if,: one of the predifined interface types, throws error if it is not implemented level,: communicate for entities on the given level
void Dune::GridDefaultImplementation< dim, dimworld, ct, GridFamily >::communicate | ( | CommDataHandleIF< DataHandleImp, DataTypeImp > & | data, | |
InterfaceType | iftype, | |||
CommunicationDirection | dir, | |||
int | level | |||
) | const [inline, inherited] |
dummy communicate, doing nothing
Reimplemented from Dune::Grid< dim, dimworld, ct, GridFamily >.
Reimplemented in Dune::ALU3dGrid< 3, 3, Dune::hexa >, and Dune::ALU3dGrid< 3, 3, Dune::tetra >.
void Dune::GridDefaultImplementation< dim, dimworld, ct, GridFamily >::communicate | ( | CommDataHandleIF< DataHandleImp, DataTypeImp > & | data, | |
InterfaceType | iftype, | |||
CommunicationDirection | dir | |||
) | const [inline, inherited] |
dummy communicate, doing nothing
Reimplemented from Dune::Grid< dim, dimworld, ct, GridFamily >.
Reimplemented in Dune::ALU3dGrid< 3, 3, Dune::hexa >, and Dune::ALU3dGrid< 3, 3, Dune::tetra >.
int Dune::SGrid< dim, dimworld >::partition | ( | int | level, | |
const FixedArray< int, dim > & | z | |||
) | const [inherited] |
There are possibilities of having even/odd coordinates. The binary representation is called partition number.
bool Dune::GridDefaultImplementation< dim, dimworld, ct, GridFamily >::mark | ( | int | refCount, | |
T & | e | |||
) | [inline, inherited] |
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 EntityPointer 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 This template method will vanish due to the inheritance rules.
bool mark( int refCount, typename Traits::template Codim<0>::EntityPointer & e ).
Reimplemented from Dune::Grid< dim, dimworld, ct, GridFamily >.
int Dune::GridDefaultImplementation< dim, dimworld, ct, GridFamily >::getMark | ( | T & | ) | const [inline, inherited] |
returns adaptation mark for given entity, i.e. here the default implementation returns 0.
- Parameters:
-
[in] e Entity for which adaptation mark should be determined
- Returns:
- int adaptation mark, here the default value 0 is returned
Reimplemented from Dune::Grid< dim, dimworld, ct, GridFamily >.
The documentation for this class was generated from the following file: