eonc::Job Class Reference

Declaration of job class. More...

#include <Job.h>

Inheritance diagram for eonc::Job:

Public Member Functions
void	adoptRuntime (std::unique_ptr< Runtime > rt)
	Take ownership of a Runtime previously passed as Runtime&.
	Job (std::unique_ptr< Parameters > parameters, Runtime &rt)
	Borrow: caller keeps Runtime alive (CLI stack / Python Session).
	Job (std::unique_ptr< Parameters > parameters, std::unique_ptr< Runtime > rt)
	Own a Runtime (one-shot makeJob / rvalue).
	Job (std::unique_ptr< Parameters > parameters)
	Own a default-constructed Runtime.
	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 ()
PotRegistry &	pots () noexcept
void	releasePotential ()
	Drop the Potential so on_destroyed is recorded before Runtime dies.

Protected Attributes
JobType	jtype
Parameters	params
std::unique_ptr< Runtime >	owned_runtime_
	Non-null when this Job owns the composition root (one-shot makeJob).
Runtime *	runtime_
	Always valid: either owned_runtime_.get() or a caller-owned Runtime.
std::shared_ptr< Potential >	pot

Detailed Description

Declaration of job class.

Definition at line 53 of file Job.h.

Constructor & Destructor Documentation

Job() [1/4]

eonc::Job::Job ( std::unique_ptr< Parameters > parameters, Runtime & rt )

inline

Borrow: caller keeps Runtime alive (CLI stack / Python Session).

Definition at line 76 of file Job.h.

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

Job() [2/4]

eonc::Job::Job ( std::unique_ptr< Parameters > parameters, std::unique_ptr< Runtime > rt )

inline

Own a Runtime (one-shot makeJob / rvalue).

Definition at line 84 of file Job.h.

      : Job(std::move(parameters), *rt) {
    adoptRuntime(std::move(rt));
  }

Job() [3/4]

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

inlineexplicit

Own a default-constructed Runtime.

Definition at line 89 of file Job.h.

      : Job(std::move(parameters), std::make_unique<Runtime>()) {}

Job() [4/4]

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

inline

Definition at line 91 of file Job.h.

      : jtype{parameters.main_options().job},
        params{parameters},
        owned_runtime_{std::make_unique<Runtime>()},
        runtime_{owned_runtime_.get()},
        pot{potPassed} {}

~Job()

virtual eonc::Job::~Job ( )

virtualdefault

Member Function Documentation

adoptRuntime()

void eonc::Job::adoptRuntime ( std::unique_ptr< Runtime > rt )

inline

Take ownership of a Runtime previously passed as Runtime&.

Definition at line 67 of file Job.h.

                                               {
    if (!rt || runtime_ != rt.get()) {
      throw std::logic_error(
          "Job::adoptRuntime: Runtime is not the borrowed instance");
    }
    owned_runtime_ = std::move(rt);
  }

getType()

JobType eonc::Job::getType ( )

inlinenodiscard

Definition at line 100 of file Job.h.

{ return this->jtype; };

pots()

PotRegistry & eonc::Job::pots ( )

inlinenodiscardnoexcept

Definition at line 101 of file Job.h.

{ return runtime_->pots(); }

releasePotential()

void eonc::Job::releasePotential ( )

inline

Drop the Potential so on_destroyed is recorded before Runtime dies.

Definition at line 103 of file Job.h.

{ pot.reset(); }

run()

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

pure virtual

Virtual run; used solely for dynamic dispatch.

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

Member Data Documentation

jtype

JobType eonc::Job::jtype

protected

Definition at line 57 of file Job.h.

owned_runtime_

std::unique_ptr<Runtime> eonc::Job::owned_runtime_

protected

Non-null when this Job owns the composition root (one-shot makeJob).

Definition at line 60 of file Job.h.

params

Parameters eonc::Job::params

protected

Definition at line 58 of file Job.h.

pot

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

protected

Definition at line 63 of file Job.h.

runtime_

Runtime* eonc::Job::runtime_

protected

Always valid: either owned_runtime_.get() or a caller-owned Runtime.

Definition at line 62 of file Job.h.

---

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

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