TrackRun Class Reference

#include <TrackRun.h>

Inheritance diagram for TrackRun:

Collaboration diagram for TrackRun:

Public Member Functions
	TrackRun ()
	Exemplar constructor.
virtual	~TrackRun ()
virtual TrackRun *	clone (const std::string &name)
	Make clone.
virtual void	execute ()
	Execute the command.
Inform &	print (Inform &os) const
Public Member Functions inherited from Action
virtual	~Action ()
virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed.
virtual const std::string	getCategory () const
	Return the object category as a string.
virtual bool	shouldTrace () const
	Trace flag.
virtual bool	shouldUpdate () const
	Update flag.
Public Member Functions inherited from Object
virtual	~Object ()
void	copyAttributes (const Object &)
	Copy attributes from another object.
virtual Attribute *	findAttribute (const std::string &name)
	Find an attribute by name.
virtual const Attribute *	findAttribute (const std::string &name) const
	Find an attribute by name.
virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Macro handler function.
virtual Object *	makeInstance (const std::string &name, Statement &, const Parser *)
	Macro handler function.
virtual void	parse (Statement &)
	Parse the object.
virtual void	parseShortcut (Statement &, bool eval=true)
	Parser for single-attribute commands.
virtual void	print (std::ostream &) const
	Print the object.
virtual void	printValue (std::ostream &) const
virtual void	printHelp (std::ostream &) const
	Print help.
virtual void	replace (Object *oldObject, Object *newObject)
	Replace references.
virtual void	update ()
	Update this object.
bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object.
virtual bool	isShared () const
	Shared flag.
virtual void	setShared (bool)
	Set/reset shared flag.
void	setDirty (bool)
	Set/reset the [b]modified[/b] flag.
bool	isDirty () const
	True, if the [b]modified[/b] flag is set.
void	setFlag (bool)
	Flag/unflag this object, e. g. to control output of objects for.
bool	isFlagged () const
	True, if [b]this[/b] is flagged by setFlag(true).
const Object *	getBaseObject () const
	Return the object's base type object.
const std::string &	getOpalName () const
	Return object name.
Object *	getParent () const
	Return parent pointer.
bool	isTreeMember (const Object *subTree) const
	Test for tree membership.
void	setOpalName (const std::string &name)
	Set object name.
void	setParent (Object *)
	Set parent object.
void	clear ()
	Clear the occurrence counter.
int	increment ()
	Increment and return the occurrence counter.
int	occurrenceCount ()
	Return the occurrence counter.
void	registerReference (Invalidator *a)
	Register a reference to this object.
void	unregisterReference (Invalidator *a)
	Unegister a reference to this object.
void	registerOwnership (const AttributeHandler::OwnerType &itsClass) const
Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count.
int	removeReference () const
	Decrement the reference count.
bool	isShared () const
	Test for sharing.

Static Public Member Functions
static std::shared_ptr< Tracker >	getTracker ()

Private Types
enum class	RunMethod : unsigned short { NONE , PARALLELT , CYCLOTRONT , THICK }

Private Member Functions
	TrackRun (const TrackRun &)
void	operator= (const TrackRun &)
	TrackRun (const std::string &name, TrackRun *parent)
void	setRunMethod ()
std::string	getRunMethodName () const
void	setupTTracker ()
void	setupCyclotronTracker ()
void	setupThickTracker ()
void	setupFieldsolver ()
void	initPhaseSpaceSink ()
void	initDataSink (const int &numBunch=1)
void	setBoundaryGeometry ()
double	setDistributionParallelT (Beam *beam)

Private Attributes
Distribution *	dist_m
std::vector< Distribution * >	distrs_m
FieldSolver *	fieldSolver_m
DataSink *	dataSink_m
H5PartWrapper *	phaseSpaceSink_m
OpalData *	opalData_m
bool	isFollowupTrack_m
RunMethod	method_m
double	macromass_m
double	macrocharge_m

Static Private Attributes
static constexpr std::array< std::pair< RunMethod, std::string_view >, 5 >	runMethodMap
static std::shared_ptr< Tracker >	itsTracker_m = nullptr
static const std::string	defaultDistribution

