Beam Class Reference

#include <Beam.h>

Inheritance diagram for Beam:

Collaboration diagram for Beam:

Public Member Functions
	Beam ()
	Exemplar constructor.
virtual	~Beam ()
virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed.
virtual Beam *	clone (const std::string &name)
	Make clone.
virtual void	execute ()
	Check the BEAM data.
size_t	getNumAlloc () const
	Return the allocation size (macroparticles) for this beam.
const PartData &	getReference () const
	Return the embedded OPALX PartData.
double	getCurrent () const
	Return the beam current in A (legacy; no longer used in OPALX)
double	getBunchCharge () const
	Return the bunch charge in C.
double	getCharge () const
	Return the charge number in elementary charge.
double	getFrequency () const
	Return the beam frequency in MHz.
std::string	getParticleName () const
	Return Particle's name.
bool	isPhoton () const
	True if this beam is configured as a photon beam.
double	getMass () const
	Return Particle's rest mass in GeV.
double	getMomentum () const
double	getChargePerParticle () const
	Charge per macro particle in C.
double	getMassPerParticle () const
	Mass per macro particle in GeV/c^2.
std::string	getEmissionSourceListName () const
std::vector< std::string >	getGlobalProcessNames () const
	Return the configured global process names for this beam.
std::string	getDaughterBeamName () const
	Return the name of the daughter beam (for decay products), or empty if not set.
std::vector< double >	getPolarization () const
bool	hasPolarization () const
bool	hasExplicitEnergy () const
	True if PC, ENERGY, or GAMMA was explicitly provided by the user.
virtual void	update ()
	Update the BEAM data.
void	print (std::ostream &os) const
	Print the object.
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.
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	printValue (std::ostream &) const
virtual void	printHelp (std::ostream &) const
	Print help.
virtual void	replace (Object *oldObject, Object *newObject)
	Replace references.
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

Static Public Member Functions
static Beam *	find (const std::string &name)
	Find named BEAM.

Public Attributes
std::vector< Attribute >	itsAttr
	The object attributes.

Protected Attributes
bool	builtin
	Built-in flag.
bool	modified
	Dirty flag.
bool	flagged
	Object flag.

Private Member Functions
	Beam (const Beam &)
void	operator= (const Beam &)
	Beam (const std::string &name, Beam *parent)
void	validatePolarization () const

Private Attributes
PartData	reference
Object *	itsParent
std::string	itsName
std::string	itsHelp
int	occurrence
double	timeStamp
std::set< Invalidator * >	references
bool	sharedFlag

Static Private Attributes
static const double	energy_scale

Detailed Description

Definition at line 32 of file Beam.h.

Constructor & Destructor Documentation

Beam() [1/3]

Beam::Beam

(

)

Exemplar constructor.

Definition at line 61 of file Beam.cpp.

References Object::builtin, clone(), OpalData::define(), OpalData::getInstance(), Object::itsAttr, Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeRealArray(), Attributes::makeString(), Attributes::makeUpperCaseStringArray(), Object::registerOwnership(), AttributeHandler::STATEMENT, and update().

Referenced by clone().

Here is the call graph for this function:

~Beam()

Beam::~Beam ( )

virtual

Definition at line 130 of file Beam.cpp.

Beam() [2/3]

Beam::Beam ( const Beam &  )

private

Beam() [3/3]

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

private

Definition at line 127 of file Beam.cpp.

Member Function Documentation

canReplaceBy()

bool Beam::canReplaceBy ( Object *  object )

virtual

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 132 of file Beam.cpp.

clear()

void Object::clear ( )

inherited

Clear the occurrence counter.

Definition at line 285 of file Object.cpp.

References Object::occurrence.

clone()

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

virtual

Make clone.

Implements Object.

Definition at line 137 of file Beam.cpp.

References Beam().

Referenced by Beam().

Here is the call graph for this function:

copyAttributes()

void Object::copyAttributes ( const Object &  source )

inherited

Copy attributes from another object.

Definition at line 50 of file Object.cpp.

References Object::itsAttr.

Referenced by SequenceTemplate::makeInstance(), and LineTemplate::makeInstance().

execute()

void Beam::execute ( )

virtual

Check the BEAM data.

