Public Member Functions | Static Public Member Functions | List of all members
Ewoms::Simulator< TypeTag > Class Template Reference
Common

Manages the initializing and running of time dependent problems. More...

#include <simulator.hh>

Public Member Functions

 Simulator (const Simulator &)=delete
 
 Simulator (bool verbose=true)
 
GridManager & gridManager ()
 Return a reference to the grid manager of simulation. More...
 
const GridManager & gridManager () const
 Return a reference to the grid manager of simulation. More...
 
GridView & gridView ()
 Return the grid view for which the simulation is done. More...
 
const GridView & gridView () const
 Return the grid view for which the simulation is done. More...
 
Model & model ()
 Return the physical model used in the simulation. More...
 
const Model & model () const
 Return the physical model used in the simulation. More...
 
Problem & problem ()
 Return the object which specifies the pysical setup of the simulation. More...
 
const Problem & problem () const
 Return the object which specifies the pysical setup of the simulation. More...
 
void setStartTime (Scalar t)
 Set the time of the start of the simulation. More...
 
Scalar startTime () const
 Return the time of the start of the simulation. More...
 
void setTime (Scalar t)
 Set the current simulated time, don't change the current time step index. More...
 
void setTime (Scalar t, int stepIdx)
 Set the current simulated time and the time step index. More...
 
Scalar time () const
 Return the number of seconds of simulated time which have elapsed since the start time. More...
 
void setEndTime (Scalar t)
 Set the time of simulated seconds at which the simulation runs. More...
 
Scalar endTime () const
 Returns the number of (simulated) seconds which the simulation runs. More...
 
const Ewoms::Timer & timer () const
 Returns the current wall time required by actually running the simulation. More...
 
Scalar totalWriteTime () const
 Returns total wall clock time required to write the visualization and restart files over the course of the simulation. More...
 
double setupTime () const
 Returns the wall time required by setting up and initializing the simulation. More...
 
void setTimeStepSize (Scalar timeStepSize)
 Set the current time step size to a given value. More...
 
Scalar timeStepSize () const
 Returns the time step length $\mathrm{[s]}$ so that we don't miss the beginning of the next episode or cross the end of the simlation. More...
 
int timeStepIndex () const
 Returns number of time steps which have been executed since the beginning of the simulation. More...
 
void setFinished (bool yesno=true)
 Specify whether the simulation is finished. More...
 
bool finished () const
 Returns true if the simulation is finished. More...
 
bool willBeFinished () const
 Returns true if the simulation is finished after the time level is incremented by the current time step size. More...
 
Scalar maxTimeStepSize () const
 Aligns the time step size to the episode boundary and to the end time of the simulation. More...
 
void startNextEpisode (Scalar episodeStartTime, Scalar episodeLength)
 Change the current episode of the simulation. More...
 
void startNextEpisode (Scalar len=1e100)
 Start the next episode, but don't change the episode identifier. More...
 
void setEpisodeIndex (int episodeIdx)
 Sets the index of the current episode. More...
 
int episodeIndex () const
 Returns the index of the current episode. More...
 
Scalar episodeStartTime () const
 Returns the absolute time when the current episode started $\mathrm{[s]}$. More...
 
Scalar episodeLength () const
 Returns the length of the current episode in simulated time $\mathrm{[s]}$. More...
 
bool episodeIsOver () const
 Returns true if the current episode is finished at the current time. More...
 
bool episodeWillBeOver () const
 Returns true if the current episode will be finished after the current time step. More...
 
Scalar episodeMaxTimeStepSize () const
 Aligns the time step size to the episode boundary if the current time step crosses the boundary of the current episode. More...
 
void run ()
 Runs the simulation using a given problem class. More...
 
Scalar prePostProcessTime () const
 
void addPrePostProcessTime (Scalar value)
 

Static Public Member Functions

static void registerParameters ()
 Registers all runtime parameters used by the simulation. More...
 
static std::string humanReadableTime (Scalar timeInSeconds, bool isAmendment=true)
 Given a time step size in seconds, return it in a format which is more easily parsable by humans. More...
 

Saving/restoring the simulation state

void serialize ()
 This method writes the complete state of the simulation to the harddisk. More...
 
template<class Restarter >
void serialize (Restarter &restarter)
 Write the time manager's state to a restart file. More...
 
template<class Restarter >
void deserialize (Restarter &restarter)
 Read the time manager's state from a restart file. More...
 

Detailed Description

template<class TypeTag>
class Ewoms::Simulator< TypeTag >

Manages the initializing and running of time dependent problems.

