DumpEMFields Class Reference

#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 ()
	DumpEMFields (const std::string &name, DumpEMFields *parent)
virtual	~DumpEMFields ()
virtual DumpEMFields *	clone (const std::string &name)
virtual void	execute ()
void	print (std::ostream &os) const
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
int	addReference () const
	Increment reference count.
int	removeReference () const
	Decrement the reference count.

Static Public Member Functions
static void	writeFields (Component *field)

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	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 &point, const double &time, std::ofstream &fout) const
	DumpEMFields (const DumpEMFields &dump)
DumpEMFields &	operator= (const DumpEMFields &dump)

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 38 of file DumpEMFields.cpp.

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

Referenced by clone(), DumpEMFields(), DumpEMFields(), and operator=().

Here is the call graph for this function:

DumpEMFields() [2/3]

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

Constructor

Definition at line 110 of file DumpEMFields.cpp.

References Action::Action(), DumpEMFields(), grid_m, and name.

Here is the call graph for this function:

~DumpEMFields()

DumpEMFields::~DumpEMFields ( )

virtual

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

Definition at line 114 of file DumpEMFields.cpp.

References dumpsSet_m, and grid_m.

DumpEMFields() [3/3]

DumpEMFields::DumpEMFields ( const DumpEMFields & dump )

private

References DumpEMFields().

Here is the call graph for this function:

Member Function Documentation

addReference()

int RCObject::addReference ( ) const

inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References refCount.

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

buildGrid()

void DumpEMFields::buildGrid ( )

privatevirtual

Definition at line 149 of file DumpEMFields.cpp.

References CARTESIAN, Util::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.

References Object::Object().

Here is the call graph for this function:

clear()

void Object::clear ( )

inherited

Clear the occurrence counter.

Definition at line 341 of file Object.cpp.

References 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 119 of file DumpEMFields.cpp.

References coordinates_m, DumpEMFields(), dumpsSet_m, filename_m, grid_m, and name.

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

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

Here is the call graph for this function:

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 140 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 itsAttr, and name.

Referenced by OpalElement::getParticleMatterInteraction(), OpalElement::getTypeName(), OpalElement::getWakeF(), Line::parse(), parse(), OpalElement::parse(), OpalParser::parseAssign(), SequenceParser::parsePosition(), and parseShortcut().

findAttribute() [2/2]

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

virtualinherited

Find an attribute by name.

Definition at line 74 of file Object.cpp.

References itsAttr, and name.

getBaseObject()

const Object * Object::getBaseObject ( ) const

inherited

Return the object's base type object.

Definition at line 303 of file Object.cpp.

References itsParent, and Object().

Here is the call graph for this function:

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

References itsName.

Referenced by Macro::clone(), OpalOffset::OpalLocalCartesianOffset::clone(), OpalVariableRFCavity::clone(), OpalVariableRFCavityFringeField::clone(), OpalData::create(), OpalData::define(), Sequence::findDriftLength(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), ParticleMatterInteraction::initParticleMatterInteractionHandler(), OpalWake::initWakefunction(), List::list(), LineTemplate::makeInstance(), makeInstance(), SequenceTemplate::makeInstance(), parse(), SequenceParser::parsePosition(), Beam::print(), BoolConstant::print(), Line::print(), print(), OpalElement::print(), OpalFilter::print(), OpalTrimCoil::print(), OpalWake::print(), ParticleMatterInteraction::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), BoundaryGeometry::printInfo(), FieldSolver::printInfo(), registerOwnership(), OpalElement::registerOwnership(), Line::replace(), Sequence::replace(), OpalScalingFFAMagnet::setupDefaultEndField(), Beam::update(), BoundaryGeometry::update(), OpalAsymmetricEnge::update(), OpalCavity::update(), OpalDrift::update(), OpalECollimator::update(), OpalEnge::update(), OpalFilter::update(), OpalFlexibleCollimator::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalPepperPot::update(), OpalPolynomialTimeDependence::update(), OpalProbe::update(), OpalRBend3D::update(), OpalRBend::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSeptum::update(), OpalSinusoidalTimeDependence::update(), OpalSlit::update(), OpalSplineTimeDependence::update(), OpalTravelingWave::update(), OpalTrimCoil::update(), OpalWake::update(), ParticleMatterInteraction::update(), and Distribution::writeOutFileHeader().