Additional Inherited Members
Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes.
Protected Member Functions inherited from Action
	Action (int size, const char *name, const char *help)
	Constructor for exemplars.
	Action (const std::string &name, Action *parent)
	Constructor for cloning.
Protected Member Functions inherited from Object
	Object (int size, const char *name, const char *help)
	Constructor for exemplars.
	Object (const std::string &name, Object *parent)
	Constructor for clones.
Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor.
	RCObject (const RCObject &)
	Copy constructor.
virtual	~RCObject ()=0
RCObject &	operator= (const RCObject &right)
Protected Attributes inherited from Object
bool	builtin
	Built-in flag.
bool	modified
	Dirty flag.
bool	flagged
	Object flag.

Detailed Description

Definition at line 39 of file TrackRun.h.

Member Enumeration Documentation

RunMethod

enum class TrackRun::RunMethod : unsigned short

strongprivate

Enumerator
NONE
PARALLELT
CYCLOTRONT
THICK

Definition at line 59 of file TrackRun.h.

Constructor & Destructor Documentation

TrackRun() [1/3]

TrackRun::TrackRun

(

)

Exemplar constructor.

Definition at line 83 of file TrackRun.cpp.

References OpalData::getInstance(), Object::itsAttr, Attributes::makeBool(), Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeString(), Attributes::makeStringArray(), opalData_m, Object::registerOwnership(), and AttributeHandler::SUB_COMMAND.

Referenced by clone().

Here is the call graph for this function:

~TrackRun()

TrackRun::~TrackRun ( )

virtual

Definition at line 148 of file TrackRun.cpp.

References phaseSpaceSink_m.

TrackRun() [2/3]

TrackRun::TrackRun ( const TrackRun &  )

private

TrackRun() [3/3]

TrackRun::TrackRun ( const std::string &  name, TrackRun *  parent  )

private

Definition at line 135 of file TrackRun.cpp.

References OpalData::getInstance(), and opalData_m.

Here is the call graph for this function:

Member Function Documentation

clone()

TrackRun * TrackRun::clone ( const std::string &  name )

virtual

Make clone.

Implements Object.

Definition at line 152 of file TrackRun.cpp.

References name, and TrackRun().

Here is the call graph for this function:

execute()

void TrackRun::execute ( )

virtual

Execute the command.

Reimplemented from Object.

Definition at line 156 of file TrackRun.cpp.

References begin(), OpalData::bunchIsAllocated(), Versions::changes, CYCLOTRONT, endl(), Attributes::getReal(), OpalData::hasBunchAllocated(), isFollowupTrack_m, Object::itsAttr, itsTracker_m, method_m, opalData_m, PARALLELT, OpalData::setRestartRun(), setRunMethod(), setupCyclotronTracker(), setupThickTracker(), setupTTracker(), THICK, and Options::version.

Here is the call graph for this function:

getRunMethodName()

std::string TrackRun::getRunMethodName ( ) const

private

Definition at line 248 of file TrackRun.cpp.

References Util::enumToString(), method_m, and runMethodMap.

Referenced by print().

Here is the call graph for this function:

getTracker()

std::shared_ptr< Tracker > TrackRun::getTracker ( )

static

Definition at line 716 of file TrackRun.cpp.

References itsTracker_m.

Referenced by PyOpal::Field::get_field_value(), and PyOpal::Field::getRing().

initDataSink()

void TrackRun::initDataSink ( const int &  numBunch = 1 )

private

Definition at line 594 of file TrackRun.cpp.

References DataSink::changeH5Wrapper(), dataSink_m, OpalData::getDataSink(), OpalData::hasDataSinkAllocated(), OpalData::inRestartRun(), opalData_m, phaseSpaceSink_m, and OpalData::setDataSink().

Referenced by setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

Here is the call graph for this function:

initPhaseSpaceSink()

void TrackRun::initPhaseSpaceSink ( )

private

Definition at line 558 of file TrackRun.cpp.

References Options::enableHDF5, OpalData::getInputBasename(), OpalData::getRestartFileName(), OpalData::getRestartStep(), OpalData::inRestartRun(), isFollowupTrack_m, OpalData::isInOPALCyclMode(), opalData_m, and phaseSpaceSink_m.