Reimplemented from Object.

Definition at line 139 of file Beam.cpp.

References getEmissionSourceListName(), getGlobalProcessNames(), getParticleName(), Attributes::getReal(), Object::itsAttr, update(), and validatePolarization().

Here is the call graph for this function:

find()

Beam * Beam::find ( const std::string &  name )

static

Find named BEAM.

Definition at line 290 of file Beam.cpp.

References OpalData::find(), and OpalData::getInstance().

Referenced by TrackCmd::execute(), TrackRun::execute(), TestMultipoleTCurvedConstRadius::makeBunch(), TestMultipoleTStraight::makeBunch(), SolenoidPlacementTest::makeBunch(), TestVariableRFCavity::makeBunch(), OrbitThreaderTest::makeBunch(), OpalBeamlinePlacementTest::makeBunch(), TrackRun::print(), and TEST_F().

Here is the call graph for this function:

findAttribute() [1/2]

Attribute * Object::findAttribute ( const std::string &  name )

virtualinherited

Find an attribute by name.

Definition at line 56 of file Object.cpp.

References Object::itsAttr.

Referenced by SequenceParser::findNeighbourPositions(), OpalElement::getParticleMatterInteraction(), OpalElement::getTypeName(), OpalElement::getWakeF(), Object::parse(), OpalElement::parse(), Line::parse(), OpalParser::parseAssign(), SequenceParser::parsePosition(), TrackRun::print(), and TEST().

findAttribute() [2/2]

const Attribute * Object::findAttribute ( const std::string &  name ) const

virtualinherited

Find an attribute by name.

Definition at line 63 of file Object.cpp.

References Object::itsAttr.

getBaseObject()

const Object * Object::getBaseObject ( ) const

inherited

Return the object's base type object.

Definition at line 260 of file Object.cpp.

References Object::itsParent.

getBunchCharge()

double Beam::getBunchCharge

(

)

const

Return the bunch charge in C.

Definition at line 318 of file Beam.cpp.

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

Referenced by getChargePerParticle().

Here is the call graph for this function:

getCategory()

const std::string Definition::getCategory ( ) const

virtualinherited

Return the object category as a string.

Implements Object.

Definition at line 26 of file Definition.cpp.

getCharge()

double Beam::getCharge

(

)

const

Return the charge number in elementary charge.

Definition at line 320 of file Beam.cpp.

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

Referenced by TrackRun::execute(), getChargePerParticle(), getMassPerParticle(), and update().

Here is the call graph for this function:

getChargePerParticle()

double Beam::getChargePerParticle

(

)

const

Charge per macro particle in C.

Definition at line 334 of file Beam.cpp.

References getBunchCharge(), getCharge(), and getNumAlloc().

Referenced by TrackRun::execute(), getMassPerParticle(), and TrackRun::print().

Here is the call graph for this function:

getCurrent()

double Beam::getCurrent

(

)

const

Return the beam current in A (legacy; no longer used in OPALX)

Definition at line 316 of file Beam.cpp.

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

Here is the call graph for this function:

getDaughterBeamName()

std::string Beam::getDaughterBeamName

(

)

const

Return the name of the daughter beam (for decay products), or empty if not set.

Definition at line 274 of file Beam.cpp.

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

Here is the call graph for this function:

getEmissionSourceListName()

std::string Beam::getEmissionSourceListName

(

)

const

Return the name of the EMISSIONSOURCELIST linked to this beam. Throws if SOURCES is not set.

Definition at line 254 of file Beam.cpp.

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

Referenced by execute(), and TrackRun::execute().

Here is the call graph for this function:

getFrequency()

double Beam::getFrequency

(

)

const

Return the beam frequency in MHz.

Definition at line 330 of file Beam.cpp.

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

Here is the call graph for this function:

getGlobalProcessNames()

std::vector< std::string > Beam::getGlobalProcessNames

(

)

const

Return the configured global process names for this beam.

Definition at line 270 of file Beam.cpp.

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

Referenced by execute().

Here is the call graph for this function:

getMass()

double Beam::getMass

(

)

const

Return Particle's rest mass in GeV.

Definition at line 322 of file Beam.cpp.

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

