dune-alugrid  2.8-git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Dune::ALUGrid< dim, dimworld, elType, refineType, Comm > Class Template Reference

unstructured parallel implementation of the DUNE grid interface More...

#include <dune/alugrid/3d/alugrid.hh>

Inheritance diagram for Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >:
Inheritance graph

Classes

struct  Partition
 

Public Types

enum  { dimension =BaseType::dimension , dimensionworld =BaseType::dimensionworld }
 
typedef BaseType::MPICommunicatorType MPICommunicatorType
 
typedef BaseType ::ALUGridVertexProjectionPairType ALUGridVertexProjectionPairType
 type of boundary projection More...
 
typedef BaseType::ctype ctype
 
typedef BaseType::GridFamily GridFamily
 
typedef GridFamily::Traits Traits
 
typedef BaseType::LocalIdSetImp LocalIdSetImp
 
typedef Traits ::GlobalIdSet GlobalIdSet
 
typedef Traits ::LocalIdSet LocalIdSet
 
typedef GridFamily ::LevelIndexSetImp LevelIndexSetImp
 
typedef GridFamily ::LeafIndexSetImp LeafIndexSetImp
 
typedef BaseType::LeafIteratorImp LeafIteratorImp
 
typedef Traits::template Codim< 0 >::LeafIterator LeafIteratorType
 
typedef Traits::template Codim< 0 >::LeafIterator LeafIterator
 
typedef BaseType::HierarchicIteratorImp HierarchicIteratorImp
 
typedef BaseType::ObjectStreamType ObjectStreamType
 
typedef Partition< All_Partition >::LevelGridView LevelGridView
 
typedef Partition< All_Partition >::LeafGridView LeafGridView
 

Public Member Functions

 ALUGrid (const std::string macroName, const MPICommunicatorType mpiComm=BaseType::defaultCommunicator(), const ALUGridVertexProjectionPairType &bndPrj=ALUGridVertexProjectionPairType(), const bool verb=true)
 constructor for creating ALUGrid from given macro grid file More...
 
 ALUGrid (const MPICommunicatorType mpiComm, const ALUGridVertexProjectionPairType &bndPrj, const std::string macroName, const bool verb=true)
 constructor called from ALUGridFactory for creating ALUConformGrid from given macro grid file More...
 
 ALUGrid (const MPICommunicatorType mpiComm=BaseType::defaultCommunicator())
 constructor creating empty grid, empty string creates empty grid More...
 
template<PartitionIteratorType pitype>
Partition< pitype >::LevelGridView levelView (int level) const
 
template<PartitionIteratorType pitype>
Partition< pitype >::LeafGridView leafView () const
 
LevelGridView levelView (int level) const
 
LeafGridView leafView () const
 
template<PartitionIteratorType pitype>
Partition< pitype >::LevelGridView levelGridView (int level) const
 
template<PartitionIteratorType pitype>
Partition< pitype >::LeafGridView leafGridView () const
 
LevelGridView levelGridView (int level) const
 
LeafGridView leafGridView () const
 

Static Public Member Functions

static std::string name ()
 
static std::string nameSuffix ()
 

Static Public Attributes

static const ALUGridRefinementType refinementType = refineType
 

Detailed Description

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm>
class Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >

unstructured parallel implementation of the DUNE grid interface

ALUGrid implements the DUNE grid interface for 2D quadrilateral and 3D hexahedral as well as 2D triangular and 3D tetrahedral meshes. This grid can be locally adapted (non-conforming and conforming bisection) and used in parallel computations using dynamic load balancing.

Template Parameters
dimdimension of the grid (2 or 3)
dimworlddimension of the surrounding space (dim <= dimworld <=3)
elTypetype of elements (Dune::simplex or Dune::cube)
refineTypetype of refinement (Dune::conforming or Dune::nonconforming)
Commtype of communicator (Dune::ALUGridMPIComm or Dune::ALUGridNoComm)
Note
For cube elements, only nonconforming refinement is available.
The template parameter Comm defaults to ALUGridMPIComm, if MPI is available. Otherwise it defaults to ALUGridNoComm.

Member Typedef Documentation

◆ ALUGridVertexProjectionPairType

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType :: ALUGridVertexProjectionPairType Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::ALUGridVertexProjectionPairType

type of boundary projection

◆ ctype

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType::ctype Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::ctype

◆ GlobalIdSet

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef Traits :: GlobalIdSet Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::GlobalIdSet

◆ GridFamily

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType::GridFamily Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::GridFamily

