Dune::Fem::TimeProviderBase Class Reference

general base for time providers More...

#include <dune/fem/solver/timeprovider.hh>

Inheritance diagram for Dune::Fem::TimeProviderBase:

Public Member Functions
	TimeProviderBase (const ParameterReader &parameter=Parameter::container())
	TimeProviderBase (const double startTime, const ParameterReader &parameter=Parameter::container())
virtual	~TimeProviderBase ()
void	backup () const
	backup persistent object
void	restore ()
	restore persistent object
	TimeProviderBase (const ThisType &)=delete
ThisType &	operator= (const ThisType &)=delete
double	time () const
	obtain the current time
int	timeStep () const
	obtain number of the current time step
double	deltaT () const
	obtain the size of the current time step
double	inverseDeltaT () const
	obtain the size of the inverse of the current time step
double	timeStepEstimate () const
	obtain current estimate on time step
void	provideTimeStepEstimate (const double dtEstimate)
	set time step estimate to minimum of given value and internal time step estiamte
void	provideTimeStepUpperBound (const double upperBound)
	set upper bound for time step to minimum of given value and internal bound
void	invalidateTimeStep ()
	count current time step a not valid
bool	timeStepValid () const
	return if this time step should be used

Protected Member Functions
void	advance ()
void	initTimeStepEstimate ()
virtual void	insertSubData ()
	insert possible sub data of object
virtual void	removeSubData ()
	remove possible sub data of object
virtual void *	pointer ()

Protected Attributes
double	time_
int	timeStep_
double	dt_
double	invdt_
bool	valid_
bool	dtEstimateValid_
double	dtEstimate_
double	dtUpperBound_
ParameterReader	parameter_

Detailed Description

general base for time providers

This class consists of the methods required for example in the ODE Solvers, e.g., provideTimeStepEstimate and provideTimeStepUpperBound. InvalidateTimeStep can be used to mark this time step as invalid. Furthermore, method for accessing the simulation time, the time step counter and the time step size are provided.

The derived class TimeProvider provides the additional method required for implementing a time loop.

Constructor & Destructor Documentation

TimeProviderBase() [1/3]

Dune::Fem::TimeProviderBase::TimeProviderBase ( const ParameterReader &  parameter = Parameter::container() )

inline

TimeProviderBase() [2/3]

Dune::Fem::TimeProviderBase::TimeProviderBase ( const double  startTime, const ParameterReader &  parameter = Parameter::container()  )

inlineexplicit

~TimeProviderBase()

virtual Dune::Fem::TimeProviderBase::~TimeProviderBase ( )

inlinevirtual

TimeProviderBase() [3/3]

Dune::Fem::TimeProviderBase::TimeProviderBase ( const ThisType &  )

delete

Member Function Documentation

advance()

void Dune::Fem::TimeProviderBase::advance ( )

inlineprotected

backup()

void Dune::Fem::TimeProviderBase::backup ( ) const

inlinevirtual

backup persistent object

Implements Dune::Fem::PersistentObject.

deltaT()

double Dune::Fem::TimeProviderBase::deltaT ( ) const

inline

obtain the size of the current time step

Returns

the size of the current time step

initTimeStepEstimate()

void Dune::Fem::TimeProviderBase::initTimeStepEstimate ( )

inlineprotected

insertSubData()

virtual void Dune::Fem::PersistentObject::insertSubData ( )

inlineprotectedvirtualinherited

insert possible sub data of object

Reimplemented in Dune::Fem::DiscreteFunctionDefault< Impl >, Dune::Fem::DiscreteFunctionDefault< AdaptiveDiscreteFunction< DiscreteFunctionSpace > >, Dune::Fem::DiscreteFunctionDefault< BlockVectorDiscreteFunction< DiscreteFunctionSpace, BlockVector > >, Dune::Fem::DiscreteFunctionDefault< CombinedDiscreteFunction< ContainedDiscreteFunctionImp, N > >, Dune::Fem::DiscreteFunctionDefault< HierarchicalDiscreteFunction< DiscreteFunctionSpace > >, Dune::Fem::DiscreteFunctionDefault< ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block > >, Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >, and Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >.

