dune-alugrid  3.0.0
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::MacroGridView< GridImp, pitype > Class Template Reference

#include <dune/alugrid/common/macrogridview.hh>

Classes

struct  Codim
 Codim Structure. More...
 

Public Types

enum  { conforming = Traits :: conforming }
 
enum  { dimension = Grid :: dimension }
 
enum  { dimensionworld = Grid :: dimensionworld }
 
typedef MacroGridViewTraits< GridImp, pitype > Traits
 
typedef Traits::Grid Grid
 type of the grid More...
 
typedef Traits ::IndexSet IndexSet
 type of the index set More...
 
typedef Traits ::Intersection Intersection
 type of the intersection More...
 
typedef Traits ::IntersectionIterator IntersectionIterator
 type of the intersection iterator More...
 
typedef Traits ::CollectiveCommunication CollectiveCommunication
 type of the collective communication More...
 
typedef Grid::ctype ctype
 type used for coordinates in grid More...
 

Public Member Functions

 MacroGridView (const Grid &grid)
 
const Gridgrid () const
 obtain a const reference to the underlying hierarchic grid More...
 
const IndexSetindexSet () const
 obtain the index set More...
 
int size (int codim) const
 obtain number of entities in a given codimension More...
 
int size (const GeometryType &type) const
 obtain number of entities with a given geometry type More...
 
template<int cd>
Codim< cd >::Iterator begin () const
 obtain begin iterator for this view More...
 
template<int cd, PartitionIteratorType pit>
Codim< cd >::template Partition< pit >::Iterator begin () const
 obtain begin iterator for this view More...
 
template<int cd>
Codim< cd >::Iterator end () const
 obtain end iterator for this view More...
 
template<int cd, PartitionIteratorType pit>
Codim< cd >::template Partition< pit >::Iterator end () const
 obtain end iterator for this view More...
 
IntersectionIterator ibegin (const typename Codim< 0 > ::Entity &entity) const
 obtain begin intersection iterator with respect to this view More...
 
IntersectionIterator iend (const typename Codim< 0 > ::Entity &entity) const
 obtain end intersection iterator with respect to this view More...
 
const CollectiveCommunicationcomm () const
 obtain collective communication object More...
 
int overlapSize (int codim) const
 Return size of the overlap region for a given codim on the grid view.
More...
 
int ghostSize (int codim) const
 Return size of the ghost region for a given codim on the grid view.
More...
 
template<class DataHandleImp , class DataType >
void communicate (CommDataHandleIF< DataHandleImp, DataType > &data, InterfaceType iftype, CommunicationDirection dir) const
 
int master (const typename Codim< 0 > ::Entity &entity) const
 return master rank for entities with partitionType != InteriorEntity More...
 
int macroId (const typename Codim< 0 > ::Entity &entity) const
 return unique id of macro entity for usage with graph partitioning software More...
 
int weight (const typename Codim< 0 > ::Entity &entity) const
 return weight associated with the given macro entity More...
 
int weight (const Intersection &intersection) const
 return weight associated with the macro intersection, i.e. the graph edge between the two neighboring entities More...
 
int weight (const IntersectionIterator &intersectionIterator) const
 

Protected Attributes

const Gridgrid_
 
const int level_
 

Member Typedef Documentation

◆ CollectiveCommunication

template<class GridImp , PartitionIteratorType pitype>
typedef Traits :: CollectiveCommunication Dune::MacroGridView< GridImp, pitype >::CollectiveCommunication

type of the collective communication

◆ ctype

template<class GridImp , PartitionIteratorType pitype>
typedef Grid::ctype Dune::MacroGridView< GridImp, pitype >::ctype

type used for coordinates in grid

◆ Grid

template<class GridImp , PartitionIteratorType pitype>
typedef Traits::Grid Dune::MacroGridView< GridImp, pitype >::Grid

type of the grid

◆ IndexSet

template<class GridImp , PartitionIteratorType pitype>
typedef Traits :: IndexSet Dune::MacroGridView< GridImp, pitype >::IndexSet

type of the index set

◆ Intersection

template<class GridImp , PartitionIteratorType pitype>
typedef Traits :: Intersection Dune::MacroGridView< GridImp, pitype >::Intersection

type of the intersection

◆ IntersectionIterator

template<class GridImp , PartitionIteratorType pitype>
typedef Traits :: IntersectionIterator Dune::MacroGridView< GridImp, pitype >::IntersectionIterator

type of the intersection iterator

◆ Traits

template<class GridImp , PartitionIteratorType pitype>
typedef MacroGridViewTraits< GridImp, pitype > Dune::MacroGridView< GridImp, pitype >::Traits

Member Enumeration Documentation

◆ anonymous enum

template<class GridImp , PartitionIteratorType pitype>
anonymous enum
Enumerator
conforming 

