Dune::Fem::FixedStepTimeProvider< CollectiveCommunication > Class Template Reference

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

Inheritance diagram for Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >:

Public Types
typedef CollectiveCommunication	CollectiveCommunicationType

Public Member Functions
	FixedStepTimeProvider (const double startTime, const double timeStepSize, const CollectiveCommunicationType &comm, const ParameterReader &parameter=Parameter::container())
	constructor
	FixedStepTimeProvider (const double startTime, const double timeStepSize, const ParameterReader &parameter=Parameter::container())
	FixedStepTimeProvider (const ParameterReader &parameter=Parameter::container())
	constructor
	FixedStepTimeProvider (const CollectiveCommunicationType &comm, const ParameterReader &parameter=Parameter::container())
virtual	~FixedStepTimeProvider ()
	FixedStepTimeProvider (const ThisType &)=delete
	FixedStepTimeProvider (ThisType &&)=delete
ThisType &	operator= (const ThisType &)=delete
ThisType &	operator= (ThisType &&)=delete
void	next ()
	goto next time step
void	backup () const
	backup persistent object
void	restore ()
	restore persistent object
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	initTimeStep ()
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
const CollectiveCommunicationType &	comm_
double	time_
double	dt_
bool	valid_
int	timeStep_
double	invdt_
bool	dtEstimateValid_
double	dtEstimate_
double	dtUpperBound_
ParameterReader	parameter_

Member Typedef Documentation

CollectiveCommunicationType

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

typedef CollectiveCommunication Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::CollectiveCommunicationType

Constructor & Destructor Documentation

FixedStepTimeProvider() [1/6]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::FixedStepTimeProvider ( const double  startTime, const double  timeStepSize, const CollectiveCommunicationType &  comm, const ParameterReader &  parameter = Parameter::container()  )

inlineexplicit

constructor

Parameters

[in]	startTime	initial time
[in]	timeStepSize	time step size
[in]	comm	collective communication (default Dune::Fem::MPIManager::comm())

FixedStepTimeProvider() [2/6]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::FixedStepTimeProvider ( const double  startTime, const double  timeStepSize, const ParameterReader &  parameter = Parameter::container()  )

inlineexplicit

FixedStepTimeProvider() [3/6]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::FixedStepTimeProvider ( const ParameterReader &  parameter = Parameter::container() )

inlineexplicit

constructor

Parameters

[in]

comm

collective communication (default Dune::Fem::MPIManager::comm())

The initial time need to be provided using the parameter fem.timeprovider.starttime while the time step size need to be provided using the parameter fem.timeprovider.fixedtimestep.

FixedStepTimeProvider() [4/6]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::FixedStepTimeProvider ( const CollectiveCommunicationType &  comm, const ParameterReader &  parameter = Parameter::container()  )

inlineexplicit

~FixedStepTimeProvider()

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

virtual Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::~FixedStepTimeProvider ( )

inlinevirtual

FixedStepTimeProvider() [5/6]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::FixedStepTimeProvider ( const ThisType &  )

delete

FixedStepTimeProvider() [6/6]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::FixedStepTimeProvider ( ThisType &&  )

delete

Member Function Documentation

advance()

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

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

inlineprotected

backup()

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

inlinevirtualinherited

backup persistent object

Implements Dune::Fem::PersistentObject.

Reimplemented in Dune::Fem::TimeProvider< CollectiveCommunication >, and Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >.

deltaT()

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

inlineinherited

obtain the size of the current time step

Returns

the size of the current time step

initTimeStep()

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

void Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::initTimeStep ( )

inlineprotected

initTimeStepEstimate()

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

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 ( )

inlineinherited

count current time step a not valid

inverseDeltaT()

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

inlineinherited

obtain the size of the inverse of the current time step

Returns

the size of the inverse of the current time step

next()

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

void Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::next ( )

inline

goto next time step

operator=() [1/2]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

ThisType & Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::operator= ( const ThisType &  )

delete

operator=() [2/2]

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

ThisType & Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::operator= ( 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 )

inlineinherited

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 )

inlineinherited

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 ( )

inlinevirtualinherited

restore persistent object

Implements Dune::Fem::PersistentObject.

Reimplemented in Dune::Fem::TimeProvider< CollectiveCommunication >, and Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >.

time()

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

inlineinherited

obtain the current time

Returns

the current time

timeStep()

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

inlineinherited

obtain number of the current time step

Returns

the current time step counter

timeStepEstimate()

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

inlineinherited

obtain current estimate on time step

Returns

the current estimate for the time step

timeStepValid()

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

inlineinherited

return if this time step should be used

Member Data Documentation

comm_

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

const CollectiveCommunicationType& Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::comm_

protected

dt_

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

double Dune::Fem::TimeProviderBase::dt_

protected

dtEstimate_

double Dune::Fem::TimeProviderBase::dtEstimate_

protectedinherited

dtEstimateValid_

bool Dune::Fem::TimeProviderBase::dtEstimateValid_

protectedinherited

dtUpperBound_

double Dune::Fem::TimeProviderBase::dtUpperBound_

protectedinherited

invdt_

double Dune::Fem::TimeProviderBase::invdt_

protectedinherited

parameter_

ParameterReader Dune::Fem::TimeProviderBase::parameter_

protectedinherited

time_

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

double Dune::Fem::TimeProviderBase::time_

protected

timeStep_

int Dune::Fem::TimeProviderBase::timeStep_

protectedinherited

valid_

template<class CollectiveCommunication = typename MPIManager::CollectiveCommunication>

bool Dune::Fem::TimeProviderBase::valid_

protected

---

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

• timeprovider.hh