DumpEMFields dumps the dynamically changing fields of a Ring in a user- defined grid. More...

#include <DumpEMFields.h>

Inheritance diagram for DumpEMFields:

Collaboration diagram for DumpEMFields:

Public Types
enum	{ FILE_NAME , COORDINATE_SYSTEM , X_START , DX , X_STEPS , Y_START , DY , Y_STEPS , Z_START , DZ , Z_STEPS , T_START , DT , T_STEPS , R_START , DR , R_STEPS , PHI_START , DPHI , PHI_STEPS , SIZE }
	The common attributes of DumpEMFields. More...

Public Member Functions
	DumpEMFields ()
	Constructor. More...

	DumpEMFields (const std::string &name, DumpEMFields *parent)
	Constructor. More...

virtual	~DumpEMFields ()
	Destructor deletes grid_m and if in the dumps set, take it out. More...

virtual DumpEMFields *	clone (const std::string &name)
	Make a clone (overloadable copy-constructor). More...

virtual void	execute ()
	Builds the grid but does not write the field map. More...

void	print (std::ostream &os) const
	Print the attributes of DumpEMFields to standard out. More...

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

void	copyAttributes (const Object &)
	Copy attributes from another object. 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 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	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

int	addReference () const
	Increment reference count. More...

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

Static Public Member Functions
static void	writeFields (Component *field)
	Write the fields for all defined DumpEMFields objects. More...

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

Protected Attributes
bool	builtin
	Built-in flag. More...

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Private Types
enum class	CoordinateSystem : unsigned short { CARTESIAN , CYLINDRICAL }

Private Member Functions
virtual void	writeFieldThis (Component *field)

virtual void	buildGrid ()

void	parseCoordinateSystem ()

void	writeHeader (std::ofstream &fout) const

void	writeFieldLine (Component *field, const Vector_t< double, 3 > &point, const double &time, std::ofstream &fout) const

	DumpEMFields (const DumpEMFields &dump)

DumpEMFields &	operator= (const DumpEMFields &dump)

Static Private Member Functions
static void	checkInt (double value, std::string name, double tolerance=1e-9)

Private Attributes
interpolation::NDGrid *	grid_m

std::string	filename_m

CoordinateSystem	coordinates_m = CoordinateSystem::CARTESIAN

Object *	itsParent

std::string	itsName

std::string	itsHelp

int	occurrence

double	timeStamp

std::set< Invalidator * >	references

bool	sharedFlag

int	refCount

Static Private Attributes
static std::unordered_set< DumpEMFields * >	dumpsSet_m

Detailed Description

DumpEMFields dumps the dynamically changing fields of a Ring in a user- defined grid.

The idea is to print out the field map across a 4D grid in space-time for debugging purposes. The problem is to manage the DumpEMFields object through three phases of program execution; initial construction, parsing and then actual field map writing (where we need to somehow let DumpFields know what the field maps are). So for each DumpEMFields object created, we store in a set. When the execute() method is called, DumpEMFields builds a grid using the parsed information.

When the ParallelCyclotronTracker is about to start tracking, it calls writeFields method which loops over the static set of DumpEMFields and writes each one. It is not the cleanest implementation, but I can't see a better way.

The DumpEMFields themselves operate by iterating over a NDGrid object and looking up the field/writing it out on each grid point.

Definition at line 54 of file DumpEMFields.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The common attributes of DumpEMFields.

Enumerator
FILE_NAME
COORDINATE_SYSTEM
X_START
DX
X_STEPS
Y_START
DY
Y_STEPS
Z_START
DZ
Z_STEPS
T_START
DT
T_STEPS
R_START
DR
R_STEPS
PHI_START
DPHI
PHI_STEPS
SIZE

Definition at line 58 of file DumpEMFields.h.

◆ CoordinateSystem

enum class DumpEMFields::CoordinateSystem : unsigned short

strongprivate

Enumerator
CARTESIAN
CYLINDRICAL

Definition at line 128 of file DumpEMFields.h.

Constructor & Destructor Documentation

◆ DumpEMFields() [1/3]

DumpEMFields::DumpEMFields ( )

Constructor.

Definition at line 39 of file DumpEMFields.cpp.

