dune-fem 2.12-git
Loading...
Searching...
No Matches
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(), const bool noOutput=false)
 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 bool isCallBackAdaptation () const
 return true if callback adaptation is used.
 
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
 

Static Public Attributes

static const int defaultMethod = 1
 default method is generic
 

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(),
const bool  noOutput = false 
)
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

on call of this method the internal adaptation operator is called.

Reimplemented in Dune::Fem::AdaptationManagerBase< GridType, RestProlOperatorImp >, and Dune::Fem::AdaptationManager< GridType, RestProlOperatorImp >.

◆ adaptationTime()

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

time that last adaptation cycle took

Reimplemented in Dune::Fem::AdaptationManagerBase< GridType, RestProlOperatorImp >.

◆ 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

◆ isCallBackAdaptation()

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

return true if callback adaptation is used.

Reimplemented from Dune::Fem::AdaptationManagerInterface.

◆ loadBalance()

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

call load balance, returns true if grid was changed

Returns
true if grid was changed, false otherwise

Implements Dune::Fem::LoadBalancerInterface.

Reimplemented in Dune::Fem::AdaptationManagerBase< GridType, RestProlOperatorImp >, and Dune::Fem::AdaptationManager< GridType, RestProlOperatorImp >.

◆ loadBalanceTime()

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

time that last load balance cycle took

Reimplemented in Dune::Fem::AdaptationManager< GridType, RestProlOperatorImp >, and Dune::Fem::LoadBalancer< GridType >.

◆ 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

◆ defaultMethod

template<class GridType >
const int Dune::Fem::AdaptationMethod< GridType >::defaultMethod = 1
static

default method is generic


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