eonc::Job Class Reference

Declaration of job class. More...

#include <Job.h>

Inheritance diagram for eonc::Job:

Public Member Functions
	Job (std::unique_ptr< Parameters > parameters)
	Job (std::shared_ptr< Potential > potPassed, const Parameters &parameters)
virtual	~Job ()=default
virtual std::vector< std::string >	run ()=0
	Virtual run; used solely for dynamic dispatch.
JobType	getType ()

Protected Attributes
JobType	jtype
Parameters	params
std::shared_ptr< Potential >	pot

Detailed Description

Declaration of job class.

Definition at line 49 of file Job.h.

Constructor & Destructor Documentation

Job() [1/2]

eonc::Job::Job ( std::unique_ptr< Parameters > parameters )

inline

Definition at line 58 of file Job.h.

      : jtype{parameters->main_options.job},
        params{*std::move(parameters)},
        pot{helpers::makePotential(params.potential_options.potential,
                                   params)} {}

Job() [2/2]

eonc::Job::Job ( std::shared_ptr< Potential > potPassed, const Parameters & parameters )

inline

Definition at line 63 of file Job.h.

      : jtype{parameters.main_options.job},
        params{parameters},
        pot{potPassed} {}

~Job()

virtual eonc::Job::~Job ( )

virtualdefault

Member Function Documentation

getType()

JobType eonc::Job::getType ( )

inlinenodiscard

Definition at line 70 of file Job.h.

{ return this->jtype; };

run()

virtual std::vector< std::string > eonc::Job::run ( )

pure virtual

Virtual run; used solely for dynamic dispatch.

Implemented in BasinHoppingJob, DynamicsJob, eonc::BasinHoppingJob, eonc::DynamicsJob, eonc::FiniteDifferenceJob, eonc::GlobalOptimizationJob, eonc::GPSurrogateJob, eonc::HessianJob, eonc::MinimizationJob, eonc::MonteCarloJob, eonc::NudgedElasticBandJob, eonc::OHTSTJob, eonc::ParallelReplicaJob, eonc::PointJob, eonc::PrefactorJob, eonc::ProcessSearchJob, eonc::ReplicaDynamicsJob, eonc::ReplicaExchangeJob, eonc::SaddleSearchJob, eonc::StructureComparisonJob, eonc::TestJob, FiniteDifferenceJob, GlobalOptimizationJob, GPSurrogateJob, HessianJob, MinimizationJob, MonteCarloJob, NudgedElasticBandJob, OHTSTJob, ParallelReplicaJob, PointJob, PrefactorJob, ProcessSearchJob, ReplicaDynamicsJob, ReplicaExchangeJob, SaddleSearchJob, StructureComparisonJob, and TestJob.

Member Data Documentation

jtype

JobType eonc::Job::jtype

protected

Definition at line 53 of file Job.h.

params

Parameters eonc::Job::params

protected

Definition at line 54 of file Job.h.

pot

std::shared_ptr<Potential> eonc::Job::pot

protected

Definition at line 55 of file Job.h.

---

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

• /home/runner/work/eOn/eOn/include/eon/Job.h