Referenced by getMassPerParticle(), TrackRun::setupDistributionsAndSamplers(), and update().

Here is the call graph for this function:

getMassPerParticle()

double Beam::getMassPerParticle

(

)

const

Mass per macro particle in GeV/c^2.

Definition at line 338 of file Beam.cpp.

References getCharge(), getChargePerParticle(), getMass(), and Physics::q_e.

Referenced by TrackRun::execute(), and TrackRun::print().

Here is the call graph for this function:

getMomentum()

double Beam::getMomentum

(

)

const

Definition at line 324 of file Beam.cpp.

References PartData::getP(), and reference.

Referenced by TrackRun::setupDistributionsAndSamplers().

Here is the call graph for this function:

getNumAlloc()

size_t Beam::getNumAlloc

(

)

const

Return the allocation size (macroparticles) for this beam.

Definition at line 300 of file Beam.cpp.

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

Referenced by TrackRun::computeTotalAllocationForBunch(), and getChargePerParticle().

Here is the call graph for this function:

getOpalName()

const std::string & Object::getOpalName ( ) const

inherited

Return object name.

Definition at line 267 of file Object.cpp.

References Object::itsName.

Referenced by OpalVariableRFCavity::clone(), Macro::clone(), OpalData::create(), OpalData::define(), Sequence::findDriftLength(), SequenceParser::findNeighbourPositions(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), Object::makeInstance(), SequenceTemplate::makeInstance(), LineTemplate::makeInstance(), Object::parse(), SequenceParser::parseMember(), SequenceParser::parsePosition(), Object::print(), OpalElement::print(), Sequence::print(), TrackRun::print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), print(), OpalFilter::print(), Line::print(), BinningCmd::printInfo(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), OpalElement::registerOwnership(), Object::registerOwnership(), Line::replace(), Sequence::replace(), PartBunch< T, Dim >::setBins(), TEST(), TEST(), TEST(), TEST_F(), update(), BoundaryGeometry::update(), OpalFilter::update(), OpalPolynomialTimeDependence::update(), OpalSinusoidalTimeDependence::update(), and OpalSplineTimeDependence::update().

getParent()

Object * Object::getParent ( ) const

inherited

Return parent pointer.

Definition at line 269 of file Object.cpp.

References Object::itsParent.

Referenced by OpalData::erase(), Object::print(), OpalElement::print(), OpalElement::registerOwnership(), and Object::registerOwnership().

getParticleName()

std::string Beam::getParticleName

(

)

const

Return Particle's name.

Definition at line 326 of file Beam.cpp.

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

Referenced by execute(), isPhoton(), update(), and validatePolarization().

Here is the call graph for this function:

getPolarization()

std::vector< double > Beam::getPolarization

(

)

const

Return the initial polarization vector P (rest-frame, lab-frame axes). Default {0,0,0}. Caller must check |Pol| in [0, 1]; validation is performed in execute().

Definition at line 278 of file Beam.cpp.

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

Referenced by TrackRun::setupDistributionsAndSamplers().

Here is the call graph for this function:

getReference()

const PartData & Beam::getReference

(

)

const

Return the embedded OPALX PartData.

Definition at line 310 of file Beam.cpp.

References reference, and update().

Referenced by TrackCmd::execute().

Here is the call graph for this function:

hasExplicitEnergy()

bool Beam::hasExplicitEnergy

(

)

const

True if PC, ENERGY, or GAMMA was explicitly provided by the user.

Definition at line 332 of file Beam.cpp.

References Object::itsAttr.

Referenced by TrackRun::setupDistributionsAndSamplers().

hasPolarization()

bool Beam::hasPolarization

(

)

const

True if POLARIZATION was explicitly set on this beam. Used both as the initial polarization source and as the switch that enables per-particle spin tracking.

Definition at line 286 of file Beam.cpp.

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

Here is the call graph for this function:

increment()

int Object::increment ( )

inherited

Increment and return the occurrence counter.

Definition at line 287 of file Object.cpp.

References Object::occurrence.

Referenced by Line::parse(), and Sequence::storeLine().

isBuiltin()

bool Object::isBuiltin ( ) const

inherited

True, if [b]this[/b] is a built-in object.

Definition at line 243 of file Object.cpp.

References Object::builtin.