References COORDINATE_SYSTEM, DPHI, DR, DT, DX, DY, DZ, FILE_NAME, Object::itsAttr, Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeString(), PHI_START, PHI_STEPS, R_START, R_STEPS, Object::registerOwnership(), AttributeHandler::STATEMENT, T_START, T_STEPS, X_START, X_STEPS, Y_START, Y_STEPS, Z_START, and Z_STEPS.

Referenced by clone().

Here is the call graph for this function:

◆ DumpEMFields() [2/3]

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

Constructor.

Definition at line 111 of file DumpEMFields.cpp.

◆ ~DumpEMFields()

DumpEMFields::~DumpEMFields ( )

virtual

Destructor deletes grid_m and if in the dumps set, take it out.

Definition at line 115 of file DumpEMFields.cpp.

References dumpsSet_m, and grid_m.

◆ DumpEMFields() [3/3]

DumpEMFields::DumpEMFields ( const DumpEMFields & dump )

private

Member Function Documentation

◆ addReference()

int RCObject::addReference ( ) const

inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References RCObject::refCount.

Referenced by Pointer< Object >::operator=(), and Pointer< Object >::unique().

◆ buildGrid()

void DumpEMFields::buildGrid ( )

privatevirtual

Definition at line 150 of file DumpEMFields.cpp.

References CARTESIAN, checkInt(), coordinates_m, CYLINDRICAL, DPHI, DR, DT, DX, DY, DZ, FILE_NAME, filename_m, Attributes::getReal(), Attributes::getString(), grid_m, Object::itsAttr, nr, parseCoordinateSystem(), PHI_START, PHI_STEPS, R_START, R_STEPS, T_START, T_STEPS, X_START, X_STEPS, Y_START, Y_STEPS, Z_START, and Z_STEPS.

Referenced by execute().

Here is the call graph for this function:

◆ canReplaceBy()

bool Action::canReplaceBy ( Object * object )

virtualinherited

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 29 of file Action.cpp.

◆ checkInt()

void DumpEMFields::checkInt	(	double	value,
		std::string	name,
		double	tolerance = `1e-9`
	)

staticprivate

Definition at line 217 of file DumpEMFields.cpp.

Referenced by buildGrid().

◆ clear()

void Object::clear ( )

inherited

Clear the occurrence counter.

Definition at line 339 of file Object.cpp.

References Object::occurrence.

◆ clone()

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

virtual

Make a clone (overloadable copy-constructor).

Parameters

name	not used If this is in the dumpsSet_m, so will the clone. Not sure how the itsAttr stuff works, so this may not get properly copied?

Implements Object.

Definition at line 120 of file DumpEMFields.cpp.

References interpolation::NDGrid::clone(), coordinates_m, DumpEMFields(), dumpsSet_m, filename_m, and grid_m.

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 54 of file Object.cpp.

References Object::itsAttr.

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

◆ execute()

void DumpEMFields::execute ( )

virtual

Builds the grid but does not write the field map.

Builds a grid of points in x-y-z space using the NDGrid algorithm. Checks that X_STEPS, Y_STEPS, Z_STEPS are integers or throws OpalException.

Reimplemented from Object.

Definition at line 141 of file DumpEMFields.cpp.

References buildGrid(), clone(), and dumpsSet_m.

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 64 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(), and Object::parseShortcut().

◆ findAttribute() [2/2]

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

virtualinherited

Find an attribute by name.

Definition at line 72 of file Object.cpp.

References Object::itsAttr.

◆ getBaseObject()

const Object * Object::getBaseObject ( ) const

inherited

Return the object's base type object.

Definition at line 301 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 34 of file Action.cpp.

◆ getOpalName()

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

inherited

Return object name.

Definition at line 308 of file Object.cpp.

References Object::itsName.

Referenced by OpalOffset::OpalLocalCartesianOffset::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::parseShortcut(), Object::print(), OpalElement::print(), Sequence::print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), Beam::print(), OpalFilter::print(), Line::print(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), OpalElement::registerOwnership(), Object::registerOwnership(), Line::replace(), Sequence::replace(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), Beam::update(), BoundaryGeometry::update(), and OpalFilter::update().

◆ getParent()

Object * Object::getParent ( ) const

inherited

Return parent pointer.

Definition at line 313 of file Object.cpp.

References Object::itsParent.

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

◆ increment()

int Object::increment ( )