Referenced by setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

Here is the call graph for this function:

operator=()

void TrackRun::operator= ( const TrackRun &  )

private

print()

Inform & TrackRun::print

(

Inform &

os

)

const

Definition at line 692 of file TrackRun.cpp.

References Track::block, CYCLOTRONT, Track::dT, endl(), Attributes::getReal(), getRunMethodName(), isFollowupTrack_m, Object::itsAttr, Track::localTimeSteps, macrocharge_m, macromass_m, method_m, Options::psDumpFreq, Options::statDumpFreq, and Track::stepsPerTurn.

Referenced by operator<<().

Here is the call graph for this function:

setBoundaryGeometry()

void TrackRun::setBoundaryGeometry ( )

private

Definition at line 608 of file TrackRun.cpp.

References BoundaryGeometry::clone(), BoundaryGeometry::find(), Attributes::getString(), OpalData::hasGlobalGeometry(), Object::itsAttr, opalData_m, and OpalData::setGlobalGeometry().

Referenced by setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

Here is the call graph for this function:

setDistributionParallelT()

double TrackRun::setDistributionParallelT ( Beam *  beam )

private

Definition at line 621 of file TrackRun.cpp.

References Track::block, Track::bunch, defaultDistribution, dist_m, distrs_m, Distribution::doRestartOpalT(), endl(), Distribution::find(), Beam::getChargePerParticle(), Distribution::getEmissionTimeShift(), Beam::getNumberOfParticles(), OpalData::getRestartStep(), Attributes::getStringArray(), Distribution::getTEmission(), gmsg, OpalData::inRestartRun(), isFollowupTrack_m, Object::itsAttr, opalData_m, phaseSpaceSink_m, PartBunchBase< T, Dim >::setDistribution(), OpalData::setGlobalPhaseShift(), and Distribution::setNumberOfDistributions().

Referenced by setupThickTracker(), and setupTTracker().

Here is the call graph for this function:

setRunMethod()

void TrackRun::setRunMethod ( )

private

Definition at line 239 of file TrackRun.cpp.

References Attributes::getString(), Object::itsAttr, method_m, NONE, runMethodMap, and Util::stringToEnum().

Referenced by execute().

Here is the call graph for this function:

setupCyclotronTracker()

void TrackRun::setupCyclotronTracker ( )

private

getFrequency() gets RF frequency [MHz], NOT isochronous revolution frequency of particle! getCurrent() gets beamcurrent [A]

Definition at line 411 of file TrackRun.cpp.

References Track::block, Track::bunch, PartBunchBase< T, Dim >::calcBeamParameters(), dataSink_m, defaultDistribution, dist_m, Distribution::doRestartOpalCycl(), endl(), Physics::epsilon_0, BeamSequence::fetchLine(), fieldSolver_m, Distribution::find(), Beam::find(), H5PartWrapperForPC::getAzimuth(), Beam::getCharge(), Beam::getChargePerParticle(), Beam::getCurrent(), H5PartWrapperForPC::getElevation(), Beam::getFrequency(), Beam::getMass(), Beam::getMassPerParticle(), H5PartWrapperForPC::getMeanMomentum(), Beam::getNumberOfParticles(), Beam::getParticleName(), H5PartWrapperForPC::getPreviousH5Local(), Attributes::getReal(), H5PartWrapperForPC::getReferencePr(), H5PartWrapperForPC::getReferencePt(), H5PartWrapperForPC::getReferencePz(), H5PartWrapperForPC::getReferenceR(), H5PartWrapperForPC::getReferenceT(), H5PartWrapperForPC::getReferenceZ(), OpalData::getRestartStep(), Attributes::getString(), Attributes::getStringArray(), gmsg, initDataSink(), initPhaseSpaceSink(), OpalData::inRestartRun(), isFollowupTrack_m, Object::itsAttr, itsTracker_m, Track::localTimeSteps, macrocharge_m, macromass_m, Units::MHz2Hz, opalData_m, phaseSpaceSink_m, Physics::pi, PartBunchBase< T, Dim >::POrigin, Physics::q_e, Track::reference, REGULAR, ParallelCyclotronTracker::setBeGa(), setBoundaryGeometry(), PartBunchBase< T, Dim >::setCharge(), PartBunchBase< T, Dim >::setCouplingConstant(), PartBunchBase< T, Dim >::setDistribution(), PartBunchBase< T, Dim >::setdT(), OpalData::setInOPALCyclMode(), ParallelCyclotronTracker::setLastDumpedStep(), PartBunchBase< T, Dim >::setMass(), ParallelCyclotronTracker::setPhi(), ParallelCyclotronTracker::setPr(), ParallelCyclotronTracker::setPreviousH5Local(), ParallelCyclotronTracker::setPsi(), ParallelCyclotronTracker::setPt(), PartBunchBase< T, Dim >::setPType(), ParallelCyclotronTracker::setPz(), ParallelCyclotronTracker::setR(), PartBunchBase< T, Dim >::setStepsPerTurn(), ParallelCyclotronTracker::setTheta(), setupFieldsolver(), ParallelCyclotronTracker::setZ(), Track::timeIntegrator, and Track::use.

