Dune::ALUCubeGrid< 2, dimw > Class Template Reference

constructor for creating ALUSimplexGrid from given macro grid file More...

#include <dune/grid/alugrid/2d/alugrid.hh>

Public Types
typedef BaseType ::DuneBoundaryProjectionType	DuneBoundaryProjectionType
	type of boundary projection
typedef BaseType ::DuneBoundaryProjectionVector	DuneBoundaryProjectionVector
	type of boundary projection
enum
	maximal number of levels
enum
	element chunk for refinement
enum
	upper estimate on number of elements that could be created when a new element is created
typedef ALU2dGridObjectStream	ObjectStreamType
	dummy object stream
typedef ALU2dGridHierarchicIndexSet< dim, dimworld, elementType >	HierarchicIndexSet
	Type of the hierarchic index set.
typedef ALU2dGridLevelIterator< 0, All_Partition, const ThisType >	LevelIteratorImp
	a standard leaf iterator
Exported constants
enum
	A constant that exports the template parameter dim.
enum
	A constant that exports the template parameter dimworld.
Exported types
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::CollectiveCommunication	CollectiveCommunication
	A type that is a model of Dune::CollectiveCommunication. It provides a portable way for collective communication on the set of processes used by the grid.

Public Member Functions
DUNE_DEPRECATED	ALUCubeGrid (const std::string macroName, const DuneBoundaryProjectionType *bndProject=0, const DuneBoundaryProjectionVector *bndVector=0, const bool verbose=true)
	constructor for creating ALUSimplexGrid from given macro grid file More...
DUNE_DEPRECATED	ALUCubeGrid (const std::string macroName, std::istream &macroFile, const DuneBoundaryProjectionType *bndProject=0, const DuneBoundaryProjectionVector *bndVector=0, const bool verbose=true)
	constructor for creating ALUSimplexGrid from given macro grid file More...
DUNE_DEPRECATED	ALUCubeGrid ()
int	maxLevel () const
Traits::template Codim< cd >::template Partition< pitype >::LevelIterator	lbegin (int level) const
Traits::template Codim< cd >::template Partition< All_Partition >::LevelIterator	lbegin (int level) const
	Iterator to first entity of given codim on level.
LevelIteratorType	lbegin (int level) const
	Iterator to first entity of codim 0 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
LevelIteratorType	lend (int level) const
	last entity of codim 0 on level
Traits::template Codim< codim >::template Partition< pitype >::LeafIterator	leafbegin () const
	General definiton for a leaf iterator.
Traits::template Codim< codim >::LeafIterator	leafbegin () const
	General definiton for a leaf iterator.
Traits::template Codim< codim >::template Partition< pitype >::LeafIterator	leafend () const
	General definition for an end iterator on leaf level.
Traits::template Codim< codim >::LeafIterator	leafend () const
	General definition for an end iterator on leaf level.
int	size (int level, int cd) 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, codim and geometry type in this process
int	size (GeometryType type) const
	number of leaf entities per codim and geometry type in this process
const std::vector< GeometryType > &	geomTypes (int codim) const
	deliver all geometry types used in this grid
const GlobalIdSet &	globalIdSet () const
	get global id set of grid
const LocalIdSet &	localIdSet () const
	get global id set of grid
int	hierSetSize (int cd) const
	number of grid entities in the entire grid for given codim
const HierarchicIndexSet &	hierarchicIndexSet () const
	get hierarchic index set of the grid
const Traits ::LeafIndexSet &	leafIndexSet () const
	get leaf index set of the grid
const Traits ::LevelIndexSet &	levelIndexSet (int level) const
	get level index set of the grid
void	globalRefine (int refCount)
	refine grid refCount times
bool	preAdapt ()
	returns if a least one entity was marked for coarsening
void	postAdapt ()
	clear all entity new markers
bool	adapt ()
int	getMark (const typename Traits::template Codim< 0 >::Entity &e) const
	returns adaptation mark for given entity 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...
bool	mark (int refCount, const typename Traits ::template Codim< 0 >::Entity &e)
	Marks an entity to be refined/coarsened in a subsequent adapt. More...
const CollectiveCommunicationType &	comm () const
	return dummy communication
size_t	numBoundarySegments () const
	return number of macro boundary segments
bool	hasBoundaryProjection () const
	return true if boudanry projection is set
ALU2dGridMarkerVector &	getMarkerVector (int level) const
ALU2dGridLeafMarkerVectorType &	getLeafMarker () const
bool	writeGrid (const std::string filename, alu2d_ctype time) const
	write Grid to file in specified FileFormatType
bool	readGrid (const std::string filename, alu2d_ctype &time)
	read Grid from file filename and store time of mesh in time