inherited

Increment and return the occurrence counter.

Definition at line 344 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 266 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 287 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 297 of file Object.cpp.

References Object::flagged.

◆ isShared()

bool Object::isShared ( ) const

virtualinherited

Shared flag.

Definition at line 271 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 318 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 89 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 82 of file Object.cpp.

Referenced by OpalParser::parseMacro().

◆ occurrenceCount()

int Object::occurrenceCount ( )

inherited

Return the occurrence counter.

Definition at line 349 of file Object.cpp.

References Object::occurrence.

◆ operator=()

DumpEMFields & DumpEMFields::operator= ( const DumpEMFields & dump )

private

◆ parse()

void Object::parse ( Statement & stat )

virtualinherited

Parse the object.

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

Definition at line 95 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:

◆ parseCoordinateSystem()

void DumpEMFields::parseCoordinateSystem ( )

private

Definition at line 133 of file DumpEMFields.cpp.

References CARTESIAN, COORDINATE_SYSTEM, coordinates_m, CYLINDRICAL, Attributes::getString(), and Object::itsAttr.

Referenced by buildGrid().

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 127 of file Object.cpp.

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

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

Here is the call graph for this function:

◆ print()

void DumpEMFields::print ( std::ostream & os ) const

virtual

Print the attributes of DumpEMFields to standard out.

Reimplemented from Object.

Definition at line 349 of file DumpEMFields.cpp.

References CARTESIAN, COORDINATE_SYSTEM, coordinates_m, CYLINDRICAL, DPHI, DR, DT, DX, DY, DZ, endl(), filename_m, Attributes::getReal(), Attributes::getString(), Object::itsAttr, PHI_START, PHI_STEPS, R_START, R_STEPS, T_START, T_STEPS, X_START, X_STEPS, Y_START, Y_STEPS, Z_START, and Z_STEPS.

Referenced by operator<<().

Here is the call graph for this function:

◆ printHelp()

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

virtualinherited

Print help.

Definition at line 199 of file Object.cpp.

References endl(), gmsg, Object::itsAttr, Object::itsHelp, and ippl::max().

Referenced by Help::execute().

Here is the call graph for this function:

◆ printValue()

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

inlinevirtualinherited

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

Definition at line 280 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 189 of file Object.cpp.

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

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Distribution::Distribution(), DumpEMFields(), DumpFields::DumpFields(), Echo::Echo(), 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 180 of file Object.cpp.

References Object::references.

◆ removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ replace()

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

virtualinherited

Replace references.

Reimplemented in Line, and Sequence.

Definition at line 256 of file Object.cpp.

◆ setDirty()

void Object::setDirty ( bool dirty )

inherited

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

Definition at line 281 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 292 of file Object.cpp.

References Object::flagged.

◆ setOpalName()

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

inherited

Set object name.

Definition at line 329 of file Object.cpp.

References Object::itsName.

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

◆ setParent()

void Object::setParent ( Object * parent )

inherited

Set parent object.

Definition at line 334 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 276 of file Object.cpp.

References Object::sharedFlag.

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

◆ shouldTrace()

bool Action::shouldTrace ( ) const

virtualinherited

Trace flag.

Implements Object.

Definition at line 39 of file Action.cpp.

◆ shouldUpdate()

bool Action::shouldUpdate ( ) const

virtualinherited

Update flag.

Implements Object.

Definition at line 44 of file Action.cpp.

◆ unregisterReference()

void Object::unregisterReference ( Invalidator * a )

inherited

Unegister a reference to this object.

Definition at line 185 of file Object.cpp.

References Object::references.

◆ update()

void Object::update ( )

virtualinherited

Update this object.

Reimplemented in Option, OpalCavity, OpalDrift, OpalElement, OpalMarker, OpalMonitor, OpalMultipole, OpalMultipoleT, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalProbe, OpalRingDefinition, OpalSolenoid, OpalSource, OpalTravelingWave, OpalVacuum, OpalVerticalFFAMagnet, Sequence, Beam, BoundaryGeometry, FieldSolverCmd, and OpalFilter.

Definition at line 261 of file Object.cpp.

Referenced by Distribution::execute().

◆ writeFieldLine()

void DumpEMFields::writeFieldLine	(	Component *	field,
		const Vector_t< double, 3 > &	point,
		const double &	time,
		std::ofstream &	fout
	)		const