Referenced by OpalData::define(), and OpalData::getVariableNames().

isDirty()

bool Object::isDirty ( ) const

inherited

True, if the [b]modified[/b] flag is set.

Definition at line 254 of file Object.cpp.

References Object::modified.

isFlagged()

bool Object::isFlagged ( ) const

inherited

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

Definition at line 258 of file Object.cpp.

References Object::flagged.

isPhoton()

bool Beam::isPhoton

(

)

const

True if this beam is configured as a photon beam.

Definition at line 328 of file Beam.cpp.

References getParticleName(), and Object::itsAttr.

Referenced by update().

Here is the call graph for this function:

isShared()

bool Object::isShared ( ) const

virtualinherited

Shared flag.

Definition at line 245 of file Object.cpp.

References Object::sharedFlag.

Referenced by Sequence::print().

isTreeMember()

bool Object::isTreeMember ( const Object *  subTree ) const

inherited

Test for tree membership.

Definition at line 271 of file Object.cpp.

References Object::itsParent.

Referenced by Selector::handleElement(), and OpalParser::parseAssign().

makeInstance()

Object * Object::makeInstance ( const std::string &  name, Statement &  , const Parser *    )

virtualinherited

Macro handler function.

Reimplemented in SequenceTemplate, MacroCmd, and LineTemplate.

Definition at line 76 of file Object.cpp.

References Object::getOpalName().

Referenced by OpalParser::parseDefine(), and OpalParser::parseMacro().

Here is the call graph for this function:

makeTemplate()

Object * Object::makeTemplate ( const std::string &  name, TokenStream &  , Statement &    )

virtualinherited

Macro handler function.

Reimplemented in LineTemplate, Sequence, MacroCmd, SequenceTemplate, and Line.

Definition at line 71 of file Object.cpp.

Referenced by OpalParser::parseMacro().

occurrenceCount()

int Object::occurrenceCount ( )

inherited

Return the occurrence counter.

Definition at line 289 of file Object.cpp.

References Object::occurrence.

operator=()

void Beam::operator= ( const Beam &  )

private

parse()

void Object::parse ( Statement &  stat )

virtualinherited

Parse the object.

Reimplemented in Call, Echo, Help, PSystem, System, Title, Value, OpalElement, Sequence, EmissionSourceList, and Line.

Definition at line 82 of file Object.cpp.

References Statement::delimiter(), Object::findAttribute(), Object::getOpalName(), Expressions::parseDelimiter(), Expressions::parseRealConst(), and Expressions::parseString().

Referenced by Sequence::parse(), OpalParser::parseAction(), OpalParser::parseDefine(), and SequenceTemplate::parseTemplate().

Here is the call graph for this function:

parseShortcut()

void Object::parseShortcut ( Statement &  stat, bool  eval = true  )

virtualinherited

Parser for single-attribute commands.

Definition at line 113 of file Object.cpp.

Referenced by Call::parse(), Echo::parse(), Help::parse(), PSystem::parse(), System::parse(), Title::parse(), and Value::parse().

print()

void Beam::print ( std::ostream &  msg ) const

virtual

Print the object.

Reimplemented from Object.

Definition at line 400 of file Beam.cpp.

References Object::getOpalName(), PartData::getP(), Attributes::getReal(), Attributes::getString(), Object::itsAttr, and reference.

Referenced by operator<<().

Here is the call graph for this function:

printHelp()

void Object::printHelp ( std::ostream &  ) const

virtualinherited

Print help.

Definition at line 179 of file Object.cpp.

References gmsg, Object::itsAttr, and Object::itsHelp.

Referenced by Help::execute().

printValue()

void Object::printValue ( std::ostream &  os ) const

inlinevirtualinherited

Reimplemented in BoolConstant, RealConstant, RealVariable, RealVector, and StringConstant.

Definition at line 270 of file Object.h.

References Object::print().

Here is the call graph for this function:

registerOwnership()

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

inherited

Definition at line 169 of file Object.cpp.

References AttributeHandler::addAttributeOwner(), Object::getOpalName(), Object::getParent(), and Object::itsAttr.

