Class that takes care of the transfer of data (of each FunctionSpaceElement) after modification of the grid. More...
#include <gridmanager.hh>
Detailed Description
class Kaskade::GridManager< Grd >
Class that takes care of the transfer of data (of each FunctionSpaceElement) after modification of the grid.
Class that owns a grid. It takes care that all grid functions stay consistent, when the grid is refined. A Gridmanager<Grid> is constructed with a GridPointer<Grid>, a std::unique_ptr<Grid>&& or an r-value reference on a Grid*. After this, all modifications on the grid have to be done via the GridManager, in particular refinement. If the grid is refined, the GridManager sends a boost::signal to each FEFunctionSpace, which themselves send a boost::signal to each FunctionSpaceElement, such that their transfer from one grid to the other is organized.
The grid manager can print status and progress information to std::cout, see setVerbosity.
Examples for usage
- Construction
* Dune::GridPtr<Grid> gridptr("MyDomain.dgf");
* GridManager<Grid> gm(gridptr);
* - Alternative construction
* std::unique_ptr<Grid> gridptr(new ...); * GridManager<Grid> gm(gridptr); *
- Construction of FEFunctionSpaces with GridManager:
* MySpace mySpace(gm,gm.grid().leafIndexSet(),order) //instead of: MySpace mySpace(grid,grid().leafIndexSet(),order) *
- Uniform Refinement:
* gm.globalRefine(nTimes) //instead of: grid.globalRefine(nTimes) *
Cf. detailed description of averaging_errorest.hh
Definition at line 679 of file gridmanager.hh.
Public Types | |
| typedef Grd | Grid |
| typedef GridManagerBase< Grid > | Self |
Public Member Functions | |
| GridManager (Dune::GridPtr< Grid > grid_, bool verbose=false) | |
| Construction from a GridPtr<Grid> More... | |
| GridManager (std::unique_ptr< Grid > &&grid_, bool verbose=false) | |
| Construction from a unique_ptr<Grid> More... | |
| GridManager (Grid *&&grid_, bool verbose=false) | |
| Construction from a Grid*. More... | |
| virtual void | update () |
| Must be overloaded by derived classes to adjust internal state immediately after mesh refinement. More... | |
| Self & | enforceConcurrentReads (bool enforceConcurrentReads) |
| Tells the grid manager that concurrent reads of the grid are safe. More... | |
| Self & | setVerbosity (const bool verbosity) |
| sets the verbosity level of the grid manager More... | |
| bool | gridIsThreadSafe () const |
| Returns true if concurrent read accesses to the grid do not lead to data races. More... | |
| CellRanges< typename Grid::LeafGridView > const & | cellRanges (typename Grid::LeafGridView const &) const |
| Returns a CellRanges object for the given grid view. The cell ranges are created on demand. The reference is valid up to the next mesh modification. This method is thread-safe. More... | |
| CellRanges< typename Grid::LevelGridView > const & | cellRanges (typename Grid::LevelGridView const &gridView) const |
| Returns a CellRanges object for the given grid view. More... | |
| EntityNumbering< typename Grid::LeafGridView > const & | entityNumbering (typename Grid::LeafGridView const &) const |
| Returns an EntityNumbering object for the given grid view. More... | |
Access to the managed grid. | |
| Grid const & | grid () const |
| Returns a const reference on the owned grid. More... | |
| Grid & | grid_non_const () |
| Returns a non-const reference on the owned grid. More... | |
| std::shared_ptr< Grid const > | gridShared () const |
| Provides shared ownership management. More... | |
Grid adaptation | |
| bool | mark (int refCount, typename Grid::template Codim< 0 >::Entity const &cell) |
| Marks the given cell for refinement or coarsening. More... | |
| template<class S > | |
| void | mark (CellData< Grid, S > const &cellData) |
| Marks all Entities of a grid according to the corresponding entries in a CellData. More... | |
| size_t | countMarked () const |
| Reports the number of marked elements. More... | |
| bool | preAdapt () |
| Calls grid.preAdapt(). More... | |
| void | postAdapt () |
| Calls grid.postAdapt(). More... | |
| bool | adaptAtOnce () |
| DEPRECATED Performs grid refinement without prolongating registered FE functions. More... | |
| void | flushMarks () |
| Remove all cell marks from the grid. More... | |
| bool | adapt () |
| Refines each marked leaf cell of the grid and prolongates registered FE functions to the new leaf grid view. More... | |
| void | globalRefine (int refCount) |
| Refines each leaf cell of the grid and prolongates registered FE functions to the new leaf grid view. More... | |
Public Attributes | |
| GridSignals | signals |
Protected Member Functions | |
| void | beforeRefinement () |
| void | afterRefinement () |
Protected Attributes | |
| std::shared_ptr< Grid > | gridptr |
| The grid itself. More... | |
| bool | verbose |
Member Typedef Documentation
◆ Grid
| typedef Grd Kaskade::GridManager< Grd >::Grid |
Definition at line 682 of file gridmanager.hh.
◆ Self
|
inherited |
Definition at line 268 of file gridmanager.hh.
Constructor & Destructor Documentation
◆ GridManager() [1/3]
|
inlineexplicit |
Construction from a GridPtr<Grid>
Construct a GridManager<Grid> from a GridPointer<Grid>. The ownership of the grid is transferred to the GridManager. Afterwards the grid can only be modified via the GridManager.
Definition at line 688 of file gridmanager.hh.
◆ GridManager() [2/3]
|
inlineexplicit |
Construction from a unique_ptr<Grid>
Construct a GridManager<Grid> from a std::unique_ptr<Grid>. The ownership of the grid is transferred to the GridManager. Afterwards the grid can only be modified via the GridManager.
Definition at line 697 of file gridmanager.hh.
◆ GridManager() [3/3]
|
inlineexplicit |
Construction from a Grid*.
Construct a GridManager<Grid> from a std::unique_ptr<Grid>. The ownership of the grid is transferred to the GridManager. Afterwards the grid can only be modified via the GridManager.
Definition at line 706 of file gridmanager.hh.
Member Function Documentation
◆ adapt()
|
inlineinherited |
Refines each marked leaf cell of the grid and prolongates registered FE functions to the new leaf grid view.
Definition at line 413 of file gridmanager.hh.
Referenced by Kaskade::Bridge::AdaptiveGrid< GridManager, Estimate >::adapt(), and Kaskade::GridManagerBase< Grd >::adaptAtOnce().
◆ adaptAtOnce()
|
inlineinherited |
DEPRECATED Performs grid refinement without prolongating registered FE functions.
As this can easily lead to inconsistent states of FE functions, usage is not recommended. Probably this method will be removed soon.
Definition at line 390 of file gridmanager.hh.
Referenced by Kaskade::coarsening(), Kaskade::markAndRefine(), Kaskade::refineAtBoundary(), Kaskade::Adaptivity::FixedCellFraction< Grid >::refineGrid_impl(), Kaskade::Adaptivity::FixedErrorFraction< Grid >::refineGrid_impl(), Kaskade::Adaptivity::ErrorEquilibration2< Grid >::refineGrid_impl(), Kaskade::Adaptivity::ErrorEquilibration< Grid >::refineGrid_impl(), and Kaskade::Limex< Eq >::step().
◆ afterRefinement()
|
inlineprotectedinherited |
Definition at line 595 of file gridmanager.hh.
Referenced by Kaskade::GridManagerBase< Grd >::adapt(), and Kaskade::GridManagerBase< Grd >::globalRefine().
◆ beforeRefinement()
|
inlineprotectedinherited |
Definition at line 583 of file gridmanager.hh.
Referenced by Kaskade::GridManagerBase< Grd >::adapt(), and Kaskade::GridManagerBase< Grd >::globalRefine().
◆ cellRanges() [1/2]
|
inlineinherited |
Returns a CellRanges object for the given grid view. The cell ranges are created on demand. The reference is valid up to the next mesh modification. This method is thread-safe.
Definition at line 531 of file gridmanager.hh.
Referenced by Kaskade::VariationalFunctionalAssembler< F, SparseIndex, BoundaryDetector, QuadRule >::assemble().
◆ cellRanges() [2/2]
|
inlineinherited |
Returns a CellRanges object for the given grid view.
- Parameters
-
gridView a level grid view of the grid managed by this grid manager
The cell ranges are created on demand. The reference is valid up to the next mesh modification. This method is thread-safe.
Definition at line 547 of file gridmanager.hh.
◆ countMarked()
|
inlineinherited |
Reports the number of marked elements.
Definition at line 359 of file gridmanager.hh.
◆ enforceConcurrentReads()
|
inlineinherited |
Tells the grid manager that concurrent reads of the grid are safe.
Definition at line 484 of file gridmanager.hh.
Referenced by Kaskade::GridManagerBase< Grd >::enforceConcurrentReads().
◆ entityNumbering()
|
inlineinherited |
Returns an EntityNumbering object for the given grid view.
- Todo:
- allow to specify the sorting
Definition at line 563 of file gridmanager.hh.
◆ flushMarks()
|
inlineinherited |
Remove all cell marks from the grid.
Definition at line 402 of file gridmanager.hh.
Referenced by Kaskade::Bridge::AdaptiveGrid< GridManager, Estimate >::flushMarks(), and Kaskade::GridManagerBase< Grd >::mark().
◆ globalRefine()
|
inlineinherited |
Refines each leaf cell of the grid and prolongates registered FE functions to the new leaf grid view.
Definition at line 449 of file gridmanager.hh.
◆ grid()
|
inlineinherited |
Returns a const reference on the owned grid.
Definition at line 292 of file gridmanager.hh.
Referenced by Kaskade::GridManagerBase< Grd >::afterRefinement(), Kaskade::AmiraMeshReader::boundaryConditionsToScalarField(), Kaskade::GridManagerBase< Grd >::cellRanges(), Kaskade::coarsening(), LossyStorage< Grid, VariableSet, Space, QuantizationPolicy >::decode(), LossyStorage< Grid, VariableSet, Space, QuantizationPolicy >::encode(), Kaskade::GridManagerBase< Grd >::entityNumbering(), LossyStorage< Grid, VariableSet, Space, QuantizationPolicy >::flush(), Kaskade::Giant< Grid, Equation, VariableSet, Spaces >::giantGbit(), Kaskade::FEFunctionSpace< LocalToGlobalMapper >::grid(), LossyStorage< Grid, VariableSet, Space, QuantizationPolicy >::LossyStorage(), Kaskade::makeAuxiliarySpaceMultigridStack(), Kaskade::markCells(), MultilevelTransfer< Space, Grid >::MultilevelTransfer(), Kaskade::NleqSolver< Grid, Equation, VariableSet, Spaces >::nleqErr(), MultilevelTransfer< Space, Grid >::out(), Kaskade::refineAtBoundary(), Kaskade::Adaptivity::FixedCellFraction< Grid >::refineGrid_impl(), Kaskade::Adaptivity::FixedErrorFraction< Grid >::refineGrid_impl(), Kaskade::Adaptivity::ErrorEquilibration2< Grid >::refineGrid_impl(), Kaskade::Adaptivity::ErrorEquilibration< Grid >::refineGrid_impl(), Kaskade::Bridge::AdaptiveGrid< GridManager, Estimate >::size(), Kaskade::Limex< Eq >::step(), and Kaskade::CheckPoint::writeGrid().
◆ grid_non_const()
|
inlineinherited |
Returns a non-const reference on the owned grid.
Definition at line 298 of file gridmanager.hh.
◆ gridIsThreadSafe()
|
inlineinherited |
Returns true if concurrent read accesses to the grid do not lead to data races.
This is either the case if the grid implementation itself reports that it's thread-safe, or if the user has explicitly stated that concurrent reads are safe (using enforceConcurrentReads) - even if they actually are not.
The thread-safety reported by this method is used e.g. by the assembler to decide how many threads to use during assembly.
If the grid access may not be thread-safe, consider using GridLocking.
Definition at line 516 of file gridmanager.hh.
Referenced by Kaskade::VariationalFunctionalAssembler< F, SparseIndex, BoundaryDetector, QuadRule >::assemble().
◆ gridShared()
|
inlineinherited |
Provides shared ownership management.
Note that only an immutable grid is provided, such that the responsibility for grid modifications remains with the GridManager object. This is necessary for the GridManager to trigger prolongation/interpolation on grid modification.
Definition at line 310 of file gridmanager.hh.
◆ mark() [1/2]
|
inlineinherited |
Marks all Entities of a grid according to the corresponding entries in a CellData.
Definition at line 342 of file gridmanager.hh.
◆ mark() [2/2]
|
inlineinherited |
Marks the given cell for refinement or coarsening.
- Parameters
-
refCount if positive, marks for (multiple) refinement; if negative, for (multiple) coarsening. Not every grid implementation accepts multiple refinement/coarsening. cell the affected cell
Definition at line 330 of file gridmanager.hh.
Referenced by Kaskade::coarsening(), Kaskade::GridManagerBase< Grd >::flushMarks(), Kaskade::Bridge::AdaptiveGrid< GridManager, Estimate >::mark(), Kaskade::GridManagerBase< Grd >::mark(), Kaskade::markAndRefine(), Kaskade::markCells(), Kaskade::refineAtBoundary(), Kaskade::Adaptivity::FixedCellFraction< Grid >::refineGrid_impl(), Kaskade::Adaptivity::FixedErrorFraction< Grid >::refineGrid_impl(), Kaskade::Adaptivity::ErrorEquilibration2< Grid >::refineGrid_impl(), Kaskade::Adaptivity::ErrorEquilibration< Grid >::refineGrid_impl(), Kaskade::Limex< Eq >::step(), and Kaskade::uniformEmbeddedErrorEstimation().
◆ postAdapt()
|
inlineinherited |
Calls grid.postAdapt().
Definition at line 374 of file gridmanager.hh.
Referenced by Kaskade::Bridge::AdaptiveGrid< GridManager, Estimate >::adapt(), and Kaskade::GridManagerBase< Grd >::adaptAtOnce().
◆ preAdapt()
|
inlineinherited |
Calls grid.preAdapt().
Definition at line 365 of file gridmanager.hh.
Referenced by Kaskade::Bridge::AdaptiveGrid< GridManager, Estimate >::adapt(), and Kaskade::GridManagerBase< Grd >::adaptAtOnce().
◆ setVerbosity()
|
inlineinherited |
sets the verbosity level of the grid manager
The grid manager prints status and progress information to std::cout. The amount of information depends on the verbosity:
- 0: no messages are printed
- 1: mesh size change on refinement is reported
Definition at line 499 of file gridmanager.hh.
Referenced by Kaskade::Limex< Eq >::step().
◆ update()
|
inlinevirtual |
Must be overloaded by derived classes to adjust internal state immediately after mesh refinement.
Implements Kaskade::GridManagerBase< Grd >.
Definition at line 711 of file gridmanager.hh.
Member Data Documentation
◆ gridptr
|
protectedinherited |
The grid itself.
Definition at line 608 of file gridmanager.hh.
Referenced by Kaskade::GridManagerBase< Grd >::adapt(), Kaskade::GridManagerBase< Grd >::flushMarks(), Kaskade::GridManagerBase< Grd >::grid(), Kaskade::GridManagerBase< Grd >::grid_non_const(), Kaskade::GridManagerBase< Grd >::gridShared(), Kaskade::GridManagerBase< Grd >::mark(), Kaskade::GridManagerBase< Grd >::postAdapt(), and Kaskade::GridManagerBase< Grd >::preAdapt().
◆ signals
|
inherited |
Definition at line 611 of file gridmanager.hh.
Referenced by Kaskade::Bridge::AdaptiveGrid< GridManager, Estimate >::AdaptiveGrid(), Kaskade::GridManagerBase< Grd >::afterRefinement(), Kaskade::GridManagerBase< Grd >::beforeRefinement(), Kaskade::FEFunctionSpace< LocalToGlobalMapper >::FEFunctionSpace(), HierarchicIndexSet< Grid >::HierarchicIndexSet(), and HierarchicIndexSet< Grid >::operator=().
◆ verbose
|
protectedinherited |
Definition at line 626 of file gridmanager.hh.
Referenced by Kaskade::GridManagerBase< Grd >::adapt(), Kaskade::GridManagerBase< Grd >::postAdapt(), and Kaskade::GridManagerBase< Grd >::setVerbosity().
The documentation for this class was generated from the following file:
