dune-fem 2.8-git
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::Fem::FixedStepTimeProvider< CollectiveCommunication > Class Template Reference

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

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

Public Types

typedef CollectiveCommunication CollectiveCommunicationType
 

Public Member Functions

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

Protected Member Functions

void initTimeStep ()
 
void advance ()
 
void initTimeStepEstimate ()
 
virtual void insertSubData ()
 insert possible sub data of object More...
 
virtual void removeSubData ()
 remove possible sub data of object More...
 
virtual void * pointer ()
 

Protected Attributes

const CollectiveCommunicationTypecomm_
 
double time_
 
int timeStep_
 
double dt_
 
double invdt_
 
bool valid_
 
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]startTimeinitial time
[in]timeStepSizetime step size
[in]commcollective 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]commcollective 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()

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

◆ backup()

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

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

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

◆ insertSubData()

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

◆ 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

◆ 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]dtEstimatetime 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]upperBoundtime step size estimate

◆ removeSubData()

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

◆ restore()

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

◆ 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_

double Dune::Fem::TimeProviderBase::dt_
protectedinherited

◆ 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_

double Dune::Fem::TimeProviderBase::time_
protectedinherited

◆ timeStep_

int Dune::Fem::TimeProviderBase::timeStep_
protectedinherited

◆ valid_

bool Dune::Fem::TimeProviderBase::valid_
protectedinherited

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