#include <TrackCmd.h>

Inheritance diagram for TrackCmd:

[legend]

Collaboration diagram for TrackCmd:

[legend]

Public Member Functions
	TrackCmd ()

virtual	~TrackCmd ()

virtual TrackCmd *	clone (const std::string &name)
	Return a clone. More...

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

std::vector< double >	getDT () const
	Return the timestep in seconds. More...

double	getDTSCINIT () const

double	getDTAU () const

double	getT0 () const
	Return the elapsed time (sec) of the bunch. More...

std::vector< unsigned long long >	getMaxSteps () const
	Return the maximum timsteps we integrate the system. More...

int	getStepsPerTurn () const

double	getZStart () const
	location at which the simulation starts More...

std::vector< double >	getZStop () const
	location at which the simulation stops More...

Steppers::TimeIntegrator	getTimeIntegrator ()
	return the name of time integrator More...

void	setIsParseable (bool isParseable)
	set the IsParseable flag More...

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...

Private Member Functions
	TrackCmd (const TrackCmd &)

void	operator= (const TrackCmd &)

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

Private Attributes
bool	isParseable_m = true

Static Private Attributes
static const std::map< std::string, Steppers::TimeIntegrator >	stringTimeIntegrator_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 27 of file TrackCmd.h.

Constructor & Destructor Documentation

◆ TrackCmd() [1/3]

TrackCmd::TrackCmd ( )

Definition at line 62 of file TrackCmd.cpp.

References AttributeHandler::addAttributeOwner(), AttributeHandler::COMMAND, Physics::e, Object::itsAttr, Attrib::Distribution::LINE, Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeRealArray(), Attributes::makeString(), and Object::registerOwnership().

Referenced by clone().

Here is the call graph for this function:

◆ ~TrackCmd()

TrackCmd::~TrackCmd ( )

virtual

Definition at line 112 of file TrackCmd.cpp.

◆ TrackCmd() [2/3]

TrackCmd::TrackCmd ( const TrackCmd & )

private

◆ TrackCmd() [3/3]

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

private

Definition at line 107 of file TrackCmd.cpp.

Member Function Documentation

◆ clone()

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

virtual

Return a clone.

Implements Object.

Definition at line 116 of file TrackCmd.cpp.

References name, and TrackCmd().

Here is the call graph for this function:

◆ execute()

void TrackCmd::execute ( )

virtual

Execute the command.

Reimplemented from Object.

Definition at line 191 of file TrackCmd.cpp.

References Track::block, BeamSequence::find(), Beam::find(), getDT(), getDTAU(), getDTSCINIT(), getMaxSteps(), Attributes::getReal(), Beam::getReference(), getStepsPerTurn(), Attributes::getString(), getT0(), getTimeIntegrator(), getZStart(), getZStop(), isParseable_m, Object::itsAttr, Attrib::Distribution::LINE, max(), Track::parser, OpalParser::run(), and Track::truncOrder.

Here is the call graph for this function:

◆ getDT()

std::vector< double > TrackCmd::getDT ( ) const

Return the timestep in seconds.

Definition at line 120 of file TrackCmd.cpp.

References Physics::e, Attributes::getRealArray(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ getDTAU()

double TrackCmd::getDTAU ( ) const

Definition at line 138 of file TrackCmd.cpp.

References Attributes::getReal(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ getDTSCINIT()

double TrackCmd::getDTSCINIT ( ) const

Definition at line 134 of file TrackCmd.cpp.

References Attributes::getReal(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ getMaxSteps()

std::vector< unsigned long long > TrackCmd::getMaxSteps ( ) const

Return the maximum timsteps we integrate the system.

Definition at line 158 of file TrackCmd.cpp.

References Attributes::getRealArray(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ getStepsPerTurn()

int TrackCmd::getStepsPerTurn ( ) const

Return the timsteps per revolution period. ONLY available for OPAL-cycl. In OPAL-cycl, timestep is calculated by STEPSPERTURN, rather than given in TRACK command.

Definition at line 177 of file TrackCmd.cpp.

References Attributes::getReal(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ getT0()

double TrackCmd::getT0 ( ) const

Return the elapsed time (sec) of the bunch.

Definition at line 142 of file TrackCmd.cpp.

References Attributes::getReal(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ getTimeIntegrator()

Steppers::TimeIntegrator TrackCmd::getTimeIntegrator ( )

return the name of time integrator

Definition at line 181 of file TrackCmd.cpp.

References Attributes::getString(), Object::itsAttr, name, and stringTimeIntegrator_s.

Referenced by execute().

Here is the call graph for this function:

◆ getZStart()

double TrackCmd::getZStart ( ) const

location at which the simulation starts

Definition at line 146 of file TrackCmd.cpp.

References Attributes::getReal(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ getZStop()

std::vector< double > TrackCmd::getZStop ( ) const

location at which the simulation stops

Definition at line 150 of file TrackCmd.cpp.

References Attributes::getRealArray(), and Object::itsAttr.

Referenced by execute().

Here is the call graph for this function:

◆ operator=()

void TrackCmd::operator= ( const TrackCmd & )

private

◆ setIsParseable()

void TrackCmd::setIsParseable ( bool isParseable )

set the IsParseable flag

Definition at line 186 of file TrackCmd.cpp.

References isParseable_m.

Member Data Documentation

◆ isParseable_m

bool TrackCmd::isParseable_m = true

private

Definition at line 76 of file TrackCmd.h.

Referenced by execute(), and setIsParseable().

◆ stringTimeIntegrator_s

const std::map< std::string, Steppers::TimeIntegrator > TrackCmd::stringTimeIntegrator_s

staticprivate

Initial value:

= {
    {"RK-4", Steppers::TimeIntegrator::RK4},
    {"RK4",  Steppers::TimeIntegrator::RK4},
    {"LF-2", Steppers::TimeIntegrator::LF2},
    {"LF2",  Steppers::TimeIntegrator::LF2},
    {"MTS",  Steppers::TimeIntegrator::MTS}
}

Definition at line 77 of file TrackCmd.h.

Referenced by getTimeIntegrator().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrackCmd() [1/3]

◆ ~TrackCmd()

◆ TrackCmd() [2/3]

◆ TrackCmd() [3/3]

Member Function Documentation

◆ clone()

◆ execute()

◆ getDT()

◆ getDTAU()

◆ getDTSCINIT()

◆ getMaxSteps()

◆ getStepsPerTurn()

◆ getT0()

◆ getTimeIntegrator()

◆ getZStart()

◆ getZStop()

◆ operator=()

◆ setIsParseable()

Member Data Documentation

◆ isParseable_m

◆ stringTimeIntegrator_s