Referenced by Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Distribution::Distribution(), DumpEMFields::DumpEMFields(), Echo::Echo(), EmissionSource::EmissionSource(), EmissionSourceList::EmissionSourceList(), Help::Help(), Line::Line(), OpalFilter::OpalFilter(), Option::Option(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), Select::Select(), Sequence::Sequence(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), and Value::Value().

Here is the call graph for this function:

registerReference()

void Object::registerReference ( Invalidator *  a )

inherited

Register a reference to this object.

Definition at line 165 of file Object.cpp.

References Object::references.

replace()

void Object::replace ( Object *  oldObject, Object *  newObject  )

virtualinherited

Replace references.

Reimplemented in Line, and Sequence.

Definition at line 235 of file Object.cpp.

setDirty()

void Object::setDirty ( bool  dirty )

inherited

Set/reset the [b]modified[/b] flag.

Definition at line 249 of file Object.cpp.

References Object::modified.

Referenced by OpalData::define(), OpalData::makeDirty(), and RealVariable::RealVariable().

setFlag()

void Object::setFlag ( bool  flag )

inherited

Flag/unflag this object, e. g. to control output of objects for.

Definition at line 256 of file Object.cpp.

References Object::flagged.

setOpalName()

void Object::setOpalName ( const std::string &  name )

inherited

Set object name.

Definition at line 281 of file Object.cpp.

References Object::itsName.

Referenced by TEST(), TEST(), TEST(), update(), BoundaryGeometry::update(), and OpalFilter::update().

setParent()

void Object::setParent ( Object *  parent )

inherited

Set parent object.

Definition at line 283 of file Object.cpp.

References Object::itsParent.

Referenced by OpalData::erase().

setShared()

void Object::setShared ( bool  flag )

virtualinherited

Set/reset shared flag.

Reimplemented in Element.

Definition at line 247 of file Object.cpp.

References Object::sharedFlag.

Referenced by OpalParser::parseDefine(), and Element::setShared().

shouldTrace()

bool Definition::shouldTrace ( ) const

virtualinherited

Trace flag.

Implements Object.

Definition at line 28 of file Definition.cpp.

shouldUpdate()

bool Definition::shouldUpdate ( ) const

virtualinherited

Update flag.

Implements Object.

Definition at line 30 of file Definition.cpp.

unregisterReference()

void Object::unregisterReference ( Invalidator *  a )

inherited

Unegister a reference to this object.

Definition at line 167 of file Object.cpp.

References Object::references.

update()

void Beam::update ( )

virtual

Update the BEAM data.

Reimplemented from Object.

Definition at line 342 of file Beam.cpp.

References getCharge(), PartData::getM(), getMass(), Object::getOpalName(), ParticleProperties::getParticleAnomaly(), ParticleProperties::getParticleCharge(), ParticleProperties::getParticleMass(), getParticleName(), ParticleProperties::getParticleType(), Attributes::getReal(), Units::GeV2eV, isPhoton(), Object::itsAttr, Physics::m_p, reference, PartData::setAnomaly(), PartData::setE(), PartData::setGamma(), PartData::setM(), Object::setOpalName(), PartData::setP(), PartData::setQ(), and Attributes::setReal().

Referenced by Beam(), execute(), and getReference().

Here is the call graph for this function:

validatePolarization()

void Beam::validatePolarization ( ) const

private

Definition at line 215 of file Beam.cpp.

References getParticleName(), ParticleProperties::getParticleType(), Attributes::getRealArray(), Object::itsAttr, and MUON.

Referenced by execute().

Here is the call graph for this function:

Member Data Documentation

builtin

bool Object::builtin

protectedinherited

Built-in flag.

Definition at line 226 of file Object.h.

Referenced by Beam(), BoundaryGeometry::BoundaryGeometry(), Object::isBuiltin(), Object::Object(), Object::Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().

energy_scale

const double Beam::energy_scale

staticprivate

Definition at line 129 of file Beam.h.

flagged

bool Object::flagged

protectedinherited

Object flag.

Definition at line 235 of file Object.h.

Referenced by Object::isFlagged(), Object::Object(), Object::Object(), and Object::setFlag().

itsAttr

std::vector<Attribute> Object::itsAttr

inherited

The object attributes.

Definition at line 210 of file Object.h.

