3.3.0
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::GridAdaptionIndicator2PLocal< TypeTag > Class Template Reference

Class defining a standard, saturation dependent indicator for grid adaption. More...

#include <dumux/porousmediumflow/2p/sequential/impes/gridadaptionindicatorlocal.hh>

Description

template<class TypeTag>
class Dumux::GridAdaptionIndicator2PLocal< TypeTag >

Class defining a standard, saturation dependent indicator for grid adaption.

Template Parameters
TypeTagThe problem TypeTag

Public Member Functions

void calculateIndicator ()
 Calculates the indicator used for refinement/coarsening for each grid cell. More...
 
bool refine (const Element &element)
 Indicator function for marking of grid cells for refinement. More...
 
bool coarsen (const Element &element)
 Indicator function for marking of grid cells for coarsening. More...
 
void init ()
 Initializes the adaption indicator class. More...
 
void setIndicatorToRefine (int idx)
 Function for changing the indicatorVector values for refinement. More...
 
void setIndicatorToCoarse (int idx)
 Function for changing the indicatorVector values for coarsening. More...
 
 GridAdaptionIndicator2PLocal (Problem &problem)
 Constructs a GridAdaptionIndicator instance. More...
 

Constructor & Destructor Documentation

◆ GridAdaptionIndicator2PLocal()

template<class TypeTag >
Dumux::GridAdaptionIndicator2PLocal< TypeTag >::GridAdaptionIndicator2PLocal ( Problem &  problem)
inline

Constructs a GridAdaptionIndicator instance.

This standard indicator is based on the saturation gradient. It checks the local gradient compared to the maximum global gradient. The indicator is compared locally to a refinement/coarsening threshold to decide whether a cell should be marked for refinement or coarsening or should not be adapted.

Parameters
problemThe problem object

Member Function Documentation

◆ calculateIndicator()

template<class TypeTag >
void Dumux::GridAdaptionIndicator2PLocal< TypeTag >::calculateIndicator ( )
inline

Calculates the indicator used for refinement/coarsening for each grid cell.

This standard indicator is based on the saturation gradient.

◆ coarsen()

template<class TypeTag >
bool Dumux::GridAdaptionIndicator2PLocal< TypeTag >::coarsen ( const Element &  element)
inline

Indicator function for marking of grid cells for coarsening.

Returns true if an element should be coarsened.

Parameters
elementA grid element

◆ init()

template<class TypeTag >
void Dumux::GridAdaptionIndicator2PLocal< TypeTag >::init ( )
inline

Initializes the adaption indicator class.

◆ refine()

template<class TypeTag >
bool Dumux::GridAdaptionIndicator2PLocal< TypeTag >::refine ( const Element &  element)
inline

Indicator function for marking of grid cells for refinement.

Returns true if an element should be refined.

Parameters
elementA grid element

◆ setIndicatorToCoarse()

template<class TypeTag >
void Dumux::GridAdaptionIndicator2PLocal< TypeTag >::setIndicatorToCoarse ( int  idx)
inline

Function for changing the indicatorVector values for coarsening.

Parameters
idxIndex of cell which may be coarsen

◆ setIndicatorToRefine()

template<class TypeTag >
void Dumux::GridAdaptionIndicator2PLocal< TypeTag >::setIndicatorToRefine ( int  idx)
inline

Function for changing the indicatorVector values for refinement.

Parameters
idxIndex of cell which may be refined

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