Referenced by execute().

setupFieldsolver()

void TrackRun::setupFieldsolver ( )

private

Definition at line 525 of file TrackRun.cpp.

References OpalData::addProblemCharacteristicValue(), Options::amr, Track::block, Track::bunch, fieldSolver_m, Beam::find(), FieldSolver::find(), FieldSolver::getFieldSolverType(), FieldSolver::getMT(), FieldSolver::getMX(), FieldSolver::getMY(), Beam::getNumberOfParticles(), Attributes::getString(), FieldSolver::hasPeriodicZ(), FieldSolver::initCartesianFields(), OpalData::inRestartRun(), Object::itsAttr, NONE, opalData_m, P3M, SAAMG, PartBunchBase< T, Dim >::setBCAllOpen(), PartBunchBase< T, Dim >::setBCForDCBeam(), and PartBunchBase< T, Dim >::setSolver().

Referenced by setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

Here is the call graph for this function:

setupThickTracker()

void TrackRun::setupThickTracker ( )

private

Definition at line 252 of file TrackRun.cpp.

References Track::block, Track::bunch, PartBunchBase< T, Dim >::calcBeamParameters(), dataSink_m, Track::deltaTau, PartBunchBase< T, Dim >::deltaTau_m, dist_m, Track::dT, Track::dtScInit, PartBunchBase< T, Dim >::dtScInit_m, endl(), Physics::epsilon_0, fieldSolver_m, Beam::find(), Attributes::getString(), gmsg, initDataSink(), initPhaseSpaceSink(), OpalData::inRestartRun(), isFollowupTrack_m, Object::itsAttr, itsTracker_m, Track::localTimeSteps, macrocharge_m, opalData_m, Physics::pi, Track::reference, setBoundaryGeometry(), PartBunchBase< T, Dim >::setCharge(), PartBunchBase< T, Dim >::setChargeZeroPart(), PartBunchBase< T, Dim >::setCouplingConstant(), setDistributionParallelT(), PartBunchBase< T, Dim >::setdT(), PartBunchBase< T, Dim >::setLocalTrackStep(), PartBunchBase< T, Dim >::setT(), setupFieldsolver(), Track::truncOrder, Track::zstart, and Track::zstop.

Referenced by execute().

Here is the call graph for this function:

setupTTracker()

void TrackRun::setupTTracker ( )

private

Definition at line 327 of file TrackRun.cpp.