Referenced by Beam(), BinningCmd::BinningCmd(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), Call::Call(), FieldSolverCmd::constructBCHandler(), Object::copyAttributes(), Distribution::Distribution(), BinningCmd::dumpBinsToFile(), DumpEMFields::DumpEMFields(), Echo::Echo(), EmissionSource::EmissionSource(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), Value::execute(), execute(), TrackCmd::execute(), TrackRun::execute(), FieldSolverCmd::FieldSolverCmd(), Object::findAttribute(), Object::findAttribute(), BoundaryGeometry::getA(), BinningCmd::getAdaptiveBinning(), OpalElement::getApert(), BoundaryGeometry::getB(), BinningCmd::getBinningAlpha(), BinningCmd::getBinningBeta(), FieldSolverCmd::getBinsName(), BoolConstant::getBool(), FieldSolverCmd::getBoxIncr(), getBunchCharge(), BoundaryGeometry::getC(), getCharge(), getCurrent(), getDaughterBeamName(), BinningCmd::getDesiredWidth(), EmissionSource::getDistributionName(), FieldSolverCmd::getDomDec(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), BinningCmd::getDumpBinsFileName(), BinningCmd::getDumpBinsFrequency(), EmissionSource::getEmissionModel(), getEmissionSourceListName(), Distribution::getEmissionSteps(), Distribution::getFilename(), BoundaryGeometry::getFilename(), getFrequency(), getGlobalProcessNames(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), OpalElement::getLength(), Line::getLength(), Sequence::getLength(), getMass(), BinningCmd::getMaxBins(), TrackCmd::getMaxSteps(), getNumAlloc(), FieldSolverCmd::getNX(), FieldSolverCmd::getNY(), FieldSolverCmd::getNZ(), EmissionSource::getP0(), BinningCmd::getParameter(), getParticleName(), getPolarization(), EmissionSource::getR0(), RealConstant::getReal(), RealVariable::getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), EmissionSource::getShiftedGreensFunction(), TrackCmd::getStepsPerTurn(), StringConstant::getString(), EmissionSource::getT0(), TrackCmd::getT0(), BinningCmd::getTablePrintFrequency(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), FieldSolverCmd::getType(), EmissionSource::getZerofaceMaxSteps(), EmissionSource::getZeroFacePlaneDumpFrequency(), EmissionSource::getZeroFaceR0Z(), TrackCmd::getZStart(), TrackCmd::getZStop(), hasExplicitEnergy(), hasPolarization(), Help::Help(), BoundaryGeometry::initialize(), OpalFilter::initOpalFilter(), isPhoton(), Line::Line(), OpalBend::OpalBend(), OpalCavity::OpalCavity(), OpalConstantEFieldCavity::OpalConstantEFieldCavity(), OpalDrift::OpalDrift(), OpalElement::OpalElement(), OpalFilter::OpalFilter(), OpalLaser::OpalLaser(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalPolynomialTimeDependence::OpalPolynomialTimeDependence(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalRingDefinition::OpalRingDefinition(), OpalSinusoidalTimeDependence::OpalSinusoidalTimeDependence(), OpalSolenoid::OpalSolenoid(), OpalSplineTimeDependence::OpalSplineTimeDependence(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), Option::Option(), Option::Option(), Sequence::parse(), Line::parse(), DumpEMFields::parseCoordinateSystem(), Object::print(), Sequence::print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), print(), OpalFilter::print(), DumpEMFields::print(), Object::printHelp(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), BoolConstant::printValue(), RealConstant::printValue(), RealVariable::printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVariable::RealVariable(), RealVector::RealVector(), OpalElement::registerOwnership(), Object::registerOwnership(), Select::Select(), Select::select(), Sequence::Sequence(), TestableBinningCmd::setAdaptiveBinning(), Distribution::setAttributes(), TestMultipoleT::TestableFieldSolverCmd::setBCX(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setBCX(), TestMultipoleTStraight::TestableFieldSolverCmd::setBCX(), SolenoidPlacementTest::TestableFieldSolverCmd::setBCX(), TestVariableRFCavity::TestableFieldSolverCmd::setBCX(), OrbitThreaderTest::TestableFieldSolverCmd::setBCX(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setBCX(), TestMultipoleT::TestableFieldSolverCmd::setBCY(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setBCY(), TestMultipoleTStraight::TestableFieldSolverCmd::setBCY(), SolenoidPlacementTest::TestableFieldSolverCmd::setBCY(), TestVariableRFCavity::TestableFieldSolverCmd::setBCY(), OrbitThreaderTest::TestableFieldSolverCmd::setBCY(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setBCY(), TestMultipoleT::TestableFieldSolverCmd::setBCZ(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setBCZ(), TestMultipoleTStraight::TestableFieldSolverCmd::setBCZ(), SolenoidPlacementTest::TestableFieldSolverCmd::setBCZ(), TestVariableRFCavity::TestableFieldSolverCmd::setBCZ(), OrbitThreaderTest::TestableFieldSolverCmd::setBCZ(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setBCZ(), TestableBinningCmd::setBinningAlpha(), TestableBinningCmd::setBinningBeta(), TestableBinningCmd::setDesiredWidth(), Distribution::setDistParametersFlatTop(), Distribution::setDistParametersMultiVariateGauss(), Distribution::setDistType(), TestableBinningCmd::setDumpBinsFile(), TestableBinningCmd::setDumpBinsFreq(), TestableBinningCmd::setMaxBins(), FieldSolverCmd::setNX(), FieldSolverCmd::setNY(), FieldSolverCmd::setNZ(), TestableBinningCmd::setParameterString(), TrackRun::setRunMethod(), Distribution::setSigmaP_m(), Distribution::setSigmaR_m(), TestableBinningCmd::setTablePrintFrequency(), TestMultipoleT::TestableFieldSolverCmd::setType(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setType(), TestMultipoleTStraight::TestableFieldSolverCmd::setType(), SolenoidPlacementTest::TestableFieldSolverCmd::setType(), TestVariableRFCavity::TestableFieldSolverCmd::setType(), OrbitThreaderTest::TestableFieldSolverCmd::setType(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setType(), TrackRun::setupBoundaryGeometry(), StringConstant::StringConstant(), StringConstant::StringConstant(), System::System(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), OpalCavity::update(), OpalConstantEFieldCavity::update(), OpalDrift::update(), OpalElement::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRingDefinition::update(), OpalSBend::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalVerticalFFAMagnet::update(), update(), BinningCmd::update(), FieldSolverCmd::update(), OpalLaser::update(), OpalMultipoleT::update(), OpalPolynomialTimeDependence::update(), OpalSinusoidalTimeDependence::update(), OpalSplineTimeDependence::update(), OpalVariableRFCavity::update(), Option::update(), OpalElement::updateUnknown(), validatePolarization(), ValueDefinition::value(), Value::Value(), and ValueDefinition::value().

itsHelp

std::string Object::itsHelp

privateinherited

Definition at line 250 of file Object.h.

Referenced by Object::printHelp().

itsName

std::string Object::itsName

privateinherited

Definition at line 247 of file Object.h.

Referenced by Object::getOpalName(), and Object::setOpalName().

itsParent

Object* Object::itsParent

privateinherited

Definition at line 244 of file Object.h.

Referenced by Object::getBaseObject(), Object::getParent(), Object::isTreeMember(), and Object::setParent().

modified

bool Object::modified

protectedinherited

Dirty flag.

Definition at line 231 of file Object.h.

Referenced by Object::isDirty(), Object::Object(), Object::Object(), and Object::setDirty().

occurrence

int Object::occurrence

privateinherited

Definition at line 253 of file Object.h.

Referenced by Object::clear(), Object::increment(), and Object::occurrenceCount().

reference

PartData Beam::reference

private

Definition at line 126 of file Beam.h.

Referenced by getMomentum(), getReference(), print(), and update().

references

std::set<Invalidator*> Object::references

privateinherited

Definition at line 260 of file Object.h.

Referenced by Object::registerReference(), Object::unregisterReference(), and Object::~Object().

sharedFlag

bool Object::sharedFlag

privateinherited

Definition at line 263 of file Object.h.

Referenced by Object::isShared(), and Object::setShared().

timeStamp

double Object::timeStamp

privateinherited

Definition at line 256 of file Object.h.

---

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

• Beam.h
• Beam.cpp