private

Definition at line 263 of file DumpEMFields.cpp.

References Component::apply(), coordinates_m, CYLINDRICAL, and Units::rad2deg.

Referenced by writeFieldThis().

Here is the call graph for this function:

◆ writeFields()

void DumpEMFields::writeFields ( Component * field )

static

Write the fields for all defined DumpEMFields objects.

Parameters

field borrowed reference to the Component object that holds the field map; caller owns the memory. Iterates over the DumpEMFields in the dumpsSet_m and calls writeFieldThis on each DumpEMFields. This writes each field map in turn. Format is: <number of rows> <column 1> <units> <column 2> <units> <column 3> <units> <column 4> <units> <column 5> <units> <column 6> <units> 0 <field map data>

Definition at line 210 of file DumpEMFields.cpp.

References dumpsSet_m.

◆ writeFieldThis()

void DumpEMFields::writeFieldThis ( Component * field )

privatevirtual

Definition at line 295 of file DumpEMFields.cpp.

References interpolation::NDGrid::begin(), Util::combineFilePath(), end(), endl(), filename_m, OpalData::getAuxiliaryOutputDirectory(), OpalData::getInstance(), gmsg, grid_m, writeFieldLine(), and writeHeader().

Here is the call graph for this function:

◆ writeHeader()

void DumpEMFields::writeHeader ( std::ofstream & fout ) const

private

Definition at line 230 of file DumpEMFields.cpp.

References CARTESIAN, coordinates_m, CYLINDRICAL, interpolation::NDGrid::end(), endl(), grid_m, and interpolation::Mesh::Iterator::toInteger().

Referenced by writeFieldThis().

Here is the call graph for this function:

Member Data Documentation

◆ builtin

bool Object::builtin

protectedinherited

Built-in flag.

Definition at line 233 of file Object.h.

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

◆ coordinates_m

CoordinateSystem DumpEMFields::coordinates_m = CoordinateSystem::CARTESIAN

private

Definition at line 146 of file DumpEMFields.h.

Referenced by buildGrid(), clone(), parseCoordinateSystem(), print(), writeFieldLine(), and writeHeader().

◆ dumpsSet_m

std::unordered_set< DumpEMFields * > DumpEMFields::dumpsSet_m

staticprivate

Definition at line 148 of file DumpEMFields.h.

Referenced by clone(), execute(), writeFields(), and ~DumpEMFields().

◆ filename_m

std::string DumpEMFields::filename_m

private

Definition at line 144 of file DumpEMFields.h.

Referenced by buildGrid(), clone(), print(), and writeFieldThis().

◆ flagged

bool Object::flagged

protectedinherited

Object flag.

Definition at line 242 of file Object.h.

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

◆ grid_m

interpolation::NDGrid* DumpEMFields::grid_m

private

Definition at line 143 of file DumpEMFields.h.

Referenced by buildGrid(), clone(), writeFieldThis(), writeHeader(), and ~DumpEMFields().

◆ itsAttr

std::vector<Attribute> Object::itsAttr

inherited

The object attributes.