invalidateTimeStep()

void Dune::Fem::TimeProviderBase::invalidateTimeStep ( )

inline

count current time step a not valid

inverseDeltaT()

double Dune::Fem::TimeProviderBase::inverseDeltaT ( ) const

inline

obtain the size of the inverse of the current time step

Returns

the size of the inverse of the current time step

operator=()

ThisType & Dune::Fem::TimeProviderBase::operator= ( const ThisType &  )

delete

pointer()

virtual void * Dune::Fem::PersistentObject::pointer ( )

inlineprotectedvirtualinherited

Reimplemented in Dune::Fem::PersistenceManager::WrapObject< ObjectType, false >.

provideTimeStepEstimate()

void Dune::Fem::TimeProviderBase::provideTimeStepEstimate ( const double  dtEstimate )

inline

set time step estimate to minimum of given value and internal time step estiamte

Parameters

[in]

dtEstimate

time step size estimate

provideTimeStepUpperBound()

void Dune::Fem::TimeProviderBase::provideTimeStepUpperBound ( const double  upperBound )

inline

set upper bound for time step to minimum of given value and internal bound

Parameters

[in]

upperBound

time step size estimate

removeSubData()

virtual void Dune::Fem::PersistentObject::removeSubData ( )

inlineprotectedvirtualinherited

remove possible sub data of object

Reimplemented in Dune::Fem::DiscreteFunctionDefault< Impl >, Dune::Fem::DiscreteFunctionDefault< AdaptiveDiscreteFunction< DiscreteFunctionSpace > >, Dune::Fem::DiscreteFunctionDefault< BlockVectorDiscreteFunction< DiscreteFunctionSpace, BlockVector > >, Dune::Fem::DiscreteFunctionDefault< CombinedDiscreteFunction< ContainedDiscreteFunctionImp, N > >, Dune::Fem::DiscreteFunctionDefault< HierarchicalDiscreteFunction< DiscreteFunctionSpace > >, Dune::Fem::DiscreteFunctionDefault< ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block > >, Dune::Fem::DiscreteFunctionDefault< TupleDiscreteFunction< DiscreteFunctions ... > >, and Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >.

restore()

void Dune::Fem::TimeProviderBase::restore ( )

inlinevirtual

restore persistent object

Implements Dune::Fem::PersistentObject.

time()

double Dune::Fem::TimeProviderBase::time ( ) const

inline

obtain the current time

Returns

the current time

timeStep()

int Dune::Fem::TimeProviderBase::timeStep ( ) const

inline

obtain number of the current time step

Returns

the current time step counter

timeStepEstimate()

double Dune::Fem::TimeProviderBase::timeStepEstimate ( ) const

inline

obtain current estimate on time step

Returns

the current estimate for the time step

timeStepValid()

bool Dune::Fem::TimeProviderBase::timeStepValid ( ) const

inline

return if this time step should be used

Member Data Documentation

dt_

double Dune::Fem::TimeProviderBase::dt_

protected

dtEstimate_

double Dune::Fem::TimeProviderBase::dtEstimate_

protected

dtEstimateValid_

bool Dune::Fem::TimeProviderBase::dtEstimateValid_

protected

dtUpperBound_

double Dune::Fem::TimeProviderBase::dtUpperBound_

protected

invdt_

double Dune::Fem::TimeProviderBase::invdt_

protected

parameter_

ParameterReader Dune::Fem::TimeProviderBase::parameter_

protected

time_

double Dune::Fem::TimeProviderBase::time_

protected

timeStep_

int Dune::Fem::TimeProviderBase::timeStep_

protected

valid_

bool Dune::Fem::TimeProviderBase::valid_

protected

---

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

• timeprovider.hh