DUNE-FEM (unstable)

Dune::Fem::GridTimeProvider< Grid > Class Template Reference

the same functionality as the Dune::TimeProvider. More...

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

Public Member Functions

void init ()
 init dt with time step estimate
 
void init (const double timeStep)
 init dt with provided time step More...
 
void next ()
 goto next time step More...
 
void next (const double timeStep)
 goto next time step More...
 
double factor () const
 return the global factor number More...
 
void restore (const double time, const int timeStep)
 restore time and timestep from outside (i.e. from former calculation) 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
 
bool timeStepValid () const
 return if this time step should be used
 

Protected Member Functions

virtual void insertSubData ()
 insert possible sub data of object
 
virtual void removeSubData ()
 remove possible sub data of object
 

Detailed Description

template<class Grid>
class Dune::Fem::GridTimeProvider< Grid >

the same functionality as the Dune::TimeProvider.

This implementation of a timeprovider takes the Communication from a Dune::Grid instance.

Member Function Documentation

◆ deltaT()

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

◆ factor()

double Dune::Fem::TimeProvider< Grid::Traits::Communication >::factor ( ) const
inlineinherited

return the global factor number

Returns
time step factor

◆ init()

void Dune::Fem::TimeProvider< Grid::Traits::Communication >::init ( const double  timeStep)
inlineinherited

init dt with provided time step

Parameters
[in]timeStepvalue of the first time step (is multiplied with factor)

◆ 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

References Dune::Fem::TimeProviderBase::timeStepValid().

◆ next() [1/2]

void Dune::Fem::TimeProvider< Grid::Traits::Communication >::next ( )
inlineinherited

goto next time step

Sets the size of the next time step to the current time step estimate and sets the estimate to infinity.

◆ next() [2/2]

void Dune::Fem::TimeProvider< Grid::Traits::Communication >::next ( const double  timeStep)
inlineinherited

goto next time step

Sets the size of the next time step to the provided time step value and sets the estimate to infinity.

Parameters
[in]timeStepvalue of the next time step (is multiplied with factor)

◆ 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

Referenced by DuneODE::ExplicitRungeKuttaSolver< DestinationImp >::initialize(), DuneODE::ExplMultiStepBase< Operator >::solve(), DuneODE::ExplicitRungeKuttaSolver< DestinationImp >::solve(), and DuneODE::ExplMultiStepBase< Operator >::solveRK().

◆ 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

◆ restore()

void Dune::Fem::TimeProvider< Grid::Traits::Communication >::restore ( const double  time,
const int  timeStep 
)
inlineinherited

restore time and timestep from outside (i.e. from former calculation)

Parameters
[in]timenew time
[in]timeStepnew time step counter

◆ time()

◆ timeStep()

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

◆ timeStepEstimate()

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

obtain current estimate on time step

Returns
the current estimate for the time step

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 12, 23:30, 2024)