getParent()

Object * Object::getParent ( ) const

inherited

Return parent pointer.

Definition at line 315 of file Object.cpp.

References itsParent, and Object().

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

Here is the call graph for this function:

increment()

int Object::increment ( )

inherited

Increment and return the occurrence counter.

Definition at line 346 of file Object.cpp.

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

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

References modified.

isFlagged()

bool Object::isFlagged ( ) const

inherited

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

Definition at line 299 of file Object.cpp.

References flagged.

isShared()

bool Object::isShared ( ) const

virtualinherited

Shared flag.

Definition at line 273 of file Object.cpp.

References sharedFlag.

Referenced by Sequence::print().

isTreeMember()

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

inherited

Test for tree membership.

Definition at line 320 of file Object.cpp.

References Object().

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

Here is the call graph for this function:

makeInstance()

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

virtualinherited

Macro handler function.

Reimplemented in LineTemplate, MacroCmd, and SequenceTemplate.

Definition at line 91 of file Object.cpp.

References getOpalName(), and Object().

Referenced by OpalParser::parseDefine(), Line::parseList(), OpalParser::parseMacro(), and SequenceParser::parseMember().

Here is the call graph for this function:

makeTemplate()

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

virtualinherited

Macro handler function.

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

Definition at line 84 of file Object.cpp.

References name, and Object().

Referenced by OpalParser::parseMacro().

Here is the call graph for this function:

occurrenceCount()

int Object::occurrenceCount ( )

inherited

Return the occurrence counter.

Definition at line 351 of file Object.cpp.

References occurrence.

operator=()

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

private

References DumpEMFields().

Here is the call graph for this function:

parse()

void Object::parse ( Statement & stat )

virtualinherited

Parse the object.

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

Definition at line 97 of file Object.cpp.

References Statement::delimiter(), findAttribute(), getOpalName(), name, 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 132 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 129 of file Object.cpp.

References Statement::delimiter(), findAttribute(), Statement::mark(), name, 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 335 of file DumpEMFields.cpp.

References CARTESIAN, COORDINATE_SYSTEM, coordinates_m, CYLINDRICAL, DPHI, DR, DT, DX, DY, DZ, 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 201 of file Object.cpp.

References endl(), gmsg, itsAttr, itsHelp, and name.

Referenced by Help::execute(), and opalMain().

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

Here is the call graph for this function:

registerOwnership()

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

inherited

Definition at line 191 of file Object.cpp.

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

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Constraint::Constraint(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), DVar::DVar(), Echo::Echo(), FieldSolver::FieldSolver(), Help::Help(), Line::Line(), List::List(), Objective::Objective(), OpalFilter::OpalFilter(), OpalSample::OpalSample(), OpalTrimCoil::OpalTrimCoil(), OpalWake::OpalWake(), OptimizeCmd::OptimizeCmd(), Option::Option(), ParticleMatterInteraction::ParticleMatterInteraction(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), SampleCmd::SampleCmd(), Select::Select(), Sequence::Sequence(), Distribution::setAttributes(), 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 182 of file Object.cpp.

References references.

removeReference()

int RCObject::removeReference ( ) const

inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References refCount.

replace()

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

virtualinherited

Replace references.

Reimplemented in Line, and Sequence.

Definition at line 258 of file Object.cpp.

References Object().

Here is the call graph for this function:

setDirty()

void Object::setDirty ( bool dirty )

inherited

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

Definition at line 283 of file Object.cpp.

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

References flagged.

setOpalName()

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

inherited

Set object name.

Definition at line 331 of file Object.cpp.

References itsName, and name.

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

setParent()

void Object::setParent ( Object * parent )

inherited

Set parent object.

Definition at line 336 of file Object.cpp.

References itsParent, and Object().

Referenced by OpalData::erase().

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

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

References references.

update()

void Object::update ( )

virtualinherited

Update this object.

