dune-grid  2.7.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Dune::OneDGrid Class Reference

One-dimensional adaptive grid. More...

#include <dune/grid/onedgrid.hh>

Inheritance diagram for Dune::OneDGrid:
Inheritance graph

Public Types

enum  RefinementType { LOCAL, COPY }
 The different forms of grid refinement supported by OneDGrid. More...
 
typedef OneDGridGeometry< 0, 1, OneDGrid >::ctype ctype
 The type used to store coordinates. More...
 
typedef OneDGridFamily GridFamily
 GridFamily of OneDGrid. More...
 
typedef OneDGridFamily::Traits Traits
 

Public Member Functions

 OneDGrid (const std::vector< ctype > &coords)
 Constructor with an explicit set of coordinates. More...
 
 OneDGrid (int numElements, const ctype &leftBoundary, const ctype &rightBoundary)
 Constructor for a uniform grid. More...
 
 ~OneDGrid ()
 Destructor. More...
 
int maxLevel () const
 Return maximum level defined in this grid. More...
 
int size (int level, int codim) const
 Number of grid entities per level and codim. More...
 
int size (int codim) const
 number of leaf entities per codim in this process More...
 
int size (int level, GeometryType type) const
 number of entities per level and geometry type in this process More...
 
int size (GeometryType type) const
 number of leaf entities per geometry type in this process More...
 
size_t numBoundarySegments () const
 Return the number of coarse grid boundary segments. More...
 
const Traits::GlobalIdSetglobalIdSet () const
 Get the set of global ids. More...
 
const Traits::LocalIdSetlocalIdSet () const
 Get the set of local ids. More...
 
const Traits::LevelIndexSetlevelIndexSet (int level) const
 Get an index set for the given level. More...
 
const Traits::LeafIndexSetleafIndexSet () const
 Get an index set for the leaf level. More...
 
bool mark (int refCount, const Traits::Codim< 0 >::Entity &e)
 Mark entity for refinement. More...
 
int getMark (const Traits::Codim< 0 >::Entity &e) const
 return current adaptation marker of given entity More...
 
bool preAdapt ()
 Does nothing except return true if some element has been marked for refinement. More...
 
bool adapt ()
 Triggers the grid refinement process. More...
 
void postAdapt ()
 Adaptation post-processing: Reset all adaptation state flags. More...
 
void setRefinementType (RefinementType type)
 Sets the type of grid refinement. More...
 
void globalRefine (int refCount)
 Does one uniform refinement step. More...
 
const CollectiveCommunication & comm () const
 
Traits::LevelGridView levelGridView (int level) const
 View for a grid level for All_Partition. More...
 
Traits::LeafGridView leafGridView () const
 View for the leaf grid for All_Partition. 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, i.e. here the default implementation returns 0. More...
 
bool loadBalance ()
 default implementation of load balance does nothing and returns false More...
 
bool loadBalance (DataHandle &data)
 default implementation of load balance does nothing and returns false More...
 

Static Public Member Functions

template<typename Seed >
static Traits::template Codim< Seed::codimension >::Entity entity (const Seed &seed)
 Create an Entity from an EntitySeed. More...
 

Protected Member Functions

 DUNE_DEPRECATED_MSG ("use the facade class' `impl()` method instead") static typename std
 return real implementation of interface class More...
 

Detailed Description

One-dimensional adaptive grid.

[ provides Dune::Grid ]

This implementation of the grid interface provides one-dimensional grids only. The OneDGrid can be nonuniform and provides local mesh refinement and coarsening.

Member Typedef Documentation

◆ ctype

The type used to store coordinates.

◆ GridFamily

GridFamily of OneDGrid.

◆ Traits

Member Enumeration Documentation

◆ RefinementType

The different forms of grid refinement supported by OneDGrid.

Enumerator
LOCAL 

New level consists only of the refined elements.

COPY 

New level consists of the refined elements and the unrefined ones, too.

Constructor & Destructor Documentation

◆ OneDGrid() [1/2]

Dune::OneDGrid::OneDGrid ( const std::vector< ctype > &  coords)

Constructor with an explicit set of coordinates.

◆ OneDGrid() [2/2]

Dune::OneDGrid::OneDGrid ( int  numElements,
const ctype leftBoundary,
const ctype rightBoundary 
)

Constructor for a uniform grid.

◆ ~OneDGrid()

Dune::OneDGrid::~OneDGrid ( )

Destructor.

Member Function Documentation

◆ adapt()

bool Dune::OneDGrid::adapt ( )

Triggers the grid refinement process.

◆ comm()

const CollectiveCommunication& Dune::OneDGrid::comm ( ) const
inline

◆ DUNE_DEPRECATED_MSG()

Dune::GridDefaultImplementation< dim, dimworld, OneDGridGeometry< 0, 1, OneDGrid >::ctype , OneDGridFamily >::DUNE_DEPRECATED_MSG ( "use the facade class' `impl()` method instead"  )
inlineprotectedinherited

return real implementation of interface class

◆ entity()