Export if this grid view is conforming *‍/.

◆ anonymous enum

template<class GridImp , PartitionIteratorType pitype>
anonymous enum
Enumerator
dimension 

The dimension of the grid.

◆ anonymous enum

template<class GridImp , PartitionIteratorType pitype>
anonymous enum
Enumerator
dimensionworld 

The dimension of the world the grid lives in.

Constructor & Destructor Documentation

◆ MacroGridView()

template<class GridImp , PartitionIteratorType pitype>
Dune::MacroGridView< GridImp, pitype >::MacroGridView ( const Grid grid)
inline

Member Function Documentation

◆ begin() [1/2]

template<class GridImp , PartitionIteratorType pitype>
template<int cd>
Codim< cd >:: Iterator Dune::MacroGridView< GridImp, pitype >::begin ( ) const
inline

obtain begin iterator for this view

◆ begin() [2/2]

template<class GridImp , PartitionIteratorType pitype>
template<int cd, PartitionIteratorType pit>
Codim< cd >:: template Partition< pit >:: Iterator Dune::MacroGridView< GridImp, pitype >::begin ( ) const
inline

obtain begin iterator for this view

◆ comm()

template<class GridImp , PartitionIteratorType pitype>
const CollectiveCommunication& Dune::MacroGridView< GridImp, pitype >::comm ( ) const
inline

obtain collective communication object

◆ communicate()

template<class GridImp , PartitionIteratorType pitype>
template<class DataHandleImp , class DataType >
void Dune::MacroGridView< GridImp, pitype >::communicate ( CommDataHandleIF< DataHandleImp, DataType > &  data,
InterfaceType  iftype,
CommunicationDirection  dir 
) const
inline

communicate data on this view

◆ end() [1/2]

template<class GridImp , PartitionIteratorType pitype>
template<int cd>
Codim< cd >:: Iterator Dune::MacroGridView< GridImp, pitype >::end ( ) const
inline

obtain end iterator for this view

◆ end() [2/2]

template<class GridImp , PartitionIteratorType pitype>
template<int cd, PartitionIteratorType pit>
Codim< cd >:: template Partition< pit >:: Iterator Dune::MacroGridView< GridImp, pitype >::end ( ) const
inline

obtain end iterator for this view

◆ ghostSize()

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::ghostSize ( int  codim) const
inline

Return size of the ghost region for a given codim on the grid view.

◆ grid()

template<class GridImp , PartitionIteratorType pitype>
const Grid& Dune::MacroGridView< GridImp, pitype >::grid ( ) const
inline

obtain a const reference to the underlying hierarchic grid

◆ ibegin()

template<class GridImp , PartitionIteratorType pitype>
IntersectionIterator Dune::MacroGridView< GridImp, pitype >::ibegin ( const typename Codim< 0 > ::Entity &  entity) const
inline

obtain begin intersection iterator with respect to this view

◆ iend()

template<class GridImp , PartitionIteratorType pitype>
IntersectionIterator Dune::MacroGridView< GridImp, pitype >::iend ( const typename Codim< 0 > ::Entity &  entity) const
inline

obtain end intersection iterator with respect to this view

◆ indexSet()

template<class GridImp , PartitionIteratorType pitype>
const IndexSet& Dune::MacroGridView< GridImp, pitype >::indexSet ( ) const
inline

obtain the index set

◆ macroId()

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::macroId ( const typename Codim< 0 > ::Entity &  entity) const
inline

return unique id of macro entity for usage with graph partitioning software

◆ master()

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::master ( const typename Codim< 0 > ::Entity &  entity) const
inline

return master rank for entities with partitionType != InteriorEntity

◆ overlapSize()

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::overlapSize ( int  codim) const
inline

Return size of the overlap region for a given codim on the grid view.

◆ size() [1/2]

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::size ( const GeometryType &  type) const
inline

obtain number of entities with a given geometry type

◆ size() [2/2]

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::size ( int  codim) const
inline

obtain number of entities in a given codimension

◆ weight() [1/3]

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::weight ( const Intersection intersection) const
inline

return weight associated with the macro intersection, i.e. the graph edge between the two neighboring entities

◆ weight() [2/3]

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::weight ( const IntersectionIterator intersectionIterator) const
inline

◆ weight() [3/3]

template<class GridImp , PartitionIteratorType pitype>
int Dune::MacroGridView< GridImp, pitype >::weight ( const typename Codim< 0 > ::Entity &  entity) const
inline

return weight associated with the given macro entity

Member Data Documentation

◆ grid_

template<class GridImp , PartitionIteratorType pitype>
const Grid* Dune::MacroGridView< GridImp, pitype >::grid_
protected

◆ level_

template<class GridImp , PartitionIteratorType pitype>
const int Dune::MacroGridView< GridImp, pitype >::level_
protected

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