Definition at line 216 of file Object.h.

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), buildGrid(), DumpFields::buildGrid(), Call::Call(), FieldSolverCmd::constructBCHandler(), Object::copyAttributes(), Distribution::Distribution(), DumpEMFields(), DumpFields::DumpFields(), Echo::Echo(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), Value::execute(), Beam::execute(), TrackCmd::execute(), TrackRun::execute(), FieldSolverCmd::FieldSolverCmd(), Object::findAttribute(), BoundaryGeometry::getA(), OpalElement::getApert(), BoundaryGeometry::getB(), BoolConstant::getBool(), FieldSolverCmd::getBoxIncr(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), FieldSolverCmd::getDomDec(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), BoundaryGeometry::getFilename(), Beam::getFrequency(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), OpalElement::getLength(), Line::getLength(), Sequence::getLength(), Beam::getMass(), TrackCmd::getMaxSteps(), Beam::getNumberOfParticles(), FieldSolverCmd::getNX(), FieldSolverCmd::getNY(), FieldSolverCmd::getNZ(), Beam::getParticleName(), RealConstant::getReal(), RealVariable::getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), TrackCmd::getStepsPerTurn(), StringConstant::getString(), TrackCmd::getT0(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), FieldSolverCmd::getType(), TrackCmd::getZStart(), TrackCmd::getZStop(), Help::Help(), BoundaryGeometry::initialize(), OpalFilter::initOpalFilter(), Line::Line(), OpalCavity::OpalCavity(), OpalDrift::OpalDrift(), OpalElement::OpalElement(), OpalFilter::OpalFilter(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalProbe::OpalProbe(), OpalRingDefinition::OpalRingDefinition(), OpalSolenoid::OpalSolenoid(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), Option::Option(), Sequence::parse(), Line::parse(), parseCoordinateSystem(), TrackRun::print(), Object::print(), Sequence::print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), print(), DumpFields::print(), Beam::print(), OpalFilter::print(), Object::printHelp(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), BoolConstant::printValue(), RealConstant::printValue(), RealVariable::printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), OpalElement::registerOwnership(), Object::registerOwnership(), Select::Select(), Select::select(), Sequence::Sequence(), Distribution::setDistParametersFlatTop(), Distribution::setDistParametersMultiVariateGauss(), Distribution::setDistType(), FieldSolverCmd::setNX(), FieldSolverCmd::setNY(), FieldSolverCmd::setNZ(), TrackRun::setRunMethod(), Distribution::setSigmaP_m(), Distribution::setSigmaR_m(), TrackRun::setupBoundaryGeometry(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), OpalCavity::update(), OpalDrift::update(), OpalElement::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalProbe::update(), OpalRingDefinition::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalVerticalFFAMagnet::update(), Beam::update(), FieldSolverCmd::update(), Option::update(), OpalElement::updateUnknown(), ValueDefinition::value(), and Value::Value().

◆ itsHelp

std::string Object::itsHelp

privateinherited

Definition at line 258 of file Object.h.

Referenced by Object::printHelp().

◆ itsName

std::string Object::itsName

privateinherited

Definition at line 255 of file Object.h.

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

◆ itsParent

Object* Object::itsParent

privateinherited

Definition at line 252 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 238 of file Object.h.

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

◆ occurrence

int Object::occurrence

privateinherited

Definition at line 261 of file Object.h.

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

◆ refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

Referenced by RCObject::addReference(), RCObject::isShared(), and RCObject::removeReference().

◆ references

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

privateinherited

Definition at line 268 of file Object.h.

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

◆ sharedFlag

bool Object::sharedFlag

privateinherited

Definition at line 271 of file Object.h.

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

◆ timeStamp

double Object::timeStamp

privateinherited

Definition at line 264 of file Object.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ CoordinateSystem

Constructor & Destructor Documentation

◆ DumpEMFields() [1/3]

◆ DumpEMFields() [2/3]

◆ ~DumpEMFields()

◆ DumpEMFields() [3/3]

Member Function Documentation

◆ addReference()

◆ buildGrid()

◆ canReplaceBy()

◆ checkInt()

◆ clear()

◆ clone()

◆ copyAttributes()

◆ execute()

◆ findAttribute() [1/2]

◆ findAttribute() [2/2]

◆ getBaseObject()

◆ getCategory()

◆ getOpalName()

◆ getParent()

◆ increment()

◆ isBuiltin()

◆ isDirty()

◆ isFlagged()

◆ isShared()

◆ isTreeMember()

◆ makeInstance()

◆ makeTemplate()

◆ occurrenceCount()

◆ operator=()

◆ parse()

◆ parseCoordinateSystem()

◆ parseShortcut()

◆ print()

◆ printHelp()

◆ printValue()

◆ registerOwnership()

◆ registerReference()

◆ removeReference()

◆ replace()

◆ setDirty()

◆ setFlag()

◆ setOpalName()

◆ setParent()

◆ setShared()

◆ shouldTrace()

◆ shouldUpdate()

◆ unregisterReference()

◆ update()

◆ writeFieldLine()

◆ writeFields()

◆ writeFieldThis()

◆ writeHeader()

Member Data Documentation

◆ builtin

◆ coordinates_m

◆ dumpsSet_m

◆ filename_m

◆ flagged

◆ grid_m

◆ itsAttr

◆ itsHelp

◆ itsName

◆ itsParent

◆ modified

◆ occurrence