void	backup (std::ostream &) const
	backup to ostream
void	restore (std::istream &)
	restore from istream
bool	conformingRefinement () const
	return true if grid uses conforming refinement
void	communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir, int level) const
	Communicate information on distributed entities on a given level Template parameter is a model of Dune::CommDataHandleIF. More...
void	communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir) const
	Communicate information on distributed entities on the leaf grid. Template parameter is a model of Dune::CommDataHandleIF.
bool	loadBalance ()
	Re-balances the load each process has to handle for a parallel grid,. More...
bool	loadBalance (DataHandle &data)
	Re-balances the load each process has to handle for a parallel grid,. More...
Traits::template Partition< pitype >::LevelGridView	DUNE_DEPRECATED_MSG ("The method levelView has been renamed to levelGridView.") levelView(int level) const
	View for a grid level.
Traits::template Partition< pitype >::LeafGridView	DUNE_DEPRECATED_MSG ("The method levelView has been renamed to leafGridView.") leafView() const
	View for the leaf grid.
int	overlapSize (int level, int codim) const
	overlapSize is zero by default
int	overlapSize (int codim) const
	overlapSize is zero by default
Adaptivity and grid refinement
int	getMark (const typename Codim< 0 >::Entity &e) const
	returns adaptation mark for given entity More...
bool	mark (int refCount, const typename Codim< 0 >::Entity &e)
	Marks an entity to be refined/coarsened in a subsequent adapt. More...

Protected Types
typedef SizeCache< ThisType >	SizeCacheType
	the type of our size cache

Protected Member Functions
const DuneBoundaryProjectionType *	boundaryProjection (const int segmentIndex) const
	return boudanry projection for given segment Id
bool	nonConform () const
Parallel data distribution and communication
GridImp &	asImp ()
	Barton-Nackman trick.
const GridImp &	asImp () const
	Barton-Nackman trick.

Static Protected Member Functions
static ReturnImplementationType< InterfaceType >::ImplementationType &	getRealImplementation (InterfaceType &i)
	return real implementation of interface class

Protected Attributes
HmeshType *	mygrid_
	the real grid
HierarchicIndexSet	hIndexSet_
	the hierarchic index set
LocalIdSetImp	localIdSet_
	out global id set
std::vector< LevelIndexSetImp * >	levelIndexVec_
	the level index set ( default type )
LeafIndexSetImp *	leafIndexSet_
	the leaf index set

Detailed Description

template<int dimw>
class Dune::ALUCubeGrid< 2, dimw >

constructor for creating ALUSimplexGrid from given macro grid file

Parameters

macroName	filename for macro grid in ALUGrid triangle format
bndProject	global boundary projection pointer
bndVector	pointer to vector holding boundary projection for each boundary segment. ALUGrid takes ownership of this pointer and will delete it in the desctructor
verbose	Whether to write a notice about grid creation to stdout.

Deprecated:

Use ALUGrid< 2, dimw, cube, nonconforming > instead.

[ provides Dune::Grid ]

grid with support for cube mesh in 2d.

Deprecated:

Use ALUGrid< 2, dimw, cube, nonconforming > instead.

Constructor & Destructor Documentation

ALUCubeGrid() [1/3]

template<int dimw>

DUNE_DEPRECATED Dune::ALUCubeGrid< 2, dimw >::ALUCubeGrid ( const std::string  macroName, const DuneBoundaryProjectionType *  bndProject = 0, const DuneBoundaryProjectionVector *  bndVector = 0, const bool  verbose = true  )

inline

constructor for creating ALUSimplexGrid from given macro grid file

Parameters

macroName	filename for macro grid in ALUGrid triangle format
bndProject	global boundary projection pointer
bndVector	pointer to vector holding boundary projection for each boundary segment. ALUGrid takes ownership of this pointer and will delete it in the desctructor
verbose	Whether to write a notice about grid creation to stdout.

Deprecated:

Use ALUGrid< 2, dimw, cube, nonconforming > instead.

ALUCubeGrid() [2/3]

template<int dimw>

DUNE_DEPRECATED Dune::ALUCubeGrid< 2, dimw >::ALUCubeGrid ( const std::string  macroName, std::istream &  macroFile, const DuneBoundaryProjectionType *  bndProject = 0, const DuneBoundaryProjectionVector *  bndVector = 0, const bool  verbose = true  )

inline

constructor for creating ALUSimplexGrid from given macro grid file

Parameters

macroName	filename for macro grid in ALUGrid triangle format
macroFile	Stream to read macro grid file contents from.
bndProject	global boundary projection pointer
bndVector	pointer to vector holding boundary projection for each boundary segment. ALUGrid takes ownership of this pointer and will delete it in the desctructor
verbose	Whether to write a notice about grid creation to stdout.

