dune-fem
2.4.1-rc
|
#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/solver/timeprovider.hh>
Public Types | |
typedef CollectiveCommunication | CollectiveCommunicationType |
Public Member Functions | |
FixedStepTimeProvider (const double startTime, const double timeStepSize, const CollectiveCommunicationType &comm, const ParameterReader ¶meter=Parameter::container()) | |
constructor More... | |
FixedStepTimeProvider (const double startTime, const double timeStepSize, const ParameterReader ¶meter=Parameter::container()) | |
FixedStepTimeProvider (const ParameterReader ¶meter=Parameter::container()) | |
constructor More... | |
FixedStepTimeProvider (const CollectiveCommunicationType &comm, const ParameterReader ¶meter=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 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 CollectiveCommunicationType & | comm_ |
double | time_ |
int | timeStep_ |
double | dt_ |
double | invdt_ |
bool | valid_ |
bool | dtEstimateValid_ |
double | dtEstimate_ |
double | dtUpperBound_ |
ParameterReader | parameter_ |
typedef CollectiveCommunication Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::CollectiveCommunicationType |
|
inlineexplicit |
constructor
[in] | startTime | initial time |
[in] | timeStepSize | time step size |
[in] | comm | collective communication (default Dune::Fem::MPIManager::comm()) |
References Dune::Fem::TimeProviderBase::dt_.
|
inlineexplicit |
References Dune::Fem::TimeProviderBase::dt_.
|
inlineexplicit |
constructor
[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.
References Dune::Fem::TimeProviderBase::dt_.
|
inlineexplicit |
References Dune::Fem::TimeProviderBase::dt_.
|
inlinevirtual |
References Dune::Fem::TimeProviderBase::operator=().
|
delete |
|
delete |
|
inlineprotectedinherited |
References Dune::Fem::TimeProviderBase::deltaT(), Dune::Fem::TimeProviderBase::timeStep_, and Dune::Fem::TimeProviderBase::timeStepValid().
Referenced by Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::next(), and Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::next().
|
inlinevirtualinherited |
backup persistent object
Implements Dune::Fem::PersistentObject.
Reimplemented in Dune::Fem::TimeProvider< CollectiveCommunication >, and Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >.
References Dune::Fem::PersistenceManager::backupValue(), Dune::Fem::TimeProviderBase::dt_, Dune::Fem::TimeProviderBase::dtEstimate_, Dune::Fem::TimeProviderBase::time_, Dune::Fem::TimeProviderBase::timeStep_, and Dune::Fem::TimeProviderBase::valid_.
|
inlineinherited |
obtain the size of the current time step
References Dune::Fem::TimeProviderBase::dt_, and Dune::Fem::TimeProviderBase::timeStepValid().
Referenced by Dune::Fem::TimeProviderBase::advance().
|
inlineprotected |
|
inlineprotectedinherited |
|
inlineprotectedvirtualinherited |
insert possible sub data of object
Reimplemented in Dune::Fem::DiscreteFunctionDefault< Impl >, Dune::Fem::DiscreteFunctionDefault< AdaptiveDiscreteFunction< DiscreteFunctionSpace > >, Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >, Dune::Fem::DiscreteFunctionDefault< BlockVectorDiscreteFunction< DiscreteFunctionSpace, BlockVector > >, Dune::Fem::DiscreteFunctionDefault< ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block > >, and Dune::Fem::DiscreteFunctionDefault< CombinedDiscreteFunction< ContainedDiscreteFunctionImp, N > >.
Referenced by Dune::Fem::PersistenceManager::insertObject().
|
inlineinherited |
count current time step a not valid
References Dune::Fem::TimeProviderBase::valid_.
|
inlineinherited |
obtain the size of the inverse of the current time step
References Dune::Fem::TimeProviderBase::invdt_, and Dune::Fem::TimeProviderBase::timeStepValid().
|
inline |
goto next time step
References Dune::Fem::TimeProviderBase::advance(), and Dune::Fem::TimeProviderBase::timeStepValid().
|
delete |
|
delete |
|
inlineprotectedvirtualinherited |
Reimplemented in Dune::Fem::PersistenceManager::WrapObject< ObjectType, false >.
|
inlineinherited |
set time step estimate to minimum of given value and internal time step estiamte
[in] | dtEstimate | time step size estimate |
References Dune::Fem::TimeProviderBase::dtEstimate_, Dune::Fem::TimeProviderBase::dtEstimateValid_, and Dune::Std::min().
|
inlineinherited |
set upper bound for time step to minimum of given value and internal bound
[in] | upperBound | time step size estimate |
References Dune::Fem::TimeProviderBase::dtEstimateValid_, Dune::Fem::TimeProviderBase::dtUpperBound_, and Dune::Std::min().
|
inlineprotectedvirtualinherited |
remove possible sub data of object
Reimplemented in Dune::Fem::DiscreteFunctionDefault< Impl >, Dune::Fem::DiscreteFunctionDefault< AdaptiveDiscreteFunction< DiscreteFunctionSpace > >, Dune::Fem::DiscreteFunctionDefault< VectorDiscreteFunction< DiscreteFunctionSpace, Vector > >, Dune::Fem::DiscreteFunctionDefault< BlockVectorDiscreteFunction< DiscreteFunctionSpace, BlockVector > >, Dune::Fem::DiscreteFunctionDefault< ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block > >, and Dune::Fem::DiscreteFunctionDefault< CombinedDiscreteFunction< ContainedDiscreteFunctionImp, N > >.
Referenced by Dune::Fem::PersistenceManager::removeObject().
|
inlinevirtualinherited |
restore persistent object
Implements Dune::Fem::PersistentObject.
Reimplemented in Dune::Fem::TimeProvider< CollectiveCommunication >, and Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >.
References Dune::Fem::TimeProviderBase::dt_, Dune::Fem::TimeProviderBase::dtEstimate_, Dune::Fem::TimeProviderBase::dtEstimateValid_, Dune::Fem::TimeProviderBase::invdt_, Dune::Fem::TimeProviderBase::operator=(), Dune::Fem::PersistenceManager::restoreValue(), Dune::Fem::TimeProviderBase::time_, Dune::Fem::TimeProviderBase::TimeProviderBase(), Dune::Fem::TimeProviderBase::timeStep_, and Dune::Fem::TimeProviderBase::valid_.
|
inlineinherited |
obtain the current time
References Dune::Fem::TimeProviderBase::time_.
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::consistentSaveStep(), Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::restore(), Dune::Fem::DataOutput< GridImp, DataImp >::willWrite(), and Dune::Fem::DataOutput< GridImp, DataImp >::write().
|
inlineinherited |
obtain number of the current time step
References Dune::Fem::TimeProviderBase::timeStep_, and Dune::Fem::TimeProviderBase::timeStepValid().
Referenced by Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::restore(), and Dune::Fem::CheckPointer< GridImp, DataImp >::willWrite().
|
inlineinherited |
obtain current estimate on time step
References Dune::Fem::TimeProviderBase::dtEstimate_.
|
inlineinherited |
return if this time step should be used
References Dune::Fem::TimeProviderBase::valid_.
Referenced by Dune::Fem::TimeProviderBase::advance(), Dune::Fem::TimeProviderBase::deltaT(), Dune::Fem::TimeProviderBase::inverseDeltaT(), Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::next(), and Dune::Fem::TimeProviderBase::timeStep().
|
protected |
|
protectedinherited |
Referenced by Dune::Fem::TimeProviderBase::backup(), Dune::Fem::TimeProviderBase::deltaT(), Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::FixedStepTimeProvider(), Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::initTimeStep(), and Dune::Fem::TimeProviderBase::restore().
|
protectedinherited |
Referenced by Dune::Fem::TimeProviderBase::backup(), Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::init(), Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::next(), Dune::Fem::TimeProviderBase::provideTimeStepEstimate(), Dune::Fem::TimeProviderBase::restore(), and Dune::Fem::TimeProviderBase::timeStepEstimate().
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
Referenced by Dune::Fem::TimeProviderBase::backup(), Dune::Fem::FixedStepTimeProvider< CollectiveCommunication >::initTimeStep(), Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::initTimeStep(), Dune::Fem::TimeProviderBase::invalidateTimeStep(), Dune::Fem::TimeProviderBase::restore(), and Dune::Fem::TimeProviderBase::timeStepValid().