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

#include <InitialConditionJobs.h>

Inheritance diagram for EquilibriumIc:
IParticleJob IJob Polymorphic

Public Member Functions

 EquilibriumIc (const std::string &name)
 
virtual std::string className () const override
 Name representing the type of the job (e.e. "SPH"). More...
 
virtual UnorderedMap< std::string, ExtJobTypegetSlots () const override
 Lists all potential inputs of the job. More...
 
virtual VirtualSettings getSettings () override
 Returns a settings object which allows to query and modify the state of the job. More...
 
virtual void evaluate (const RunSettings &global, IRunCallbacks &UNUSED(callbacks)) 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...
 
virtual UnorderedMap< std::string, ExtJobTyperequires () const
 List of slots that need to be connected to evaluate the job. More...
 
virtual void evaluate (const RunSettings &global, IRunCallbacks &callbacks)=0
 Runs the operation provided by the job. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Additional Inherited Members

- 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 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 125 of file InitialConditionJobs.h.

Constructor & Destructor Documentation

◆ EquilibriumIc()

EquilibriumIc::EquilibriumIc ( const std::string &  name)

Definition at line 359 of file InitialConditionJobs.cpp.

Member Function Documentation

◆ className()

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

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

Implements IJob.

Definition at line 133 of file InitialConditionJobs.h.

◆ evaluate()

void EquilibriumIc::evaluate ( const RunSettings global,
IRunCallbacks UNUSEDcallbacks 
)
overridevirtual

Definition at line 453 of file InitialConditionJobs.cpp.

◆ getSettings()

VirtualSettings EquilibriumIc::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.

Implements IJob.

Definition at line 365 of file InitialConditionJobs.cpp.

◆ getSlots()

virtual UnorderedMap<std::string, ExtJobType> EquilibriumIc::getSlots ( ) const
inlineoverridevirtual

Lists all potential inputs of the job.

This is the superset of slots returned by function requires and it has to be fixed, i.e. cannot change when internal state of the job changes.

Implements IJob.

Definition at line 137 of file InitialConditionJobs.h.


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