OPALX (Object Oriented Parallel Accelerator Library for Exascal) master (dc2a29eed580)
OPALX
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
TrackRun Class Reference

#include <TrackRun.h>

Inheritance diagram for TrackRun:
Inheritance graph
Collaboration diagram for TrackRun:
Collaboration graph

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
 
virtual void print (std::ostream &) const
 Print the object.
 
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.
 
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.
 
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 Attributes

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

Protected Attributes

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

Private Types

enum class  RunMethod : unsigned short { NONE , PARALLEL }
 
using emittingSamplers_t = std::vector< std::shared_ptr< SamplingBase > >
 
using bunch_type = PartBunch_t
 

Private Member Functions

 TrackRun (const TrackRun &)
 
void operator= (const TrackRun &)
 
 TrackRun (const std::string &name, TrackRun *parent)
 
void setRunMethod ()
 
std::string getRunMethodName () const
 
void initDataSink (size_t numParticleContainers)
 
std::vector< H5PartWrapper * > borrowedPhaseSpaceSinks () const
 
void setupBoundaryGeometry ()
 
void setupGlobalProcesses (std::vector< std::vector< std::unique_ptr< GlobalProcess > > > globalProcessesLists)
 Attach prebuilt global process vector to each particle container.
 
void wireDaughterContainers (const std::vector< Beam * > &beams)
 Wire daughter containers to cross-container processes (e.g. muon decay -> electron).
 
void setupDistributionsAndSamplers (const std::vector< EmissionSource * > &sources, Beam *beam, emittingSamplers_t &emittingSamplers, size_t index=0)
 
void configureImageChargeFromSources (const std::vector< std::vector< EmissionSource * > > &emissionSourcesLists)
 Configure image-charge mode from all configured emission sources.
 
size_t computeTotalAllocationForBunch (Beam *beam, const std::vector< EmissionSource * > &sources) const
 

Private Attributes

std::unique_ptr< Tracker > itsTracker_m
 
std::vector< Distribution * > distrs_m
 Distributions referenced by all emission sources (non-owning raw pointers).
 
FieldSolverCmd * fs_m
 Samplers for time-dependent (emitting) sources; tracker calls emitParticles(t, dt) on each.
 
DataSink * ds_m
 
std::vector< std::unique_ptr< H5PartWrapper > > phaseSpaceSinks_m
 
OpalData * opal_m
 
std::unique_ptr< bunch_type > bunch_m
 
bool isFollowupTrack_m
 
RunMethod method_m
 
Object * itsParent
 
std::string itsName
 
std::string itsHelp
 
int occurrence
 
double timeStamp
 
std::set< Invalidator * > references
 
bool sharedFlag
 

Static Private Attributes

static const BiMap< RunMethod, std::string > stringMethod_s
 

Detailed Description

Definition at line 45 of file TrackRun.h.

Member Typedef Documentation

◆ bunch_type

using TrackRun::bunch_type = PartBunch_t
private

Definition at line 143 of file TrackRun.h.

◆ emittingSamplers_t

using TrackRun::emittingSamplers_t = std::vector<std::shared_ptr<SamplingBase> >
private

Definition at line 46 of file TrackRun.h.

Member Enumeration Documentation

◆ RunMethod

enum class TrackRun::RunMethod : unsigned short
strongprivate
Enumerator
NONE 
PARALLEL 

Definition at line 66 of file TrackRun.h.

Constructor & Destructor Documentation

◆ TrackRun() [1/3]

TrackRun::TrackRun ( )

Exemplar constructor.

Definition at line 194 of file TrackRun.cpp.

References TRACKRUN::BOUNDARYGEOMETRY, TRACKRUN::FIELDSOLVER, OpalData::getInstance(), Object::itsAttr, Attributes::makeBool(), Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeString(), TRACKRUN::METHOD, opal_m, Object::registerOwnership(), AttributeHandler::SUB_COMMAND, TRACKRUN::TRACKBACK, and TRACKRUN::TURNS.

Referenced by clone().

Here is the call graph for this function:

◆ ~TrackRun()

TrackRun::~TrackRun ( )
virtual

Definition at line 254 of file TrackRun.cpp.

◆ TrackRun() [2/3]

TrackRun::TrackRun ( const TrackRun &  )
private

◆ TrackRun() [3/3]

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

Definition at line 226 of file TrackRun.cpp.

References OpalData::getInstance(), nr, and opal_m.

Here is the call graph for this function:

Member Function Documentation

◆ borrowedPhaseSpaceSinks()

std::vector< H5PartWrapper * > TrackRun::borrowedPhaseSpaceSinks ( ) const
private