◆ HierarchicIteratorImp

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType::HierarchicIteratorImp Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::HierarchicIteratorImp

◆ LeafGridView

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef Partition< All_Partition >:: LeafGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LeafGridView

◆ LeafIndexSetImp

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef GridFamily :: LeafIndexSetImp Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LeafIndexSetImp

◆ LeafIterator

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef Traits:: template Codim<0>::LeafIterator Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LeafIterator

◆ LeafIteratorImp

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType::LeafIteratorImp Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LeafIteratorImp

◆ LeafIteratorType

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef Traits:: template Codim<0>::LeafIterator Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LeafIteratorType

◆ LevelGridView

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef Partition< All_Partition >:: LevelGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LevelGridView

◆ LevelIndexSetImp

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef GridFamily :: LevelIndexSetImp Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LevelIndexSetImp

◆ LocalIdSet

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef Traits :: LocalIdSet Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LocalIdSet

◆ LocalIdSetImp

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType::LocalIdSetImp Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::LocalIdSetImp

◆ MPICommunicatorType

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType::MPICommunicatorType Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::MPICommunicatorType

◆ ObjectStreamType

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef BaseType::ObjectStreamType Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::ObjectStreamType

◆ Traits

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
typedef GridFamily::Traits Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::Traits

Member Enumeration Documentation

◆ anonymous enum

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
anonymous enum
Enumerator
dimension 
dimensionworld 

Constructor & Destructor Documentation

◆ ALUGrid() [1/3]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::ALUGrid ( const std::string  macroName,
const MPICommunicatorType  mpiComm = BaseType::defaultCommunicator(),
const ALUGridVertexProjectionPairType bndPrj = ALUGridVertexProjectionPairType(),
const bool  verb = true 
)
inline

constructor for creating ALUGrid from given macro grid file

Parameters
macroNamefilename for macro grid in ALUGrid tetra format
mpiCommMPI Communicator (when HAVE_MPI == 1 then mpiComm is of type MPI_Comm and the default value is MPI_COMM_WORLD)
bndProjectglobal boundary projection pointer
bndVectorpointer to vector holding boundary projection for each boundary segment. ALUGrid takes ownership of this pointer and will delete it in the desctructor
verbWhether to write a notice about grid creation to stdout.

◆ ALUGrid() [2/3]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::ALUGrid ( const MPICommunicatorType  mpiComm,
const ALUGridVertexProjectionPairType bndPrj,
const std::string  macroName,
const bool  verb = true 
)
inline

constructor called from ALUGridFactory for creating ALUConformGrid from given macro grid file

Parameters
mpiCommMPI Communicator (when HAVE_MPI == 1 then mpiComm is of type MPI_Comm)
bndProjectglobal boundary projection pointer
bndVectorpointer to vector holding boundary projection for each boundary segment
Note
ALUGrid takes ownership of this pointer and will delete it in the desctructor
Parameters
macroNamefilename from which ALUGrid is being generated
verbWhether to write a notice about grid creation to stdout.

◆ ALUGrid() [3/3]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::ALUGrid ( const MPICommunicatorType  mpiComm = BaseType::defaultCommunicator())
inline

constructor creating empty grid, empty string creates empty grid

Member Function Documentation

◆ leafGridView() [1/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
template<PartitionIteratorType pitype>
Partition< pitype >::LeafGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::leafGridView ( ) const
inline

◆ leafGridView() [2/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
LeafGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::leafGridView ( ) const
inline

◆ leafView() [1/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
template<PartitionIteratorType pitype>
Partition< pitype >::LeafGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::leafView ( ) const
inline

◆ leafView() [2/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
LeafGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::leafView ( ) const
inline

◆ levelGridView() [1/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
template<PartitionIteratorType pitype>
Partition< pitype >::LevelGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::levelGridView ( int  level) const
inline

◆ levelGridView() [2/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
LevelGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::levelGridView ( int  level) const
inline

◆ levelView() [1/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
template<PartitionIteratorType pitype>
Partition< pitype >::LevelGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::levelView ( int  level) const
inline

◆ levelView() [2/2]

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
LevelGridView Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::levelView ( int  level) const
inline

◆ name()

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
static std::string Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::name ( )
inlinestatic

◆ nameSuffix()

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
static std::string Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::nameSuffix ( )
inlinestatic

Member Data Documentation

◆ refinementType

template<int dim, int dimworld, ALUGridElementType elType, ALUGridRefinementType refineType, class Comm >
const ALUGridRefinementType Dune::ALUGrid< dim, dimworld, elType, refineType, Comm >::refinementType = refineType
static

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