This class instantiates the grid, the model and the problem to be simlated and runs the simulation loop. The time axis is treated as a sequence of "episodes" which are defined as time intervals for which the problem exhibits boundary conditions and source terms that do not depend on time.

Constructor & Destructor Documentation

template<class TypeTag >
Ewoms::Simulator< TypeTag >::Simulator ( const Simulator< TypeTag > &  )
delete
template<class TypeTag >
Ewoms::Simulator< TypeTag >::Simulator ( bool  verbose = true)
inline

References EWOMS_GET_PARAM, and Ewoms::Timer::start().

Member Function Documentation

template<class TypeTag >
void Ewoms::Simulator< TypeTag >::addPrePostProcessTime ( Scalar  value)
inline

Referenced by Ewoms::NewtonMethod< TypeTag >::apply(), and Ewoms::FvBaseDiscretization< TypeTag >::update().

template<class TypeTag >
template<class Restarter >
void Ewoms::Simulator< TypeTag >::deserialize ( Restarter &  restarter)
inline

Read the time manager's state from a restart file.

Template Parameters
RestarterThe type of the object which takes care to deserialize data
Parameters
restarterThe deserializer object

Referenced by Ewoms::Simulator< TypeTag >::run().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::endTime ( ) const
inline

Returns the number of (simulated) seconds which the simulation runs.

Referenced by Ewoms::Simulator< TypeTag >::finished(), Ewoms::Simulator< TypeTag >::maxTimeStepSize(), Ewoms::Simulator< TypeTag >::timeStepSize(), and Ewoms::Simulator< TypeTag >::willBeFinished().

template<class TypeTag >
int Ewoms::Simulator< TypeTag >::episodeIndex ( ) const
inline

Returns the index of the current episode.

The first episode has the index 0.

Referenced by Ewoms::FvBaseProblem< TypeTag >::endEpisode(), and Ewoms::Simulator< TypeTag >::run().

template<class TypeTag >
bool Ewoms::Simulator< TypeTag >::episodeIsOver ( ) const
inline

Returns true if the current episode is finished at the current time.

References Ewoms::Simulator< TypeTag >::episodeLength(), Ewoms::Simulator< TypeTag >::startTime(), and Ewoms::Simulator< TypeTag >::time().

Referenced by Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize(), and Ewoms::Simulator< TypeTag >::run().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::episodeLength ( ) const
inline

Returns the length of the current episode in simulated time $\mathrm{[s]}$.

Referenced by Ewoms::Simulator< TypeTag >::episodeIsOver(), Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize(), Ewoms::Simulator< TypeTag >::episodeWillBeOver(), and Ewoms::Simulator< TypeTag >::startNextEpisode().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize ( ) const
inline

Aligns the time step size to the episode boundary if the current time step crosses the boundary of the current episode.

References Ewoms::Simulator< TypeTag >::episodeIsOver(), Ewoms::Simulator< TypeTag >::episodeLength(), Ewoms::Simulator< TypeTag >::episodeStartTime(), Ewoms::Simulator< TypeTag >::startTime(), and Ewoms::Simulator< TypeTag >::time().

Referenced by Ewoms::Simulator< TypeTag >::maxTimeStepSize(), and Ewoms::Simulator< TypeTag >::timeStepSize().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::episodeStartTime ( ) const
inline

Returns the absolute time when the current episode started $\mathrm{[s]}$.

Referenced by Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize(), and Ewoms::Simulator< TypeTag >::startNextEpisode().

template<class TypeTag >
bool Ewoms::Simulator< TypeTag >::episodeWillBeOver ( ) const
inline

Returns true if the current episode will be finished after the current time step.

References Ewoms::Simulator< TypeTag >::episodeLength(), Ewoms::Simulator< TypeTag >::startTime(), Ewoms::Simulator< TypeTag >::time(), and Ewoms::Simulator< TypeTag >::timeStepSize().

template<class TypeTag >
bool Ewoms::Simulator< TypeTag >::finished ( ) const
inline

Returns true if the simulation is finished.

This is the case if either setFinished(true) has been called or if the end time is reached.

References Ewoms::Simulator< TypeTag >::endTime(), Ewoms::Simulator< TypeTag >::time(), and Ewoms::Simulator< TypeTag >::timeStepSize().

Referenced by Ewoms::Simulator< TypeTag >::maxTimeStepSize(), and Ewoms::Simulator< TypeTag >::run().

template<class TypeTag >
GridManager& Ewoms::Simulator< TypeTag >::gridManager ( )
inline