Reimplemented in Beam, BoundaryGeometry, Distribution, FieldSolver, OpalAsymmetricEnge, OpalCavity, OpalCCollimator, OpalCyclotron, OpalDegrader, OpalDrift, OpalECollimator, OpalElement, OpalEnge, OpalFilter, OpalFlexibleCollimator, OpalHKicker, OpalKicker, OpalMarker, OpalMonitor, OpalMultipole, OpalMultipoleT, OpalOctupole, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalOutputPlane, OpalPepperPot, OpalPolynomialTimeDependence, OpalProbe, OpalQuadrupole, OpalRBend3D, OpalRBend, OpalRCollimator, OpalRingDefinition, OpalSBend3D, OpalSBend, OpalScalingFFAMagnet, OpalSeptum, OpalSextupole, OpalSinusoidalTimeDependence, OpalSlit, OpalSolenoid, OpalSource, OpalSplineTimeDependence, OpalStripper, OpalTravelingWave, OpalTrimCoil, OpalUndulator, OpalVacuum, OpalVariableRFCavity, OpalVariableRFCavityFringeField, OpalVerticalFFAMagnet, OpalVKicker, OpalWake, Option, ParticleMatterInteraction, PyOpal::PyOpalGlobalCartesianOffset::OpalGlobalCartesianOffset, PyOpal::PyOpalLocalCartesianOffset::OpalLocalCartesianOffset, and Sequence.

Definition at line 263 of file Object.cpp.

Referenced by PyOpal::PyDistributionNS::registerDistribution().

writeFieldLine()

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

private

Definition at line 249 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 209 of file DumpEMFields.cpp.

References dumpsSet_m.

Referenced by ParallelCyclotronTracker::execute().

writeFieldThis()

void DumpEMFields::writeFieldThis ( Component * field )

privatevirtual

Definition at line 281 of file DumpEMFields.cpp.

References 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 216 of file DumpEMFields.cpp.

References CARTESIAN, coordinates_m, CYLINDRICAL, and grid_m.

