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

#include <InitialConditionJobs.h>

Inheritance diagram for ImpactorIc:
MonolithicBodyIc IParticleJob MaterialProvider IJob Polymorphic

Public Member Functions

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

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 Member Functions inherited from MaterialProvider
void addMaterialEntries (VirtualSettings::Category &category, Function< bool()> enabler)
 
- Protected Attributes inherited from MonolithicBodyIc
struct {
   bool   shape = false
 
   bool   material = false
 
slotUsage
 
- 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...
 
- Protected Attributes inherited from MaterialProvider
BodySettings body
 

Detailed Description

Definition at line 95 of file InitialConditionJobs.h.

Constructor & Destructor Documentation

◆ ImpactorIc()

ImpactorIc::ImpactorIc ( const std::string &  name,
const BodySettings overrides = EMPTY_SETTINGS 
)
inline

Definition at line 97 of file InitialConditionJobs.h.

Member Function Documentation

◆ className()

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

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

Reimplemented from MonolithicBodyIc.

Definition at line 100 of file InitialConditionJobs.h.

◆ evaluate()

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

Reimplemented from MonolithicBodyIc.

Definition at line 324 of file InitialConditionJobs.cpp.

◆ getSlots()

virtual UnorderedMap<std::string, ExtJobType> ImpactorIc::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.

Reimplemented from MonolithicBodyIc.

Definition at line 111 of file InitialConditionJobs.h.

◆ requires()

virtual UnorderedMap<std::string, ExtJobType> ImpactorIc::requires ( ) const
inlineoverridevirtual

List of slots that need to be connected to evaluate the job.

The returned map shall contain names of the slots and their types. No two slots can have the same name. This list can can be changed, based on internal state of the job.

Reimplemented from MonolithicBodyIc.

Definition at line 105 of file InitialConditionJobs.h.


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