#include "objects/containers/UnorderedMap.h"
#include "objects/geometry/Domain.h"
#include "objects/wrappers/ExtendedEnum.h"
#include "objects/wrappers/SharedPtr.h"
#include "quantities/Storage.h"
#include "run/VirtualSettings.h"
#include "system/Settings.h"
#include "system/Statistics.h"
#include "Job.inl.h"

Classes
class	IJobData

struct	ParticleData

class	JobContext
	Data exchanged by jobs. More...

class	IJob
	Base class for all object performing an operation in a simulation hierarchy. More...

class	IJobDesc
	Provides a descriptor of a job that allows to create new instances. More...

struct	JobRegistrar
	Helper class, allowing to register job into the global list of jobs. More...

class	IParticleJob
	Base class for all jobs providing particle data. More...

class	IRunJob
	Base class for jobs running a simulation. More...

class	IGeometryJob
	Base class for jobs providing a geometric shape. More...

class	IMaterialJob
	Base class for jobs providing a material. More...

class	INullJob
	Base class for jobs providing no data. More...

Typedefs
using	ExtJobType = ExtendedEnum< JobType >

using	CreateJobFunc = Function< AutoPtr< IJob >(std::string name)>

Enumerations
enum class	JobType { PARTICLES , MATERIAL , GEOMETRY }

Functions
ArrayView< const AutoPtr< IJobDesc > >	enumerateRegisteredJobs ()
	Returns a view of all currently registered jobs. More...

RawPtr< IJobDesc >	getJobDesc (const std::string &name)
	Returns a job descriptor for given class name. More...

VirtualSettings::Category &	addGenericCategory (VirtualSettings &connector, std::string &instanceName)
	Adds a common settings category, used by all jobs. More...

Typedef Documentation

◆ CreateJobFunc

using CreateJobFunc = Function<AutoPtr<IJob>(std::string name)>

Definition at line 196 of file Job.h.

◆ ExtJobType

using ExtJobType = ExtendedEnum<JobType>

Definition at line 31 of file Job.h.

Enumeration Type Documentation

◆ JobType

enum JobType

strong

Enumerator
PARTICLES	Job providing particles.
MATERIAL	Job providing a material.
GEOMETRY	Job providing geometry.

Definition at line 20 of file Job.h.

Function Documentation

◆ addGenericCategory()

VirtualSettings::Category& addGenericCategory	(	VirtualSettings &	connector,
		std::string &	instanceName
	)

Adds a common settings category, used by all jobs.

The category currently obtains only an entry for the instance name of the job.

Definition at line 43 of file Job.cpp.

◆ enumerateRegisteredJobs()

ArrayView<const AutoPtr<IJobDesc> > enumerateRegisteredJobs ( )

Returns a view of all currently registered jobs.

Definition at line 30 of file Job.cpp.

◆ getJobDesc()

RawPtr<IJobDesc> getJobDesc ( const std::string & name )

Returns a job descriptor for given class name.

Only descriptors registered via jobRegistrar can be obtained this way. If no descriptor with given name exists, the function returns nullptr.

Definition at line 34 of file Job.cpp.

Classes

Typedefs

Enumerations

Functions