SPH
Public Member Functions | List of all members
SphStabilizationJob Class Reference

#include <SimulationJobs.h>

Inheritance diagram for SphStabilizationJob:
SphJob IRunJob SharedToken IParticleJob IJob Polymorphic

Public Member Functions

virtual std::string className () const override
 Name representing the type of the job (e.e. "SPH"). More...
 
virtual VirtualSettings getSettings () override
 Returns a settings object which allows to query and modify the state of the job. More...
 
virtual AutoPtr< IRungetRun (const RunSettings &overrides) const override
 Returns the actual simulation object. More...
 
 SphJob (const std::string &name, const RunSettings &overrides=EMPTY_SETTINGS)
 
- Public Member Functions inherited from SphJob
 SphJob (const std::string &name, const RunSettings &overrides=EMPTY_SETTINGS)
 
virtual UnorderedMap< std::string, ExtJobTypegetSlots () const override
 Lists all potential inputs of the job. More...
 
virtual UnorderedMap< std::string, ExtJobTyperequires () const override
 List of slots that need to be connected to evaluate the job. More...
 
- Public Member Functions inherited from IRunJob
 IRunJob (const std::string &name)
 
 ~IRunJob () override
 
- Public Member Functions inherited from IParticleJob
 IParticleJob (const std::string &name)
 
 ~IParticleJob () override
 
virtual Optional< ExtJobTypeprovides () const override final
 Specifies the type of the job, i.e. what kind of data the job provides. More...
 
virtual JobContext getResult () const override final
 Returns the result of the job. More...
 
- Public Member Functions inherited from IJob
 IJob (const std::string &name)
 
virtual std::string instanceName () const
 Unique name representing this job. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 
- Public Member Functions inherited from SharedToken
 SharedToken ()
 
 SharedToken (std::nullptr_t)
 
 SharedToken (const SharedToken &other)
 
template<typename T >
 SharedToken (const SharedPtr< T > &ptr)
 
SharedTokenoperator= (const SharedToken &other)
 
 ~SharedToken ()
 
void reset ()
 
INLINE operator bool () const
 
INLINE bool operator! () const
 

Additional Inherited Members

- Static Public Member Functions inherited from SphJob
static RunSettings getDefaultSettings (const std::string &name)
 
- Protected Member Functions inherited from IRunJob
virtual void evaluate (const RunSettings &global, IRunCallbacks &callbacks) override final
 Runs the operation provided by the job. More...
 
- Protected Member Functions inherited from IJob
template<typename T >
SharedPtr< T > getInput (const std::string &name) const
 Convenient function to return input data for slot of given name. More...
 
- Protected Attributes inherited from SphJob
RunSettings settings
 
bool isResumed = false
 
- Protected Attributes inherited from IParticleJob
SharedPtr< ParticleDataresult
 Data filled by the job when it finishes. More...
 
- Protected Attributes inherited from IJob
std::string instName
 
UnorderedMap< std::string, JobContextinputs
 Contains all input data, identified by names of input slots. More...
 

Detailed Description

Definition at line 39 of file SimulationJobs.h.

Member Function Documentation

◆ className()

virtual std::string SphStabilizationJob::className ( ) const
inlineoverridevirtual

Name representing the type of the job (e.e. "SPH").

Reimplemented from SphJob.

Definition at line 43 of file SimulationJobs.h.

◆ getRun()

AutoPtr< IRun > SphStabilizationJob::getRun ( const RunSettings overrides) const
overridevirtual

Returns the actual simulation object.

This provides a way to implement the job functionality, as function evaluate is final and used only internally.

Parameters
overridesSettings overriding the current settings of the job.

Reimplemented from SphJob.

Definition at line 379 of file SimulationJobs.cpp.

◆ getSettings()

VirtualSettings SphStabilizationJob::getSettings ( )
overridevirtual

Returns a settings object which allows to query and modify the state of the job.

It is not necessary to expose all state variables this way. This is mainly intended for (de)serialization of the job state and for connection with UI controls.

Reimplemented from SphJob.

Definition at line 370 of file SimulationJobs.cpp.

◆ SphJob()

SphJob::SphJob
explicit

Definition at line 13 of file SimulationJobs.cpp.


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