Deprecated:

Use ALUGrid< 2, dimw, cube, nonconforming > instead.

ALUCubeGrid() [3/3]

template<int dimw>

DUNE_DEPRECATED Dune::ALUCubeGrid< 2, dimw >::ALUCubeGrid ( )

inline

constructor creating empty grid

Deprecated:

Use ALUGrid< 2, dimw, cube, nonconforming > instead.

Member Function Documentation

adapt()

bool Dune::ALU2dGrid< dim, dimworld, eltype >::adapt ( )

inherited

! refine all positive marked leaf entities, return true if a least one entity was refined

communicate()

void Dune::ALU2dGrid< dim, dimworld, eltype >::communicate ( CommDataHandleIF< DataHandleImp, DataTypeImp > &  data, InterfaceType  iftype, CommunicationDirection  dir, int  level  ) const

inherited

Communicate information on distributed entities on a given level Template parameter is a model of Dune::CommDataHandleIF.

Parameters

data	A data handle telling the method what data is communicated and how this should be done.
interface	The communication interface to use.
dir	The direction of the communication along the interface (forward or backward.
level	The index of the grid level where the communication should happen.

getLeafMarker()

ALU2dGridLeafMarkerVectorType& Dune::ALU2dGrid< dim, dimworld, eltype >::getLeafMarker ( ) const

inlineinherited

return reference to vector determing on which element a face is visited

getMark() [1/2]

int Dune::Grid< dim, dimworld, alu2d_ctype , ALU2dGridFamily< dim, dimworld, eltype > >::getMark ( const typename Codim< 0 >::Entity &  e ) const

inlineinherited

returns adaptation mark for given entity

Parameters

[in]

e

Entity for which adaptation mark should be determined

Returns

int adaptation mark currently set for given Entity e

getMark() [2/2]

int Dune::ALU2dGrid< dim, dimworld, eltype >::getMark ( const typename Traits::template Codim< 0 >::Entity &  e ) const

inherited

returns adaptation mark for given entity

Parameters

[in]

e

Entity for which adaptation mark should be determined

Returns

int adaptation mark currently set for given Entity e

getMarkerVector()

ALU2dGridMarkerVector& Dune::ALU2dGrid< dim, dimworld, eltype >::getMarkerVector ( int  level ) const

inlineinherited

return reference to vector telling on which element a face is visted for this level

lbegin()

Traits::template Codim<cd>::template Partition<pitype>::LevelIterator Dune::ALU2dGrid< dim, dimworld, eltype >::lbegin ( int  level ) const

inherited

–Leveliterator Iterator to first entity of given codim on level

loadBalance() [1/2]

bool Dune::ALU2dGrid< dim, dimworld, eltype >::loadBalance ( )

inherited

Re-balances the load each process has to handle for a parallel grid,.

Returns

True if the grid has changed.

loadBalance() [2/2]

bool Dune::ALU2dGrid< dim, dimworld, eltype >::loadBalance ( DataHandle &  data )

inherited

Re-balances the load each process has to handle for a parallel grid,.

Returns

True if the grid has changed.

mark() [1/3]

bool Dune::Grid< dim, dimworld, alu2d_ctype , ALU2dGridFamily< dim, dimworld, eltype > >::mark ( int  refCount, const typename Codim< 0 >::Entity &  e  )

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 that should be marked

Returns

true if Entity was marked, false otherwise.

mark() [2/3]

bool Dune::GridDefaultImplementation< dim, dimworld, alu2d_ctype , ALU2dGridFamily< dim, dimworld, eltype > >::mark ( int  refCount, const typename Traits ::template Codim< 0 >::Entity &  e  )

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

  bool mark( int refCount,
             typename Traits::template Codim<0>::Entity & e ).

  This template method will vanish due to the inheritance rules.

mark() [3/3]

bool Dune::ALU2dGrid< dim, dimworld, eltype >::mark ( int  refCount, const typename Traits::template Codim< 0 >::Entity &  e  )

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	Entity that should be marked

Returns

true if Entity was marked, false otherwise.

maxLevel()

int Dune::ALU2dGrid< dim, dimworld, eltype >::maxLevel ( ) const

inherited

Return maximum level defined in this grid. Levels are numbered 0 ... maxLevel with 0 the coarsest level.

nonConform()

bool Dune::ALU2dGrid< dim, dimworld, eltype >::nonConform ( ) const

inlineprotectedinherited

return true if grid allows hanging nodes on leaf level i.e. returns true for ALUSimplexGrid and returns false for ALUConformGrid

---

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

• dune/grid/alugrid/2d/alugrid.hh