References Track::block, Track::bunch, PartBunchBase< T, Dim >::calcBeamParameters(), dataSink_m, Track::deltaTau, PartBunchBase< T, Dim >::deltaTau_m, dist_m, Track::dT, Track::dtScInit, PartBunchBase< T, Dim >::dtScInit_m, endl(), Physics::epsilon_0, fieldSolver_m, Beam::find(), Attributes::getBool(), Beam::getFrequency(), Beam::getMassPerParticle(), Beam::getParticleName(), Attributes::getString(), gmsg, initDataSink(), initPhaseSpaceSink(), OpalData::inRestartRun(), isFollowupTrack_m, Object::itsAttr, itsTracker_m, Track::localTimeSteps, macrocharge_m, macromass_m, Units::MHz2Hz, opalData_m, Physics::pi, Track::reference, PartBunchBase< T, Dim >::setBeamFrequency(), setBoundaryGeometry(), PartBunchBase< T, Dim >::setCharge(), PartBunchBase< T, Dim >::setChargeZeroPart(), PartBunchBase< T, Dim >::setCouplingConstant(), setDistributionParallelT(), PartBunchBase< T, Dim >::setdT(), OpalData::setInOPALTMode(), PartBunchBase< T, Dim >::setLocalTrackStep(), PartBunchBase< T, Dim >::setMass(), PartBunchBase< T, Dim >::setMassZeroPart(), PartBunchBase< T, Dim >::setPType(), PartBunchBase< T, Dim >::setT(), setupFieldsolver(), Track::zstart, and Track::zstop.

Referenced by execute().

Here is the call graph for this function:

Member Data Documentation

dataSink_m

DataSink* TrackRun::dataSink_m

private

Definition at line 106 of file TrackRun.h.

Referenced by initDataSink(), setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

defaultDistribution

const std::string TrackRun::defaultDistribution

staticprivate

Definition at line 114 of file TrackRun.h.

Referenced by setDistributionParallelT(), and setupCyclotronTracker().

dist_m

Distribution* TrackRun::dist_m

private

Definition at line 101 of file TrackRun.h.

Referenced by setDistributionParallelT(), setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

distrs_m

std::vector<Distribution*> TrackRun::distrs_m

private

Definition at line 102 of file TrackRun.h.

Referenced by setDistributionParallelT().

fieldSolver_m

FieldSolver* TrackRun::fieldSolver_m

private

Definition at line 104 of file TrackRun.h.

Referenced by setupCyclotronTracker(), setupFieldsolver(), setupThickTracker(), and setupTTracker().

isFollowupTrack_m

bool TrackRun::isFollowupTrack_m

private

Definition at line 112 of file TrackRun.h.

Referenced by execute(), initPhaseSpaceSink(), print(), setDistributionParallelT(), setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

itsTracker_m

std::shared_ptr< Tracker > TrackRun::itsTracker_m = nullptr

staticprivate

Definition at line 99 of file TrackRun.h.

Referenced by execute(), getTracker(), setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

macrocharge_m

double TrackRun::macrocharge_m

private

Definition at line 120 of file TrackRun.h.

Referenced by print(), setupCyclotronTracker(), setupThickTracker(), and setupTTracker().

macromass_m

double TrackRun::macromass_m

private

Definition at line 119 of file TrackRun.h.

Referenced by print(), setupCyclotronTracker(), and setupTTracker().

method_m

RunMethod TrackRun::method_m

private

Definition at line 116 of file TrackRun.h.

Referenced by execute(), getRunMethodName(), print(), and setRunMethod().

opalData_m

OpalData* TrackRun::opalData_m

private

Definition at line 110 of file TrackRun.h.

Referenced by execute(), initDataSink(), initPhaseSpaceSink(), setBoundaryGeometry(), setDistributionParallelT(), setupCyclotronTracker(), setupFieldsolver(), setupThickTracker(), setupTTracker(), TrackRun(), and TrackRun().

phaseSpaceSink_m

H5PartWrapper* TrackRun::phaseSpaceSink_m

private

Definition at line 108 of file TrackRun.h.

Referenced by initDataSink(), initPhaseSpaceSink(), setDistributionParallelT(), setupCyclotronTracker(), and ~TrackRun().

runMethodMap

constexpr std::array<std::pair<RunMethod, std::string_view>, 5> TrackRun::runMethodMap

inlinestaticconstexprprivate

Initial value:

{{
        {TrackRun::RunMethod::PARALLELT,  "PARALLEL-T"},
        {TrackRun::RunMethod::CYCLOTRONT, "CYCLOTRON-T"},
        {TrackRun::RunMethod::THICK,      "THICK"}
    }}

Definition at line 66 of file TrackRun.h.

Referenced by getRunMethodName(), and setRunMethod().

---

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

• src/Track/TrackRun.h
• src/Track/TrackRun.cpp