Definition at line 564 of file TrackRun.cpp.

References phaseSpaceSinks_m.

Referenced by initDataSink().

◆ canReplaceBy()

bool Action::canReplaceBy ( Object *  object)
virtualinherited

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 26 of file Action.cpp.

◆ clear()

void Object::clear ( )
inherited

Clear the occurrence counter.

Definition at line 285 of file Object.cpp.

References Object::occurrence.

◆ clone()

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

Make clone.

Implements Object.

Definition at line 256 of file TrackRun.cpp.

References TrackRun().

Here is the call graph for this function:

◆ computeTotalAllocationForBunch()

size_t TrackRun::computeTotalAllocationForBunch ( Beam *  beam,
const std::vector< EmissionSource * > &  sources 
) const
private

Compute total number of macroparticles for the bunch from BEAM::NALLOC and optional per-distribution NPARTDIST values on the emission sources.

Definition at line 652 of file TrackRun.cpp.

References Distribution::find(), Beam::getNumAlloc(), and gmsg.

Referenced by execute().

Here is the call graph for this function:

◆ configureImageChargeFromSources()

void TrackRun::configureImageChargeFromSources ( const std::vector< std::vector< EmissionSource * > > &  emissionSourcesLists)
private

Configure image-charge mode from all configured emission sources.

Scans all sources across all selected beams for ZEROFACE_R0Z=true. If exactly one source requests zero-face handling, image-charge mode is enabled and the mirror plane is set to that source's R0Z. The same source also provides ZEROFACEPLANEDUMP, which controls diagnostic potential-plane dumping frequency (0 disables dumping). If none request it, image-charge mode is disabled.

Parameters
emissionSourcesListsPer-beam source lists assembled during RUN setup.
Exceptions
OpalExceptionIf more than one source requests ZEROFACE_R0Z=true.

Definition at line 790 of file TrackRun.cpp.

References bunch_m, fs_m, and FieldSolverCmd::getType().

Referenced by execute().

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 TrackRun::execute ( )
virtual

Execute the command.

Reimplemented from Object.

Definition at line 258 of file TrackRun.cpp.

References Track::beamNames_m, Track::block, bunch_m, Versions::changes, computeTotalAllocationForBunch(), configureImageChargeFromSources(), ds_m, Track::dT, EmissionSourceList::fetchSources(), TRACKRUN::FIELDSOLVER, EmissionSourceList::find(), Beam::find(), FieldSolverCmd::find(), fs_m, FieldSolverCmd::getBinningCmd(), Beam::getCharge(), Beam::getChargePerParticle(), Beam::getEmissionSourceListName(), OpalData::getInstance(), Beam::getMassPerParticle(), Attributes::getString(), gmsg, FieldSolverCmd::hasBinningCmd(), OpalData::hasBunchAllocated(), initDataSink(), isFollowupTrack_m, Object::itsAttr, itsTracker_m, Track::localTimeSteps, method_m, opal_m, PARALLEL, Physics::q_e, OpalData::setGlobalPhaseShift(), setRunMethod(), setupBoundaryGeometry(), setupDistributionsAndSamplers(), setupGlobalProcesses(), Options::version, wireDaughterContainers(), Track::zstart, and Track::zstop.

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(), 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.

◆ getCategory()

const std::string Action::getCategory ( ) const
virtualinherited

Return the object category as a string.

Implements Object.

Definition at line 28 of file Action.cpp.

◆ 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(), print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), Beam::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(), Beam::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().

◆ getRunMethodName()

std::string TrackRun::getRunMethodName ( ) const
private

Definition at line 520 of file TrackRun.cpp.

References BiMap< Left, Right >::left, method_m, and stringMethod_s.

Referenced by print().

◆ 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().

◆ initDataSink()

void TrackRun::initDataSink ( size_t  numParticleContainers)
private

Definition at line 522 of file TrackRun.cpp.

References borrowedPhaseSpaceSinks(), DataSink::changeH5Wrappers(), DataSink::diagnosticStemForContainer(), ds_m, OpalData::getDataSink(), OpalData::getInputBasename(), OpalData::getInstance(), OpalData::getRestartStep(), OpalData::hasDataSinkAllocated(), OpalData::inRestartRun(), isFollowupTrack_m, opal_m, phaseSpaceSinks_m, and OpalData::setDataSink().

Referenced by execute().

Here is the call graph for this function:

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

◆ 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 TrackRun::operator= ( const TrackRun &  )
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() [1/2]

Inform & TrackRun::print ( Inform &  os) const