Return a reference to the grid manager of simulation.

Referenced by Ewoms::Linear::ParallelAmgBackend< TypeTag >::solve().

template<class TypeTag >
const GridManager& Ewoms::Simulator< TypeTag >::gridManager ( ) const
inline

Return a reference to the grid manager of simulation.

template<class TypeTag >
GridView& Ewoms::Simulator< TypeTag >::gridView ( )
inline

Return the grid view for which the simulation is done.

Referenced by Ewoms::FvBaseDiscretization< TypeTag >::checkConservativeness(), Ewoms::Restart::deserializeBegin(), Ewoms::FvBaseLinearizer< TypeTag >::linearize(), Ewoms::VtkPrimaryVarsModule< TypeTag >::processElement(), Ewoms::BaseOutputModule< TypeTag >::resizeComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizeEqBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizePhaseBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizePhaseComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizeScalarBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizeTensorBuffer_(), Ewoms::Simulator< TypeTag >::serialize(), Ewoms::Restart::serializeBegin(), Ewoms::Linear::ParallelAmgBackend< TypeTag >::solve(), and Ewoms::Linear::ParallelIterativeSolverBackend< TypeTag >::solve().

template<class TypeTag >
const GridView& Ewoms::Simulator< TypeTag >::gridView ( ) const
inline

Return the grid view for which the simulation is done.

template<class TypeTag >
static std::string Ewoms::Simulator< TypeTag >::humanReadableTime ( Scalar  timeInSeconds,
bool  isAmendment = true 
)
inlinestatic

Given a time step size in seconds, return it in a format which is more easily parsable by humans.

e.g. 874000.0 will become "10.12 days"

Referenced by Ewoms::FvBaseProblem< TypeTag >::finalize(), and Ewoms::Simulator< TypeTag >::run().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::maxTimeStepSize ( ) const
inline

Aligns the time step size to the episode boundary and to the end time of the simulation.

References Ewoms::Simulator< TypeTag >::endTime(), Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize(), Ewoms::Simulator< TypeTag >::finished(), and Ewoms::Simulator< TypeTag >::time().

Referenced by Ewoms::FvBaseProblem< TypeTag >::nextTimeStepSize().

template<class TypeTag >
Model& Ewoms::Simulator< TypeTag >::model ( )
inline

Return the physical model used in the simulation.

Referenced by Ewoms::VtkDiscreteFractureModule< TypeTag >::allocBuffers(), Ewoms::VtkMultiPhaseModule< TypeTag >::allocBuffers(), Ewoms::FvBaseDiscretization< TypeTag >::checkConservativeness(), Ewoms::VtkDiscreteFractureModule< TypeTag >::commitBuffers(), Ewoms::VtkMultiPhaseModule< TypeTag >::commitBuffers(), Ewoms::BaseOutputModule< TypeTag >::commitPriVarsBuffer_(), Ewoms::FvBaseElementContext< TypeTag >::model(), Ewoms::NewtonMethod< TypeTag >::model(), Ewoms::FvBaseProblem< TypeTag >::model(), Ewoms::FvBaseAdLocalLinearizer< TypeTag >::model_(), Ewoms::FvBaseFdLocalLinearizer< TypeTag >::model_(), Ewoms::BaseOutputModule< TypeTag >::resizeComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizeEqBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizePhaseBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizePhaseComponentBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizeScalarBuffer_(), Ewoms::BaseOutputModule< TypeTag >::resizeTensorBuffer_(), Ewoms::Linear::ParallelAmgBackend< TypeTag >::solve(), and Ewoms::Linear::ParallelIterativeSolverBackend< TypeTag >::solve().

template<class TypeTag >
const Model& Ewoms::Simulator< TypeTag >::model ( ) const
inline

Return the physical model used in the simulation.

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::prePostProcessTime ( ) const
inline

Referenced by Ewoms::FvBaseProblem< TypeTag >::finalize().

template<class TypeTag >
Problem& Ewoms::Simulator< TypeTag >::problem ( )
inline

Return the object which specifies the pysical setup of the simulation.

Referenced by Ewoms::FvBaseDiscretization< TypeTag >::applyInitialSolution(), Ewoms::FvBaseDiscretization< TypeTag >::checkConservativeness(), Ewoms::Restart::deserializeBegin(), Ewoms::EcfvDiscretization< TypeTag >::dofMapper(), Ewoms::VcfvDiscretization< TypeTag >::dofMapper(), Ewoms::FvBaseDiscretization< TypeTag >::elementMapper(), Ewoms::NewtonMethod< TypeTag >::problem(), Ewoms::FvBaseElementContext< TypeTag >::problem(), Ewoms::FvBaseAdLocalLinearizer< TypeTag >::problem_(), Ewoms::FvBaseFdLocalLinearizer< TypeTag >::problem_(), Ewoms::Restart::serializeBegin(), and Ewoms::FvBaseDiscretization< TypeTag >::vertexMapper().