Referenced by writeFieldThis().

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(), Distribution::Distribution(), isBuiltin(), Object(), Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), OpalTrimCoil::OpalTrimCoil(), OpalWake::OpalWake(), ParticleMatterInteraction::ParticleMatterInteraction(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().

coordinates_m

CoordinateSystem DumpEMFields::coordinates_m = CoordinateSystem::CARTESIAN

private

Definition at line 145 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 147 of file DumpEMFields.h.

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

filename_m

std::string DumpEMFields::filename_m

private

Definition at line 143 of file DumpEMFields.h.

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

flagged

bool Object::flagged

protectedinherited

Object flag.

Definition at line 242 of file Object.h.

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

grid_m

interpolation::NDGrid* DumpEMFields::grid_m

private

Definition at line 142 of file DumpEMFields.h.

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

itsAttr

std::vector<Attribute> Object::itsAttr

inherited

The object attributes.

Definition at line 216 of file Object.h.

Referenced by Distribution::adjustPhaseSpace(), Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), DumpFields::buildGrid(), Distribution::calcPartPerDist(), Call::Call(), Distribution::checkEmissionParameters(), Distribution::checkIfEmitted(), Distribution::chooseInputMomentumUnits(), Constraint::Constraint(), copyAttributes(), Distribution::create(), Distribution::createDistributionFromFile(), Distribution::createDistributionMultiGauss(), Distribution::createMatchedGaussDistribution(), Distribution::createOpalT(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), DVar::DVar(), Echo::Echo(), Beam::execute(), Call::execute(), Echo::execute(), Help::execute(), List::execute(), OptimizeCmd::execute(), Option::execute(), PSystem::execute(), SampleCmd::execute(), Select::execute(), System::execute(), Title::execute(), TrackCmd::execute(), TrackRun::execute(), Value::execute(), FieldSolver::FieldSolver(), findAttribute(), findAttribute(), Distribution::generateAstraFlattopT(), Distribution::generateBinomial(), Distribution::generateFlattopLaserProfile(), Distribution::generateFlattopT(), Distribution::generateFlattopZ(), Distribution::generateGaussZ(), Distribution::generateLongFlattopT(), Distribution::generateMatchedGauss(), Distribution::generateTransverseGauss(), BoundaryGeometry::getA(), OpalElement::getApert(), BoundaryGeometry::getB(), BoolConstant::getBool(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), Distribution::getEmissionTimeShift(), Constraint::getExpression(), Objective::getExpression(), BoundaryGeometry::getFilename(), Beam::getFrequency(), ParticleMatterInteraction::getInteractionType(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), Line::getLength(), OpalElement::getLength(), Sequence::getLength(), DVar::getLowerBound(), Beam::getMass(), TrackCmd::getMaxSteps(), FieldSolver::getMT(), FieldSolver::getMX(), FieldSolver::getMY(), OpalWake::getNumberOfBins(), Beam::getNumberOfParticles(), Distribution::getNumberOfParticlesInFile(), Beam::getParticleName(), RealConstant::getReal(), RealVariable::getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), TrackCmd::getStepsPerTurn(), StringConstant::getString(), TrackCmd::getT0(), FieldSolver::getTagging_m(), Distribution::getTEmission(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), OpalTrimCoil::getTrimCoilType(), FieldSolver::getType(), DVar::getUpperBound(), DVar::getVariable(), OpalSample::getVariable(), Distribution::getWeight(), TrackCmd::getZStart(), TrackCmd::getZStop(), FieldSolver::hasPeriodicZ(), Help::Help(), FieldSolver::initAmrObject_m(), FieldSolver::initAmrSolver_m(), FieldSolver::initCartesianFields(), BoundaryGeometry::initialize(), OpalSample::initialize(), OpalFilter::initOpalFilter(), OpalTrimCoil::initOpalTrimCoil(), ParticleMatterInteraction::initParticleMatterInteractionHandler(), FieldSolver::initSolver(), OpalWake::initWakefunction(), Distribution::injectBeam(), Line::Line(), List::List(), List::list(), Object(), Object(), Objective::Objective(), OpalAsymmetricEnge::OpalAsymmetricEnge(), OpalBend::OpalBend(), OpalCavity::OpalCavity(), OpalCCollimator::OpalCCollimator(), OpalCyclotron::OpalCyclotron(), OpalDegrader::OpalDegrader(), OpalDrift::OpalDrift(), OpalECollimator::OpalECollimator(), OpalElement::OpalElement(), OpalEnge::OpalEnge(), OpalFilter::OpalFilter(), OpalFlexibleCollimator::OpalFlexibleCollimator(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalHKicker::OpalHKicker(), OpalKicker::OpalKicker(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalOctupole::OpalOctupole(), OpalOutputPlane::OpalOutputPlane(), OpalPepperPot::OpalPepperPot(), OpalPolynomialTimeDependence::OpalPolynomialTimeDependence(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalRBend3D::OpalRBend3D(), OpalRCollimator::OpalRCollimator(), OpalRingDefinition::OpalRingDefinition(), OpalSample::OpalSample(), OpalSBend3D::OpalSBend3D(), OpalScalingFFAMagnet::OpalScalingFFAMagnet(), OpalSeptum::OpalSeptum(), OpalSextupole::OpalSextupole(), OpalSinusoidalTimeDependence::OpalSinusoidalTimeDependence(), OpalSlit::OpalSlit(), OpalSolenoid::OpalSolenoid(), OpalSource::OpalSource(), OpalSplineTimeDependence::OpalSplineTimeDependence(), OpalStripper::OpalStripper(), OpalTravelingWave::OpalTravelingWave(), OpalTrimCoil::OpalTrimCoil(), OpalUndulator::OpalUndulator(), OpalVacuum::OpalVacuum(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), OpalVKicker::OpalVKicker(), OpalWake::OpalWake(), OptimizeCmd::OptimizeCmd(), Option::Option(), Option::Option(), Line::parse(), Sequence::parse(), DumpEMFields::parseCoordinateSystem(), ParticleMatterInteraction::ParticleMatterInteraction(), Beam::print(), BoolConstant::print(), DumpEMFields::print(), DumpFields::print(), print(), OpalFilter::print(), OpalTrimCoil::print(), OpalWake::print(), ParticleMatterInteraction::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), TrackRun::print(), Distribution::printDistFlattop(), Distribution::printDistFromFile(), Distribution::printDistGauss(), Distribution::printEmissionModelAstra(), Distribution::printEmissionModelNone(), printHelp(), BoundaryGeometry::printInfo(), Distribution::printInfo(), FieldSolver::printInfo(), BoolConstant::printValue(), RealConstant::printValue(), RealVariable::printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVariable::RealVariable(), RealVector::RealVector(), registerOwnership(), OpalElement::registerOwnership(), OptimizeCmd::run(), SampleCmd::SampleCmd(), Distribution::scaleDistCoordinates(), Select::Select(), Select::select(), Sequence::Sequence(), Distribution::setAttributes(), TrackRun::setBoundaryGeometry(), Distribution::setDistParametersBinomial(), Distribution::setDistParametersFlattop(), Distribution::setDistParametersGauss(), Distribution::setDistParametersMultiGauss(), TrackRun::setDistributionParallelT(), Distribution::setDistType(), FieldSolver::setMT(), FieldSolver::setMX(), FieldSolver::setMY(), TrackRun::setRunMethod(), Distribution::setSigmaP_m(), Distribution::setSigmaR_m(), TrackRun::setupCyclotronTracker(), OpalScalingFFAMagnet::setupDefaultEndField(), Distribution::setupEmissionModel(), Distribution::setupEmissionModelAstra(), Distribution::setupEmissionModelNone(), Distribution::setupEmissionModelNonEquil(), TrackRun::setupFieldsolver(), OpalScalingFFAMagnet::setupNamedEndField(), Distribution::setupParticleBins(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), Distribution::shiftDistCoordinates(), StringConstant::StringConstant(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), Beam::update(), OpalAsymmetricEnge::update(), OpalCavity::update(), OpalCCollimator::update(), OpalCyclotron::update(), OpalDegrader::update(), OpalDrift::update(), OpalECollimator::update(), OpalElement::update(), OpalEnge::update(), OpalFlexibleCollimator::update(), OpalHKicker::update(), OpalKicker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalOctupole::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalOutputPlane::update(), OpalPepperPot::update(), OpalPolynomialTimeDependence::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend3D::update(), OpalRBend::update(), OpalRCollimator::update(), OpalRingDefinition::update(), OpalSBend3D::update(), OpalSBend::update(), OpalScalingFFAMagnet::update(), OpalSeptum::update(), OpalSextupole::update(), OpalSinusoidalTimeDependence::update(), OpalSlit::update(), OpalSolenoid::update(), OpalSource::update(), OpalSplineTimeDependence::update(), OpalStripper::update(), OpalTravelingWave::update(), OpalUndulator::update(), OpalVacuum::update(), OpalVariableRFCavity::update(), OpalVariableRFCavityFringeField::update(), OpalVerticalFFAMagnet::update(), OpalVKicker::update(), Option::update(), OpalElement::updateUnknown(), Value::Value(), ValueDefinition::value(), ValueDefinition::value(), Distribution::writeOutFileEmission(), Distribution::writeOutFileHeader(), and Distribution::writeOutFileInjection().

itsHelp

std::string Object::itsHelp

privateinherited

Definition at line 258 of file Object.h.

Referenced by Object(), Object(), and printHelp().

itsName

std::string Object::itsName

privateinherited

Definition at line 255 of file Object.h.

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

itsParent

Object* Object::itsParent

privateinherited

Definition at line 252 of file Object.h.

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

modified

bool Object::modified

protectedinherited

Dirty flag.

Definition at line 238 of file Object.h.

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

occurrence

int Object::occurrence

privateinherited

Definition at line 261 of file Object.h.

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

refCount

int RCObject::refCount

mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

references

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

privateinherited

Definition at line 268 of file Object.h.

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

sharedFlag

bool Object::sharedFlag

privateinherited

Definition at line 271 of file Object.h.

Referenced by isShared(), Object(), Object(), and 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:

• DumpEMFields.h
• DumpEMFields.cpp