simulator.hh
Go to the documentation of this file.
581 << "CPU time: " << executionTimer_.realTimeElapsed() << " seconds" << humanReadableTime(executionTimer_.realTimeElapsed())
Load or save a state of a problem to/from the harddisk. bool episodeIsOver() const Returns true if the current episode is finished at the current time. Definition: simulator.hh:421 void deserializeBegin(Simulator &simulator, double t) Start reading a restart file at a certain simulated time. Definition: restart.hh:165 Scalar timeStepSize() const Returns the time step length so that we don't miss the beginning of the next episode or cross the en... Definition: simulator.hh:296 Problem & problem() Return the object which specifies the pysical setup of the simulation. Definition: simulator.hh:189 const Ewoms::Timer & timer() const Returns the current wall time required by actually running the simulation. Definition: simulator.hh:262 void serializeBegin(Simulator &simulator) Write the current state of the model to disk. Definition: restart.hh:95 const GridManager & gridManager() const Return a reference to the grid manager of simulation. Definition: simulator.hh:158 const std::string & fileName() const Returns the name of the file which is (de-)serialized. Definition: restart.hh:88 Scalar startTime() const Return the time of the start of the simulation. Definition: simulator.hh:210 Scalar endTime() const Returns the number of (simulated) seconds which the simulation runs. Definition: simulator.hh:256 bool finished() const Returns true if the simulation is finished. Definition: simulator.hh:328 void setStartTime(Scalar t) Set the time of the start of the simulation. Definition: simulator.hh:204 void serialize() This method writes the complete state of the simulation to the harddisk. Definition: simulator.hh:685 void addPrePostProcessTime(Scalar value) Definition: simulator.hh:623 bool episodeWillBeOver() const Returns true if the current episode will be finished after the current time step. ... Definition: simulator.hh:428 void startNextEpisode(Scalar len=1e100) Start the next episode, but don't change the episode identifier. Definition: simulator.hh:380 GridManager & gridManager() Return a reference to the grid manager of simulation. Definition: simulator.hh:152 void setTime(Scalar t, int stepIdx) Set the current simulated time and the time step index. Definition: simulator.hh:228 void deserialize(Restarter &restarter) Read the time manager's state from a restart file. Definition: simulator.hh:730 Provides an encapsulation to measure the system time. static void registerParameters() Registers all runtime parameters used by the simulation. Definition: simulator.hh:135 void setEndTime(Scalar t) Set the time of simulated seconds at which the simulation runs. Definition: simulator.hh:249 This file provides the infrastructure to retrieve run-time parameters. int timeStepIndex() const Returns number of time steps which have been executed since the beginning of the simulation. Definition: simulator.hh:309 const Problem & problem() const Return the object which specifies the pysical setup of the simulation. Definition: simulator.hh:196 void setTimeStepSize(Scalar timeStepSize) Set the current time step size to a given value. Definition: simulator.hh:288 void setEpisodeIndex(int episodeIdx) Sets the index of the current episode. Definition: simulator.hh:392 Scalar totalWriteTime() const Returns total wall clock time required to write the visualization and restart files over the course o... Definition: simulator.hh:269 Manages the initializing and running of time dependent problems. Definition: simulator.hh:73 Scalar episodeLength() const Returns the length of the current episode in simulated time . Definition: simulator.hh:414 Definition: baseauxiliarymodule.hh:35 Scalar maxTimeStepSize() const Aligns the time step size to the episode boundary and to the end time of the simulation. Definition: simulator.hh:351 #define EWOMS_REGISTER_PARAM(TypeTag, ParamType, ParamName, Description) Register a run-time parameter. Definition: parametersystem.hh:64 void serialize(Restarter &restarter) Write the time manager's state to a restart file. Definition: simulator.hh:709 void setFinished(bool yesno=true) Specify whether the simulation is finished. Definition: simulator.hh:319 Model & model() Return the physical model used in the simulation. Definition: simulator.hh:176 const Model & model() const Return the physical model used in the simulation. Definition: simulator.hh:182 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... Definition: simulator.hh:632 void deserializeEnd() Stop reading the restart file. Definition: restart.hh:263 Scalar time() const Return the number of seconds of simulated time which have elapsed since the start time... Definition: simulator.hh:241 GridView & gridView() Return the grid view for which the simulation is done. Definition: simulator.hh:164 void run() Runs the simulation using a given problem class. Definition: simulator.hh:464 const GridView & gridView() const Return the grid view for which the simulation is done. Definition: simulator.hh:170 Provides the magic behind the eWoms property system. Scalar episodeMaxTimeStepSize() const Aligns the time step size to the episode boundary if the current time step crosses the boundary of th... Definition: simulator.hh:438 double realTimeElapsed() const Return the real time [s] elapsed. Definition: timer.hh:100 bool willBeFinished() const Returns true if the simulation is finished after the time level is incremented by the current time st... Definition: simulator.hh:339 int episodeIndex() const Returns the index of the current episode. Definition: simulator.hh:400 double setupTime() const Returns the wall time required by setting up and initializing the simulation. Definition: simulator.hh:275 Simulator(const Simulator &)=delete void start() Start counting the time resources used by the simulation. Definition: timer.hh:68 void startNextEpisode(Scalar episodeStartTime, Scalar episodeLength) Change the current episode of the simulation. Definition: simulator.hh:366 void setTime(Scalar t) Set the current simulated time, don't change the current time step index. Definition: simulator.hh:219 Scalar episodeStartTime() const Returns the absolute time when the current episode started . Definition: simulator.hh:407 #define EWOMS_GET_PARAM(TypeTag, ParamType, ParamName) Retrieve a runtime parameter. Definition: parametersystem.hh:95 void stop() Stop counting the time resources used by the simulation. Definition: timer.hh:77 |