template<class TypeTag >
const Problem& Ewoms::Simulator< TypeTag >::problem ( ) const
inline

Return the object which specifies the pysical setup of the simulation.

template<class TypeTag >
static void Ewoms::Simulator< TypeTag >::registerParameters ( )
inlinestatic

Registers all runtime parameters used by the simulation.

References EWOMS_REGISTER_PARAM.

template<class TypeTag >
void Ewoms::Simulator< TypeTag >::run ( )
inline

Runs the simulation using a given problem class.

This method makes sure that time steps sizes are aligned to episode boundaries, amongst other stuff.

References Ewoms::Simulator< TypeTag >::deserialize(), Ewoms::Restart::deserializeBegin(), Ewoms::Restart::deserializeEnd(), Ewoms::Simulator< TypeTag >::episodeIndex(), Ewoms::Simulator< TypeTag >::episodeIsOver(), EWOMS_GET_PARAM, Ewoms::Restart::fileName(), Ewoms::Simulator< TypeTag >::finished(), Ewoms::Simulator< TypeTag >::humanReadableTime(), Ewoms::Timer::realTimeElapsed(), Ewoms::Simulator< TypeTag >::serialize(), Ewoms::Simulator< TypeTag >::setTimeStepSize(), Ewoms::Timer::start(), Ewoms::Timer::stop(), Ewoms::Simulator< TypeTag >::time(), Ewoms::Simulator< TypeTag >::timeStepIndex(), and Ewoms::Simulator< TypeTag >::timeStepSize().

template<class TypeTag >
void Ewoms::Simulator< TypeTag >::serialize ( )
inline

This method writes the complete state of the simulation to the harddisk.

The file will start with the prefix returned by the name() method, has the current time of the simulation clock in it's name and uses the extension .ers. (Ewoms ReStart file.) See Ewoms::Restart for details.

References Ewoms::Simulator< TypeTag >::gridView(), Ewoms::Restart::serializeBegin(), and Ewoms::Simulator< TypeTag >::timeStepSize().

Referenced by Ewoms::Simulator< TypeTag >::run().

template<class TypeTag >
template<class Restarter >
void Ewoms::Simulator< TypeTag >::serialize ( Restarter &  restarter)
inline

Write the time manager's state to a restart file.

Template Parameters
RestarterThe type of the object which takes care to serialize data
Parameters
restarterThe serializer object
template<class TypeTag >
void Ewoms::Simulator< TypeTag >::setEndTime ( Scalar  t)
inline

Set the time of simulated seconds at which the simulation runs.

Parameters
tThe time $\mathrm{[s]}$ at which the simulation is finished
template<class TypeTag >
void Ewoms::Simulator< TypeTag >::setEpisodeIndex ( int  episodeIdx)
inline

Sets the index of the current episode.

Use this method with care!

template<class TypeTag >
void Ewoms::Simulator< TypeTag >::setFinished ( bool  yesno = true)
inline

Specify whether the simulation is finished.

Parameters
yesnoIf true the simulation is considered finished before the end time is reached, else it is only considered finished if the end time is reached.
template<class TypeTag >
void Ewoms::Simulator< TypeTag >::setStartTime ( Scalar  t)
inline

Set the time of the start of the simulation.

Parameters
tThe time $\mathrm{[s]}$ which should be jumped to
template<class TypeTag >
void Ewoms::Simulator< TypeTag >::setTime ( Scalar  t)
inline

Set the current simulated time, don't change the current time step index.

Parameters
tThe time $\mathrm{[s]}$ which should be jumped to
template<class TypeTag >
void Ewoms::Simulator< TypeTag >::setTime ( Scalar  t,
int  stepIdx 
)
inline

Set the current simulated time and the time step index.

Parameters
tThe time $\mathrm{[s]}$ which should be jumped to
stepIdxThe new time step index
template<class TypeTag >
void Ewoms::Simulator< TypeTag >::setTimeStepSize ( Scalar  timeStepSize)
inline

Set the current time step size to a given value.

If the step size would exceed the length of the current episode, the timeStep() method will take care that the step size won't exceed the episode or the end of the simulation, though.