Definition at line 899 of file TrackRun.cpp.

References Track::beamNames_m, Track::block, Track::dT, Beam::find(), Beam::getChargePerParticle(), Beam::getMassPerParticle(), getRunMethodName(), isFollowupTrack_m, Track::localTimeSteps, Options::psDumpFreq, and Options::statDumpFreq.

Referenced by operator<<().

Here is the call graph for this function:

◆ print() [2/2]

void Object::print ( std::ostream &  msg) const
virtual

Print the object.

Reimplemented from Object.

Definition at line 114 of file Object.cpp.

References Statement::delimiter(), Object::findAttribute(), Object::getOpalName(), Statement::mark(), and Statement::word().

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::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(), 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(), Beam::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().

◆ setRunMethod()

void TrackRun::setRunMethod ( )
private

Definition at line 507 of file TrackRun.cpp.

References Attributes::getString(), Object::itsAttr, TRACKRUN::METHOD, method_m, BiMap< Left, Right >::right, and stringMethod_s.

Referenced by execute().

Here is the call graph for this function:

◆ 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().

◆ setupBoundaryGeometry()

void TrackRun::setupBoundaryGeometry ( )
private

Definition at line 573 of file TrackRun.cpp.

References TRACKRUN::BOUNDARYGEOMETRY, BoundaryGeometry::clone(), BoundaryGeometry::find(), OpalData::getInstance(), Attributes::getString(), Object::itsAttr, and OpalData::setGlobalGeometry().

Referenced by execute().

Here is the call graph for this function:

◆ setupDistributionsAndSamplers()

void TrackRun::setupDistributionsAndSamplers ( const std::vector< EmissionSource * > &  sources,
Beam *  beam,
emittingSamplers_t &  emittingSamplers,
size_t  index = 0 
)
private

Build samplers for all emission sources, perform initial sampling for t0 == 0 sources, and populate emittingSamplers_m for time-dependent or delayed sources. Applied to particle container [index]

Definition at line 677 of file TrackRun.cpp.

References bunch_m, distrs_m, EMITTEDFROMFILE, Distribution::emitting_m, Distribution::find(), FLATTOP, FROMFILE, GAUSS, OpalData::getInstance(), Beam::getMass(), Beam::getMomentum(), Distribution::getNumParticles(), Beam::getPolarization(), Distribution::getType(), Distribution::getTypeofDistribution(), gmsg, Beam::hasExplicitEnergy(), MULTIVARIATEGAUSS, nr, OPALFLATTOP, Distribution::setAvrgPz(), Distribution::setDist(), Distribution::setDistType(), and OpalData::setGlobalPhaseShift().

Referenced by execute().

Here is the call graph for this function:

◆ setupGlobalProcesses()

void TrackRun::setupGlobalProcesses ( std::vector< std::vector< std::unique_ptr< GlobalProcess > > >  globalProcessesLists)
private

Attach prebuilt global process vector to each particle container.

Definition at line 586 of file TrackRun.cpp.

References bunch_m.

Referenced by execute().

◆ shouldTrace()

bool Action::shouldTrace ( ) const
virtualinherited

Trace flag.

Implements Object.

Definition at line 30 of file Action.cpp.

◆ shouldUpdate()

bool Action::shouldUpdate ( ) const
virtualinherited

Update flag.

Implements Object.

Definition at line 32 of file Action.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 Object::update ( )
virtualinherited

Update this object.

Reimplemented in Option, OpalCavity, OpalConstantEFieldCavity, OpalDrift, OpalElement, OpalMarker, OpalMonitor, OpalMultipole, OpalProbe, OpalQuadrupole, OpalRBend, OpalRingDefinition, OpalSBend, OpalSolenoid, OpalSource, OpalTravelingWave, OpalVacuum, OpalVerticalFFAMagnet, Sequence, Beam, BinningCmd, BoundaryGeometry, FieldSolverCmd, OpalFilter, OpalLaser, OpalMultipoleT, OpalPolynomialTimeDependence, OpalSinusoidalTimeDependence, OpalSplineTimeDependence, and OpalVariableRFCavity.

Definition at line 239 of file Object.cpp.

Referenced by Distribution::execute().

◆ wireDaughterContainers()

void TrackRun::wireDaughterContainers ( const std::vector< Beam * > &  beams)
private

Wire daughter containers to cross-container processes (e.g. muon decay -> electron).

Note
Must be called after setupGlobalProcesses — reads processes from the containers.

Definition at line 603 of file TrackRun.cpp.

