#include <TrackRun.h>

Inheritance diagram for TrackRun:

[legend]

Collaboration diagram for TrackRun:

[legend]

Public Member Functions
	TrackRun ()
	Exemplar constructor. More...

virtual	~TrackRun ()

virtual TrackRun *	clone (const std::string &name)
	Make clone. More...

virtual void	execute ()
	Execute the command. More...

Inform &	print (Inform &os) const

Public Member Functions inherited from Action
virtual	~Action ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual const std::string	getCategory () const
	Return the object category as a string. More...

virtual bool	shouldTrace () const
	Trace flag. More...

virtual bool	shouldUpdate () const
	Update flag. More...

Public Member Functions inherited from Object
virtual	~Object ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual Object *	clone (const std::string &name)=0
	Return a clone. More...

void	copyAttributes (const Object &)
	Copy attributes from another object. More...

virtual void	execute ()
	Execute the command. More...

virtual Attribute *	findAttribute (const std::string &name)
	Find an attribute by name. More...

virtual const Attribute *	findAttribute (const std::string &name) const
	Find an attribute by name. More...

virtual const std::string	getCategory () const =0
	Return the object category as a string. More...

virtual bool	shouldTrace () const =0
	Trace flag. More...

virtual bool	shouldUpdate () const =0
	Update flag. More...

virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Macro handler function. More...

virtual Object *	makeInstance (const std::string &name, Statement &, const Parser *)
	Macro handler function. More...

virtual void	parse (Statement &)
	Parse the object. More...

virtual void	parseShortcut (Statement &, bool eval=true)
	Parser for single-attribute commands. More...

virtual void	print (std::ostream &) const
	Print the object. More...

virtual void	printValue (std::ostream &) const

virtual void	printHelp (std::ostream &) const
	Print help. More...

virtual void	replace (Object oldObject, Object newObject)
	Replace references. More...

virtual void	update ()
	Update this object. More...

bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object. More...

virtual bool	isShared () const
	Shared flag. More...

virtual void	setShared (bool)
	Set/reset shared flag. More...

void	setDirty (bool)
	Set/reset the [b]modified[/b] flag. More...

bool	isDirty () const
	True, if the [b]modified[/b] flag is set. More...

void	setFlag (bool)
	Flag/unflag this object, e. g. to control output of objects for. More...

bool	isFlagged () const
	True, if [b]this[/b] is flagged by setFlag(true). More...

const Object *	getBaseObject () const
	Return the object's base type object. More...

const std::string &	getOpalName () const
	Return object name. More...

Object *	getParent () const
	Return parent pointer. More...

bool	isTreeMember (const Object *subTree) const
	Test for tree membership. More...

void	setOpalName (const std::string &name)
	Set object name. More...

void	setParent (Object *)
	Set parent object. More...

void	clear ()
	Clear the occurrence counter. More...

int	increment ()
	Increment and return the occurrence counter. More...

int	occurrenceCount ()
	Return the occurrence counter. More...

void	registerReference (Invalidator *a)
	Register a reference to this object. More...

void	unregisterReference (Invalidator *a)
	Unegister a reference to this object. More...

void	registerOwnership (const AttributeHandler::OwnerType &itsClass) const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...

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	initDataSink (const int &numBunch=1)

void	setBoundaryGeometry ()

double	setDistributionParallelT (Beam *beam)

Private Attributes
Distribution *	dist

std::vector< Distribution * >	distrs_m

FieldSolver *	fs

DataSink *	ds

H5PartWrapper *	phaseSpaceSink_m

OpalData *	opal

bool	isFollowupTrack_m

RunMethod	method_m

double	macromass_m

double	macrocharge_m

Static Private Attributes
static std::shared_ptr< Tracker >	itsTracker = nullptr

static const std::string	defaultDistribution

static const boost::bimap< RunMethod, std::string >	stringMethod_s

Additional Inherited Members
Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes. More...

Protected Member Functions inherited from Action
	Action (int size, const char name, const char help)
	Constructor for exemplars. More...

	Action (const std::string &name, Action *parent)
	Constructor for cloning. More...

Protected Member Functions inherited from Object
	Object (int size, const char name, const char help)
	Constructor for exemplars. More...

	Object (const std::string &name, Object *parent)
	Constructor for clones. More...

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Protected Attributes inherited from Object
bool	builtin
	Built-in flag. More...

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Detailed Description

Definition at line 38 of file TrackRun.h.

Member Enumeration Documentation

◆ RunMethod

enum class TrackRun::RunMethod : unsigned short

strongprivate

Enumerator
NONE
PARALLELT
CYCLOTRONT
THICK

Definition at line 58 of file TrackRun.h.

Constructor & Destructor Documentation

◆ TrackRun() [1/3]

TrackRun::TrackRun ( )

Exemplar constructor.

Definition at line 93 of file TrackRun.cpp.

References Attrib::Legacy::Distribution::DISTRIBUTION, OpalData::getInstance(), Object::itsAttr, Attributes::makeBool(), Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeString(), Attributes::makeStringArray(), opal, Object::registerOwnership(), and AttributeHandler::SUB_COMMAND.

Referenced by clone().

Here is the call graph for this function:

◆ ~TrackRun()

TrackRun::~TrackRun ( )

virtual

Definition at line 160 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 146 of file TrackRun.cpp.

References OpalData::getInstance(), and opal.

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 165 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 170 of file TrackRun.cpp.