Parameters
timeStepSizeThe new value for the time step size $\mathrm{[s]}$

References Ewoms::Simulator< TypeTag >::timeStepSize().

Referenced by Ewoms::Simulator< TypeTag >::run(), and Ewoms::FvBaseProblem< TypeTag >::timeIntegration().

template<class TypeTag >
double Ewoms::Simulator< TypeTag >::setupTime ( ) const
inline

Returns the wall time required by setting up and initializing the simulation.

References Ewoms::Timer::realTimeElapsed().

Referenced by Ewoms::FvBaseProblem< TypeTag >::finalize().

template<class TypeTag >
void Ewoms::Simulator< TypeTag >::startNextEpisode ( Scalar  episodeStartTime,
Scalar  episodeLength 
)
inline

Change the current episode of the simulation.

Parameters
episodeStartTimeTime when the episode began $\mathrm{[s]}$
episodeLengthLength of the episode $\mathrm{[s]}$

References Ewoms::Simulator< TypeTag >::episodeLength(), and Ewoms::Simulator< TypeTag >::episodeStartTime().

template<class TypeTag >
void Ewoms::Simulator< TypeTag >::startNextEpisode ( Scalar  len = 1e100)
inline

Start the next episode, but don't change the episode identifier.

Parameters
lenLength of the episode $\mathrm{[s]}$, infinite if not specified.
template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::startTime ( ) const
inline

Return the time of the start of the simulation.

Referenced by Ewoms::Simulator< TypeTag >::episodeIsOver(), Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize(), and Ewoms::Simulator< TypeTag >::episodeWillBeOver().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::time ( ) const
inline

Return the number of seconds of simulated time which have elapsed since the start time.

To get the time after the time integration, you have to add timeStepSize() to time().

Referenced by Ewoms::Simulator< TypeTag >::episodeIsOver(), Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize(), Ewoms::Simulator< TypeTag >::episodeWillBeOver(), Ewoms::Simulator< TypeTag >::finished(), Ewoms::Simulator< TypeTag >::maxTimeStepSize(), Ewoms::Simulator< TypeTag >::run(), Ewoms::Restart::serializeBegin(), Ewoms::Simulator< TypeTag >::timeStepSize(), Ewoms::Simulator< TypeTag >::willBeFinished(), and Ewoms::FvBaseProblem< TypeTag >::writeOutput().

template<class TypeTag >
const Ewoms::Timer& Ewoms::Simulator< TypeTag >::timer ( ) const
inline

Returns the current wall time required by actually running the simulation.

Referenced by Ewoms::FvBaseProblem< TypeTag >::finalize().

template<class TypeTag >
int Ewoms::Simulator< TypeTag >::timeStepIndex ( ) const
inline

Returns number of time steps which have been executed since the beginning of the simulation.

Referenced by Ewoms::Simulator< TypeTag >::run(), and Ewoms::FvBaseProblem< TypeTag >::shouldWriteRestartFile().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::timeStepSize ( ) const
inline

Returns the time step length $\mathrm{[s]}$ so that we don't miss the beginning of the next episode or cross the end of the simlation.

References Ewoms::Simulator< TypeTag >::endTime(), Ewoms::Simulator< TypeTag >::episodeMaxTimeStepSize(), and Ewoms::Simulator< TypeTag >::time().

Referenced by Ewoms::FvBaseDiscretization< TypeTag >::checkConservativeness(), Ewoms::Simulator< TypeTag >::episodeWillBeOver(), Ewoms::Simulator< TypeTag >::finished(), Ewoms::Simulator< TypeTag >::run(), Ewoms::Simulator< TypeTag >::serialize(), Ewoms::Simulator< TypeTag >::setTimeStepSize(), Ewoms::FvBaseProblem< TypeTag >::timeIntegration(), Ewoms::Simulator< TypeTag >::willBeFinished(), and Ewoms::FvBaseProblem< TypeTag >::writeOutput().

template<class TypeTag >
Scalar Ewoms::Simulator< TypeTag >::totalWriteTime ( ) const
inline

Returns total wall clock time required to write the visualization and restart files over the course of the simulation.

Referenced by Ewoms::FvBaseProblem< TypeTag >::finalize().

template<class TypeTag >
bool Ewoms::Simulator< TypeTag >::willBeFinished ( ) const
inline

Returns true if the simulation is finished after the time level is incremented by the current time step size.

References Ewoms::Simulator< TypeTag >::endTime(), Ewoms::Simulator< TypeTag >::time(), and Ewoms::Simulator< TypeTag >::timeStepSize().

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