template<typename Seed >
static Traits::template Codim<Seed::codimension>::Entity Dune::OneDGrid::entity ( const Seed &  seed)
inlinestatic

Create an Entity from an EntitySeed.

◆ getMark() [1/2]

int Dune::OneDGrid::getMark ( const Traits::Codim< 0 >::Entity e) const

return current adaptation marker of given entity

Parameters
eEntity to the entity you want to mark
Returns
int current adaptation marker of entity pointer e

◆ getMark() [2/2]

int Dune::GridDefaultImplementation< dim, dimworld, OneDGridGeometry< 0, 1, OneDGrid >::ctype , OneDGridFamily >::getMark ( const typename Traits::template Codim< 0 >::Entity e) const
inlineinherited

returns adaptation mark for given entity, i.e. here the default implementation returns 0.

Parameters
[in]eEntity for which adaptation mark should be determined
Returns
int adaptation mark, here the default value 0 is returned

◆ globalIdSet()

const Traits::GlobalIdSet& Dune::OneDGrid::globalIdSet ( ) const
inline

Get the set of global ids.

◆ globalRefine()

void Dune::OneDGrid::globalRefine ( int  refCount)

Does one uniform refinement step.

Parameters
refCountI don't know what this is good for. It doesn't actually do anything.

◆ leafGridView()

Traits::LeafGridView Dune::GridDefaultImplementation< dim, dimworld, OneDGridGeometry< 0, 1, OneDGrid >::ctype , OneDGridFamily >::leafGridView
inlineinherited

View for the leaf grid for All_Partition.

◆ leafIndexSet()

const Traits::LeafIndexSet& Dune::OneDGrid::leafIndexSet ( ) const
inline

Get an index set for the leaf level.

◆ levelGridView()

Traits::LevelGridView Dune::GridDefaultImplementation< dim, dimworld, OneDGridGeometry< 0, 1, OneDGrid >::ctype , OneDGridFamily >::levelGridView ( int  level) const
inlineinherited

View for a grid level for All_Partition.

◆ levelIndexSet()

const Traits::LevelIndexSet& Dune::OneDGrid::levelIndexSet ( int  level) const
inline

Get an index set for the given level.

◆ loadBalance() [1/2]

bool Dune::GridDefaultImplementation< dim, dimworld, OneDGridGeometry< 0, 1, OneDGrid >::ctype , OneDGridFamily >::loadBalance
inlineinherited

default implementation of load balance does nothing and returns false

◆ loadBalance() [2/2]

bool Dune::GridDefaultImplementation< dim, dimworld, OneDGridGeometry< 0, 1, OneDGrid >::ctype , OneDGridFamily >::loadBalance ( DataHandle &  data)
inlineinherited

default implementation of load balance does nothing and returns false

◆ localIdSet()

const Traits::LocalIdSet& Dune::OneDGrid::localIdSet ( ) const
inline

Get the set of local ids.

◆ mark() [1/2]

bool Dune::OneDGrid::mark ( int  refCount,
const Traits::Codim< 0 >::Entity e 
)

Mark entity for refinement.

Parameters
refCountif >0 mark for refinement, if <0 mark for coarsening
eEntity to the entity you want to mark
Returns
True, if marking was successful

◆ mark() [2/2]

bool Dune::GridDefaultImplementation< dim, dimworld, OneDGridGeometry< 0, 1, OneDGrid >::ctype , OneDGridFamily >::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]refCountNumber of subdivisions that should be applied. Negative value means coarsening.
[in]eEntity 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.

◆ maxLevel()

int Dune::OneDGrid::maxLevel ( ) const
inline

Return maximum level defined in this grid.

Levels are numbered 0 ... maxlevel with 0 the coarsest level.

◆ numBoundarySegments()

size_t Dune::OneDGrid::numBoundarySegments ( ) const
inline

Return the number of coarse grid boundary segments.

For this grid implementation, the return value is always 2, because only connected domains are supported, and then the coarse grid boundary consists of two points.

◆ postAdapt()

void Dune::OneDGrid::postAdapt ( )

Adaptation post-processing: Reset all adaptation state flags.

◆ preAdapt()

bool Dune::OneDGrid::preAdapt ( )

Does nothing except return true if some element has been marked for refinement.

◆ setRefinementType()

void Dune::OneDGrid::setRefinementType ( RefinementType  type)
inline

Sets the type of grid refinement.

◆ size() [1/4]

int Dune::OneDGrid::size ( GeometryType  type) const
inline

number of leaf entities per geometry type in this process

◆ size() [2/4]

int Dune::OneDGrid::size ( int  codim) const
inline

number of leaf entities per codim in this process

◆ size() [3/4]

int Dune::OneDGrid::size ( int  level,
GeometryType  type 
) const
inline

number of entities per level and geometry type in this process

◆ size() [4/4]

int Dune::OneDGrid::size ( int  level,
int  codim 
) const
inline

Number of grid entities per level and codim.


The documentation for this class was generated from the following file:
Dune::OneDGrid::mark
bool mark(int refCount, const Traits::Codim< 0 >::Entity &e)
Mark entity for refinement.