References begin(), OpalData::bunchIsAllocated(), Versions::changes, CYCLOTRONT, Attrib::Legacy::Distribution::DISTRIBUTION, endl(), Attributes::getReal(), OpalData::hasBunchAllocated(), isFollowupTrack_m, Object::itsAttr, itsTracker, method_m, opal, OPAL_VERSION_MAJOR, OPAL_VERSION_MINOR, 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 265 of file TrackRun.cpp.

References method_m, and stringMethod_s.

Referenced by print().

◆ getTracker()

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

static

Definition at line 737 of file TrackRun.cpp.

References itsTracker.

Referenced by PyOpal::Field::get_field_value().

◆ initDataSink()

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

private

Definition at line 615 of file TrackRun.cpp.

References DataSink::changeH5Wrapper(), ds, OpalData::getDataSink(), OpalData::hasDataSinkAllocated(), OpalData::inRestartRun(), opal, phaseSpaceSink_m, and OpalData::setDataSink().

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 713 of file TrackRun.cpp.

References abs(), 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 629 of file TrackRun.cpp.

References BoundaryGeometry::clone(), BoundaryGeometry::find(), OpalData::getInstance(), Attributes::getString(), Object::itsAttr, 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 642 of file TrackRun.cpp.

References Track::block, Track::bunch, defaultDistribution, dist, Attrib::Legacy::Distribution::DISTRIBUTION, 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, opal, 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 253 of file TrackRun.cpp.

References Attributes::getString(), Object::itsAttr, method_m, and stringMethod_s.

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 454 of file TrackRun.cpp.

Referenced by execute().

◆ setupFieldsolver()

void TrackRun::setupFieldsolver ( )

private

Definition at line 581 of file TrackRun.cpp.

References OpalData::addProblemCharacteristicValue(), Options::amr, Track::block, Track::bunch, Beam::find(), FieldSolver::find(), fs, FieldSolver::getFieldSolverType(), OpalData::getInstance(), FieldSolver::getMT(), FieldSolver::getMX(), FieldSolver::getMY(), Beam::getNumberOfParticles(), Attributes::getString(), FieldSolver::hasPeriodicZ(), FieldSolver::initCartesianFields(), OpalData::inRestartRun(), Object::itsAttr, NONE, opal, 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 269 of file TrackRun.cpp.

Referenced by execute().

Here is the call graph for this function:

◆ setupTTracker()

void TrackRun::setupTTracker ( )

private

Definition at line 357 of file TrackRun.cpp.

Referenced by execute().

Here is the call graph for this function:

Member Data Documentation

◆ defaultDistribution

const std::string TrackRun::defaultDistribution

staticprivate

Definition at line 106 of file TrackRun.h.

Referenced by setDistributionParallelT(), and setupCyclotronTracker().

◆ dist

Distribution* TrackRun::dist

private

Definition at line 92 of file TrackRun.h.

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

◆ distrs_m

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

private

Definition at line 94 of file TrackRun.h.

Referenced by setDistributionParallelT().

◆ ds

DataSink* TrackRun::ds

private

Definition at line 98 of file TrackRun.h.

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

◆ fs

FieldSolver* TrackRun::fs

private

Definition at line 96 of file TrackRun.h.

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

◆ isFollowupTrack_m

bool TrackRun::isFollowupTrack_m

private

Definition at line 104 of file TrackRun.h.

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

◆ itsTracker

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

staticprivate

Definition at line 90 of file TrackRun.h.

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

◆ macrocharge_m

double TrackRun::macrocharge_m

private

Definition at line 113 of file TrackRun.h.

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

◆ macromass_m

double TrackRun::macromass_m

private

Definition at line 112 of file TrackRun.h.

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

◆ method_m

RunMethod TrackRun::method_m

private

Definition at line 108 of file TrackRun.h.

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

◆ opal

OpalData* TrackRun::opal

private

Definition at line 102 of file TrackRun.h.

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

◆ phaseSpaceSink_m

H5PartWrapper* TrackRun::phaseSpaceSink_m

private

Definition at line 100 of file TrackRun.h.

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

◆ stringMethod_s

const boost::bimap< TrackRun::RunMethod, std::string > TrackRun::stringMethod_s

staticprivate

Initial value:

=
    boost::assign::list_of<const boost::bimap<TrackRun::RunMethod, std::string>::relation>
    (RunMethod::PARALLELT,  "PARALLEL-T")
    (RunMethod::CYCLOTRONT, "CYCLOTRON-T")
    (RunMethod::THICK,      "THICK")

Definition at line 109 of file TrackRun.h.

Referenced by getRunMethodName(), and setRunMethod().

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

/Users/gsell/src/OPAL/src/src/Track/TrackRun.h
/Users/gsell/src/OPAL/src/src/Track/TrackRun.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ RunMethod

Constructor & Destructor Documentation

◆ TrackRun() [1/3]

◆ ~TrackRun()

◆ TrackRun() [2/3]

◆ TrackRun() [3/3]

Member Function Documentation

◆ clone()

◆ execute()

◆ getRunMethodName()

◆ getTracker()

◆ initDataSink()

◆ operator=()

◆ print()

◆ setBoundaryGeometry()

◆ setDistributionParallelT()

◆ setRunMethod()

◆ setupCyclotronTracker()

◆ setupFieldsolver()

◆ setupThickTracker()

◆ setupTTracker()

Member Data Documentation

◆ defaultDistribution

◆ dist

◆ distrs_m

◆ ds

◆ fs

◆ isFollowupTrack_m

◆ itsTracker

◆ macrocharge_m

◆ macromass_m

◆ method_m

◆ opal

◆ phaseSpaceSink_m

◆ stringMethod_s