Dune::Fem::AdaptationMethod< GridType > Class Template Reference

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

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

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 More...
virtual	~AdaptationMethod ()
	virtual destructor
virtual const char *	methodName () const
	returns name of adaptation method More...
virtual bool	adaptive () const
	returns true if adaptation manager as adaptation method different to NONE More...
virtual bool	isCallBackAdaptation () const
	return true if callback adaptation is used. More...
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 More...
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

grid	Grid that adaptation method is read for

References Dune::Fem::AdaptationMethod< GridType >::defaultMethod, and Dune::Fem::Parameter::verbose().

Member Function Documentation

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.

References Dune::Fem::AdaptationMethod< GridType >::adaptationMethod_, and Dune::Fem::AdaptationMethod< GridType >::none.

balanceCounter()

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

inlinevirtualinherited

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

References Dune::Fem::AdaptationManagerInterface::balanceCounter().

Referenced by Dune::Fem::AdaptationManagerInterface::balanceCounter().

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.

References Dune::Fem::AdaptationMethod< GridType >::adaptationMethod_, and Dune::Fem::AdaptationMethod< GridType >::callback.

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 >, Dune::Fem::AdaptationManager< GridType, RestProlOperatorImp >, and Dune::Fem::hpDG::AdaptationManager< DiscreteFunctionSpace, DataProjection >.

References Dune::Fem::AdaptationManagerInterface::loadBalance().

Referenced by Dune::Fem::AdaptationManagerInterface::loadBalance().

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.

References Dune::Fem::AdaptationMethod< GridType >::adaptationMethod_, Dune::Fem::AdaptationMethod< GridType >::callback, and Dune::Fem::AdaptationMethod< GridType >::none.

---

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

• dune/fem/space/common/adaptationmanager.hh