References Track::beamNames_m, Track::block, bunch_m, ParticleProperties::getParticleType(), gmsg, 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::Beam(), BoundaryGeometry::BoundaryGeometry(), Object::isBuiltin(), Object::Object(), Object::Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().

◆ bunch_m

std::unique_ptr<bunch_type> TrackRun::bunch_m
private

Definition at line 144 of file TrackRun.h.

Referenced by configureImageChargeFromSources(), execute(), setupDistributionsAndSamplers(), setupGlobalProcesses(), and wireDaughterContainers().

◆ distrs_m

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

Distributions referenced by all emission sources (non-owning raw pointers).

Definition at line 125 of file TrackRun.h.

Referenced by setupDistributionsAndSamplers().

◆ ds_m

DataSink* TrackRun::ds_m
private

Definition at line 132 of file TrackRun.h.

Referenced by execute(), and initDataSink().

◆ 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().

◆ fs_m

FieldSolverCmd* TrackRun::fs_m
private

Samplers for time-dependent (emitting) sources; tracker calls emitParticles(t, dt) on each.

Definition at line 130 of file TrackRun.h.

Referenced by configureImageChargeFromSources(), and execute().

◆ isFollowupTrack_m

bool TrackRun::isFollowupTrack_m
private

Definition at line 146 of file TrackRun.h.

Referenced by execute(), initDataSink(), and print().

◆ itsAttr

std::vector<Attribute> Object::itsAttr
inherited

The object attributes.

Definition at line 210 of file Object.h.

Referenced by Beam::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(), Beam::execute(), TrackCmd::execute(), 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(), Beam::getBunchCharge(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), Beam::getDaughterBeamName(), BinningCmd::getDesiredWidth(), EmissionSource::getDistributionName(), FieldSolverCmd::getDomDec(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), BinningCmd::getDumpBinsFileName(), BinningCmd::getDumpBinsFrequency(), EmissionSource::getEmissionModel(), Beam::getEmissionSourceListName(), Distribution::getEmissionSteps(), Distribution::getFilename(), BoundaryGeometry::getFilename(), Beam::getFrequency(), Beam::getGlobalProcessNames(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), OpalElement::getLength(), Line::getLength(), Sequence::getLength(), Beam::getMass(), BinningCmd::getMaxBins(), TrackCmd::getMaxSteps(), Beam::getNumAlloc(), FieldSolverCmd::getNX(), FieldSolverCmd::getNY(), FieldSolverCmd::getNZ(), EmissionSource::getP0(), BinningCmd::getParameter(), Beam::getParticleName(), Beam::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(), Beam::hasExplicitEnergy(), Beam::hasPolarization(), Help::Help(), BoundaryGeometry::initialize(), OpalFilter::initOpalFilter(), Beam::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(), Beam::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(), 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(), 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(), 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(), Beam::update(), BinningCmd::update(), FieldSolverCmd::update(), OpalLaser::update(), OpalMultipoleT::update(), OpalPolynomialTimeDependence::update(), OpalSinusoidalTimeDependence::update(), OpalSplineTimeDependence::update(), OpalVariableRFCavity::update(), Option::update(), OpalElement::updateUnknown(), Beam::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().

◆ itsTracker_m

std::unique_ptr<Tracker> TrackRun::itsTracker_m
private

Definition at line 122 of file TrackRun.h.

Referenced by execute().

◆ method_m

RunMethod TrackRun::method_m
private

Definition at line 148 of file TrackRun.h.

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

◆ 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().

◆ opal_m

OpalData* TrackRun::opal_m
private

Definition at line 136 of file TrackRun.h.

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

◆ phaseSpaceSinks_m

std::vector<std::unique_ptr<H5PartWrapper> > TrackRun::phaseSpaceSinks_m
private

Definition at line 134 of file TrackRun.h.

Referenced by borrowedPhaseSpaceSinks(), and initDataSink().

◆ 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().

◆ stringMethod_s

const BiMap< TrackRun::RunMethod, std::string > TrackRun::stringMethod_s
staticprivate
Initial value:
= []() {
BiMap<TrackRun::RunMethod, std::string> bimap;
bimap.insert(TrackRun::RunMethod::PARALLEL, "PARALLEL");
return bimap;
}()
BiMap
Simple bidirectional map with lookup in both directions.
Definition BiMap.h:28
BiMap::insert
void insert(const Left &left, const Right &right)
Insert or overwrite a left/right association.
Definition BiMap.h:99

Definition at line 188 of file TrackRun.h.

Referenced by getRunMethodName(), and setRunMethod().

◆ timeStamp

double Object::timeStamp
privateinherited

Definition at line 256 of file Object.h.

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