SPH
Public Member Functions | Protected Attributes | List of all members
SphRun Class Reference
Inheritance diagram for SphRun:
IRun Polymorphic SphStabilizationRun

Public Member Functions

 SphRun (const RunSettings &run, SharedPtr< IDomain > domain)
 
virtual void setUp (SharedPtr< Storage > storage) override
 Prepares the run, creates logger, output, ... More...
 
virtual void tearDown (const Storage &storage, const Statistics &stats) override
 Called after the run. More...
 
- Public Member Functions inherited from IRun
 IRun ()
 
 ~IRun ()
 
Statistics run (Storage &storage)
 Runs the simulation. More...
 
Statistics run (Storage &storage, IRunCallbacks &callbacks)
 Runs the simulation. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Protected Attributes

SharedPtr< IDomaindomain
 
- Protected Attributes inherited from IRun
RunSettings settings
 
AutoPtr< IOutputoutput
 Data output. More...
 
SharedPtr< ILoggerlogger
 Logging. More...
 
AutoPtr< ILogWriterlogWriter
 Writes statistics into logger every timestep. More...
 
SharedPtr< ISchedulerscheduler
 Scheduler used for parallelization. More...
 
AutoPtr< ITimeSteppingtimeStepping
 Timestepping. More...
 
AutoPtr< ISolversolver
 Solver. More...
 
List< AutoPtr< ITrigger > > triggers
 Triggers. More...
 
Array< AutoPtr< IDiagnostic > > diagnostics
 Diagnostics. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IRun
void setNullToDefaults (SharedPtr< Storage > storage)
 
void tearDownInternal (const Storage &storage, const Statistics &stats)
 

Detailed Description

Definition at line 156 of file SimulationJobs.cpp.

Constructor & Destructor Documentation

◆ SphRun()

SphRun::SphRun ( const RunSettings run,
SharedPtr< IDomain domain 
)
inlineexplicit

Definition at line 161 of file SimulationJobs.cpp.

Member Function Documentation

◆ setUp()

virtual void SphRun::setUp ( SharedPtr< Storage storage)
inlineoverridevirtual

Prepares the run, creates logger, output, ...

Implements IRun.

Reimplemented in SphStabilizationRun.

Definition at line 167 of file SimulationJobs.cpp.

◆ tearDown()

virtual void SphRun::tearDown ( const Storage storage,
const Statistics stats 
)
inlineoverridevirtual

Called after the run.

Used to save the necessary data, log run statistics, etc. Is called at the end of run function.

Parameters
statsRun statistics at the end of the run.

Implements IRun.

Definition at line 176 of file SimulationJobs.cpp.

Member Data Documentation

◆ domain

SharedPtr<IDomain> SphRun::domain
protected

Definition at line 158 of file SimulationJobs.cpp.


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