dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::Fem::AdaptationMethod< GridType > Class Template Reference

AdaptationMethod is a simple adaptation method reader class. More...

#include <dune/fem/space/common/adaptationmanager.hh>

Inheritance diagram for Dune::Fem::AdaptationMethod< GridType >:
Inheritance graph

Public Types

enum  AdaptationMethodType { none = 0 , generic = 1 , callback = 2 }
 type of adaptation method More...
 

Public Member Functions

 AdaptationMethod (const GridType &grid, const ParameterReader &parameter=Parameter::container())
 constructor of AdaptationMethod The following optional parameters are used
 
virtual ~AdaptationMethod ()
 virtual destructor
 
virtual const char * methodName () const
 returns name of adaptation method
 
virtual bool adaptive () const
 returns true if adaptation manager as adaptation method different to NONE
 
virtual void adapt ()
 on call of this method the internal adaptation operator is called.
 
virtual bool loadBalance ()
 call load balance, returns true if grid was changed
 
virtual int balanceCounter () const
 
virtual double adaptationTime () const
 time that last adaptation cycle took
 
virtual double loadBalanceTime () const
 time that last load balance cycle took
 

Protected Attributes

AdaptationMethodType adaptationMethod_
 method identifier
 

Detailed Description

template<class GridType>
class Dune::Fem::AdaptationMethod< GridType >

AdaptationMethod is a simple adaptation method reader class.

Member Enumeration Documentation

◆ AdaptationMethodType

template<class GridType >
enum Dune::Fem::AdaptationMethod::AdaptationMethodType

type of adaptation method

Enumerator
none 

no adaptation is performed

generic 

a generic restriction and prolongation algorithm is used

callback 

the callback mechanism from AlbertaGrid and ALUGrid is used

Constructor & Destructor Documentation

◆ AdaptationMethod()

template<class GridType >
Dune::Fem::AdaptationMethod< GridType >::AdaptationMethod ( const GridType &  grid,
const ParameterReader parameter = Parameter::container() 
)
inline

constructor of AdaptationMethod The following optional parameters are used

0 == none, 1 == generic, 2 == call back (only AlbertaGrid and ALUGrid)

AdaptationMethod: 1 # default value

Parameters
gridGrid that adaptation method is read for

◆ ~AdaptationMethod()

template<class GridType >
virtual Dune::Fem::AdaptationMethod< GridType >::~AdaptationMethod ( )
inlinevirtual

virtual destructor

Member Function Documentation

◆ adapt()

virtual void Dune::Fem::AdaptationManagerInterface::adapt ( )
inlinevirtualinherited

◆ adaptationTime()

virtual double Dune::Fem::AdaptationManagerInterface::adaptationTime ( ) const
inlinevirtualinherited

◆ adaptive()

template<class GridType >
virtual bool Dune::Fem::AdaptationMethod< GridType >::adaptive ( ) const
inlinevirtual

returns true if adaptation manager as adaptation method different to NONE

Returns
true if adaptation method is not NONE, false otherwise

Reimplemented from Dune::Fem::AdaptationManagerInterface.

◆ balanceCounter()

virtual int Dune::Fem::AdaptationManagerInterface::balanceCounter ( ) const
inlinevirtualinherited

◆ loadBalance()

virtual bool Dune::Fem::AdaptationManagerInterface::loadBalance ( )
inlinevirtualinherited

◆ loadBalanceTime()

virtual double Dune::Fem::LoadBalancerInterface::loadBalanceTime ( ) const
inlinevirtualinherited

◆ methodName()

template<class GridType >
virtual const char * Dune::Fem::AdaptationMethod< GridType >::methodName ( ) const
inlinevirtual

returns name of adaptation method

Returns
name of adaptation method

Reimplemented from Dune::Fem::AdaptationManagerInterface.

Member Data Documentation

◆ adaptationMethod_

template<class GridType >
AdaptationMethodType Dune::Fem::AdaptationMethod< GridType >::adaptationMethod_
protected

method identifier


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