OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | List of all members
FieldSolver Class Reference

#include <FieldSolver.h>

Inheritance diagram for FieldSolver:
Inheritance graph
Collaboration diagram for FieldSolver:
Collaboration graph

Public Member Functions

 FieldSolver ()
 Exemplar constructor. More...
 
virtual ~FieldSolver ()
 
virtual FieldSolver * clone (const std::string &name)
 Make clone. More...
 
std::string getType ()
 
double getMX () const
 Return meshsize. More...
 
double getMY () const
 Return meshsize. More...
 
double getMT () const
 Return meshsize. More...
 
void setMX (double)
 Store emittance for mode 1. More...
 
void setMY (double)
 Store emittance for mode 2. More...
 
void setMT (double)
 Store emittance for mode 3. More...
 
virtual void update ()
 Update the field solver data. More...
 
virtual void execute ()
 Execute (init) the field solver data. More...
 
void initCartesianFields ()
 
void initSolver (PartBunchBase< double, 3 > *b)
 
bool hasValidSolver ()
 
void setFieldSolverType ()
 
FieldSolverType getFieldSolverType () const
 
Layout_t & getParticleLayout ()
 
FieldLayout_t * getFieldLayout ()
 
Inform & printInfo (Inform &os) const
 
unsigned int getInteractionRadius ()
 
bool hasPeriodicZ ()
 
bool isAmrSolverType () const
 
AmrObject * getAmrObject ()
 
const AmrObject * getAmrObject () const
 
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...
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed. 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 print (std::ostream &) const
 Print the object. More...
 
virtual void printValue (std::ostream &) const
 
virtual void printHelp (std::ostream &) const
 Print help. More...
 
virtual void replace (Object *oldObject, Object *newObject)
 Replace references. More...
 
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 FieldSolver * find (const std::string &name)
 Find named FieldSolver. More...
 

Public Attributes

PoissonSolver * solver_m
 the actual solver, should be a base object More...
 
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 Member Functions

std::string getTagging_m () const
 
void initAmrObject_m ()
 
void initAmrSolver_m ()
 
 FieldSolver (const FieldSolver &)
 
void operator= (const FieldSolver &)
 
 FieldSolver (const std::string &name, FieldSolver *parent)
 

Private Attributes

std::unique_ptr< AmrObject > itsAmrObject_mp
 
Mesh_t * mesh_m
 The cartesian mesh. More...
 
FieldLayout_t * FL_m
 The field layout f. More...
 
std::unique_ptr< Layout_t > PL_m
 The particle layout. More...
 
PartBunchBase< double, 3 > * itsBunch_m
 all the particles are here ... More...
 
std::string fsName_m
 
FieldSolverType fsType_m
 
double rpp_m
 
Object * itsParent
 
std::string itsName
 
std::string itsHelp
 
int occurrence
 
double timeStamp
 
std::set< Invalidator * > references
 
bool sharedFlag
 
int refCount
 

Detailed Description

Definition at line 52 of file FieldSolver.h.

Constructor & Destructor Documentation

◆ FieldSolver() [1/3]

FieldSolver::FieldSolver ( )

Exemplar constructor.

Definition at line 126 of file FieldSolver.cpp.

References ALPHA, Physics::e, FL_m, Object::itsAttr, Attributes::makeBool(), Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeRealArray(), Attributes::makeUpperCaseString(), mesh_m, Attrib::Distribution::MT, Attrib::Distribution::MX, Attrib::Distribution::MY, PL_m, Object::registerOwnership(), Attributes::setRealArray(), solver_m, and AttributeHandler::STATEMENT.

Referenced by clone().

Here is the call graph for this function:

◆ ~FieldSolver()

FieldSolver::~FieldSolver ( )
virtual

Definition at line 362 of file FieldSolver.cpp.

References FL_m, mesh_m, and solver_m.

◆ FieldSolver() [2/3]

FieldSolver::FieldSolver ( const FieldSolver &  )
private

◆ FieldSolver() [3/3]

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

Definition at line 352 of file FieldSolver.cpp.

References FL_m, mesh_m, PL_m, and solver_m.

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

◆ canReplaceBy()

bool Object::canReplaceBy ( Object *  object)
virtualinherited

Test if replacement is allowed.

Reimplemented in Table, Action, Element, OpalTrimCoil, Distribution, Beam, BoundaryGeometry, OpalWake, ParticleMatterInteraction, OpalFilter, BoolConstant, RealConstant, StringConstant, RealVariable, and RealVector.

Definition at line 48 of file Object.cpp.

Referenced by OpalData::define().

◆ clear()

void Object::clear ( )
inherited

Clear the occurrence counter.

Definition at line 341 of file Object.cpp.

References Object::occurrence.

Referenced by initSolver().

◆ clone()

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

Make clone.

Implements Object.

Definition at line 377 of file FieldSolver.cpp.

References FieldSolver(), and name.

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

Execute (init) the field solver data.

Reimplemented from Object.

Definition at line 381 of file FieldSolver.cpp.

References setFieldSolverType(), and update().

Here is the call graph for this function:

◆ find()

FieldSolver * FieldSolver::find ( const std::string &  name)
static

Find named FieldSolver.

Definition at line 386 of file FieldSolver.cpp.

References OpalData::find(), Hypervolume::fs, OpalData::getInstance(), and name.

Referenced by TrackRun::setupFieldsolver().

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

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

References Object::itsAttr, and name.

◆ getAmrObject() [1/2]

AmrObject * FieldSolver::getAmrObject ( )
inline

Definition at line 114 of file FieldSolver.h.

References itsAmrObject_mp.

Referenced by AmrPartBunch::setSolver().

◆ getAmrObject() [2/2]

const AmrObject * FieldSolver::getAmrObject ( ) const
inline

Definition at line 118 of file FieldSolver.h.

References itsAmrObject_mp.

◆ getBaseObject()

const Object * Object::getBaseObject ( ) const
inherited

Return the object's base type object.

Definition at line 303 of file Object.cpp.

References Object::itsParent.

◆ getCategory()

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

Return the object category as a string.

Implements Object.

Definition at line 29 of file Definition.cpp.

◆ getFieldLayout()

FieldLayout_t * FieldSolver::getFieldLayout ( )
inline

Definition at line 103 of file FieldSolver.h.

References FL_m.

◆ getFieldSolverType()

FieldSolverType FieldSolver::getFieldSolverType ( ) const
inline

Definition at line 164 of file FieldSolver.h.

References fsType_m.

Referenced by PartBunch::computeSelfFields(), PartBunch::computeSelfFields_cycl(), PartBunch::resizeMesh(), and TrackRun::setupFieldsolver().

◆ getInteractionRadius()

unsigned int FieldSolver::getInteractionRadius ( )
inline

Definition at line 107 of file FieldSolver.h.

References rpp_m.

◆ getMT()

double FieldSolver::getMT ( ) const

Return meshsize.

Definition at line 407 of file FieldSolver.cpp.

References Attributes::getReal(), Object::itsAttr, and Attrib::Distribution::MT.

Referenced by initAmrObject_m(), initCartesianFields(), and TrackRun::setupFieldsolver().

Here is the call graph for this function:

◆ getMX()

double FieldSolver::getMX ( ) const

Return meshsize.

Definition at line 399 of file FieldSolver.cpp.

References Attributes::getReal(), Object::itsAttr, and Attrib::Distribution::MX.

Referenced by initAmrObject_m(), initCartesianFields(), and TrackRun::setupFieldsolver().

Here is the call graph for this function:

◆ getMY()

double FieldSolver::getMY ( ) const

Return meshsize.

Definition at line 403 of file FieldSolver.cpp.

References Attributes::getReal(), Object::itsAttr, and Attrib::Distribution::MY.

Referenced by initAmrObject_m(), initCartesianFields(), and TrackRun::setupFieldsolver().

Here is the call graph for this function:

◆ getOpalName()

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

Return object name.

Definition at line 310 of file Object.cpp.

References Object::itsName.

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

◆ getParent()

Object * Object::getParent ( ) const
inherited

Return parent pointer.

Definition at line 315 of file Object.cpp.

References Object::itsParent.

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

◆ getParticleLayout()

Layout_t & FieldSolver::getParticleLayout ( )
inline

Definition at line 101 of file FieldSolver.h.

References PL_m.

◆ getTagging_m()

std::string FieldSolver::getTagging_m ( ) const
private

Definition at line 709 of file FieldSolver.cpp.

References Attributes::getString(), AmrObject::getTaggingString(), Util::isAllDigits(), and Object::itsAttr.

Referenced by initAmrObject_m(), and printInfo().

Here is the call graph for this function:

◆ getType()

std::string FieldSolver::getType ( )

Definition at line 395 of file FieldSolver.cpp.

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

Referenced by initAmrSolver_m(), and setFieldSolverType().

Here is the call graph for this function:

◆ hasPeriodicZ()

bool FieldSolver::hasPeriodicZ ( )

Definition at line 459 of file FieldSolver.cpp.

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

Referenced by TrackRun::setupFieldsolver().

Here is the call graph for this function:

◆ hasValidSolver()

bool FieldSolver::hasValidSolver ( )

Definition at line 590 of file FieldSolver.cpp.

References solver_m.

Referenced by AmrPartBunch::computeSelfFields(), PartBunch::computeSelfFields(), and PartBunch::computeSelfFields_cycl().

◆ increment()

int Object::increment ( )
inherited

Increment and return the occurrence counter.

Definition at line 346 of file Object.cpp.

References Object::occurrence.

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

◆ initAmrObject_m()

void FieldSolver::initAmrObject_m ( )
private

Definition at line 720 of file FieldSolver.cpp.

References AmrBoxLib::create(), getMT(), getMX(), getMY(), Attributes::getReal(), Attributes::getRealArray(), getTagging_m(), AmrObject::AmrInfo::grid, Options::info, itsAmrObject_mp, Object::itsAttr, itsBunch_m, AmrObject::AmrInfo::maxgrid, and PartBunchBase< T, Dim >::set_meshEnlargement().

Referenced by initSolver().

Here is the call graph for this function:

◆ initAmrSolver_m()

void FieldSolver::initAmrSolver_m ( )
private

Definition at line 762 of file FieldSolver.cpp.

References AMRMG, FMG, fsType_m, Attributes::getBool(), Attributes::getReal(), Attributes::getString(), getType(), HPGMG, HYPRE, itsAmrObject_mp, Object::itsAttr, ML, and solver_m.

Referenced by initSolver().

Here is the call graph for this function:

◆ initCartesianFields()

void FieldSolver::initCartesianFields ( )

Definition at line 427 of file FieldSolver.cpp.

References FL_m, Attributes::getBool(), getMT(), getMX(), getMY(), Attributes::getString(), isAmrSolverType(), Object::itsAttr, mesh_m, PARALLEL, PL_m, and SERIAL.

Referenced by TrackRun::setupFieldsolver().

Here is the call graph for this function:

◆ initSolver()

void FieldSolver::initSolver ( PartBunchBase< double, 3 > *  b)

Definition at line 499 of file FieldSolver.cpp.

References ALPHA, Object::clear(), endl(), FFT, FFTBOX, BoundaryGeometry::find(), FL_m, fsName_m, fsType_m, BoundaryGeometry::getA(), OpalData::getGlobalGeometry(), OpalData::getInstance(), Attributes::getReal(), Attributes::getString(), INFOMSG, initAmrObject_m(), initAmrSolver_m(), isAmrSolverType(), Object::itsAttr, itsBunch_m, mesh_m, P3M, SAAMG, PartBunchBase< T, Dim >::set_meshEnlargement(), and solver_m.

Here is the call graph for this function:

◆ isAmrSolverType()

bool FieldSolver::isAmrSolverType ( ) const

Definition at line 466 of file FieldSolver.cpp.

References Options::amr, AMRMG, FMG, fsType_m, and ML.

Referenced by initCartesianFields(), initSolver(), and printInfo().

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

References Object::flagged.

◆ isShared()

bool Object::isShared ( ) const
virtualinherited

Shared flag.

Definition at line 273 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 320 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 91 of file Object.cpp.

References Object::getOpalName().

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 LineTemplate, Sequence, MacroCmd, SequenceTemplate, and Line.

Definition at line 84 of file Object.cpp.

References name.

Referenced by OpalParser::parseMacro().

◆ occurrenceCount()

int Object::occurrenceCount ( )
inherited

Return the occurrence counter.

Definition at line 351 of file Object.cpp.

References Object::occurrence.

◆ operator=()

void FieldSolver::operator= ( const FieldSolver &  )
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 97 of file Object.cpp.

References Statement::delimiter(), Object::findAttribute(), Object::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:

◆ 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(), Object::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 Object::print ( std::ostream &  msg) const
virtualinherited

Print the object.

Reimplemented in OpalBend, OpalElement, OpalMarker, OpalMultipole, OpalOctupole, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalPolynomialTimeDependence, OpalQuadrupole, OpalRBend3D, OpalRingDefinition, OpalSextupole, Sequence, BoolConstant, RealConstant, RealVariable, RealVector, StringConstant, OpalSinusoidalTimeDependence, OpalSplineTimeDependence, DumpEMFields, DumpFields, Beam, OpalWake, ParticleMatterInteraction, OpalFilter, OpalMultipoleT, and Line.

Definition at line 161 of file Object.cpp.

References endl(), Object::getOpalName(), Object::getParent(), and Object::itsAttr.

Referenced by Object::printValue().

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, Object::itsAttr, Object::itsHelp, max(), and name.

Referenced by Help::execute().

Here is the call graph for this function:

◆ printInfo()

Inform & FieldSolver::printInfo ( Inform &  os) const

Definition at line 594 of file FieldSolver.cpp.

References ALPHA, Options::amr, AMRMG, endl(), FFT, fsName_m, fsType_m, Attributes::getBool(), IpplInfo::getNodes(), Object::getOpalName(), Attributes::getReal(), Attributes::getRealArray(), Attributes::getString(), getTagging_m(), INFOMSG, isAmrSolverType(), Object::itsAttr, level3(), mesh_m, Attrib::Distribution::MT, Attrib::Distribution::MX, Attrib::Distribution::MY, P3M, PL_m, SAAMG, and solver_m.

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

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

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Constraint::Constraint(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), DVar::DVar(), Echo::Echo(), 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 Hypervolume::ref, and 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 258 of file Object.cpp.

◆ setDirty()

void Object::setDirty ( bool  dirty)
inherited

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

Definition at line 283 of file Object.cpp.

References Object::modified.

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

◆ setFieldSolverType()

void FieldSolver::setFieldSolverType ( )

Definition at line 477 of file FieldSolver.cpp.

References AMRMG, FFT, FFTBOX, FMG, fsName_m, fsType_m, getType(), HPGMG, HYPRE, ML, NONE, P3M, and SAAMG.

Referenced by execute().

Here is the call graph for this function:

◆ 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 Object::flagged.

◆ setMT()

void FieldSolver::setMT ( double  value)

Store emittance for mode 3.

Definition at line 419 of file FieldSolver.cpp.

References Object::itsAttr, Attrib::Distribution::MT, and Attributes::setReal().

Here is the call graph for this function:

◆ setMX()

void FieldSolver::setMX ( double  value)

Store emittance for mode 1.

Definition at line 411 of file FieldSolver.cpp.

References Object::itsAttr, Attrib::Distribution::MX, and Attributes::setReal().

Here is the call graph for this function:

◆ setMY()

void FieldSolver::setMY ( double  value)

Store emittance for mode 2.

Definition at line 415 of file FieldSolver.cpp.

References Object::itsAttr, Attrib::Distribution::MY, and Attributes::setReal().

Here is the call graph for this function:

◆ setOpalName()

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

Set object name.

Definition at line 331 of file Object.cpp.

References Object::itsName, and name.

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

◆ setParent()

void Object::setParent ( Object *  parent)
inherited

Set parent object.

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

References Object::sharedFlag.

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

◆ shouldTrace()

bool Definition::shouldTrace ( ) const
virtualinherited

Trace flag.

Implements Object.

Definition at line 34 of file Definition.cpp.

◆ shouldUpdate()

bool Definition::shouldUpdate ( ) const
virtualinherited

Update flag.

Implements Object.

Definition at line 39 of file Definition.cpp.

◆ unregisterReference()

void Object::unregisterReference ( Invalidator *  a)
inherited

Unegister a reference to this object.

Definition at line 187 of file Object.cpp.

References Hypervolume::ref, and Object::references.

◆ update()

void FieldSolver::update ( )
virtual

Update the field solver data.

Reimplemented from Object.

Definition at line 423 of file FieldSolver.cpp.

Referenced by execute().

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

◆ FL_m

FieldLayout_t* FieldSolver::FL_m
private

The field layout f.

Definition at line 149 of file FieldSolver.h.

Referenced by FieldSolver(), getFieldLayout(), initCartesianFields(), initSolver(), and ~FieldSolver().

◆ flagged

bool Object::flagged
protectedinherited

Object flag.

Definition at line 242 of file Object.h.

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

◆ fsName_m

std::string FieldSolver::fsName_m
private

Definition at line 157 of file FieldSolver.h.

Referenced by initSolver(), printInfo(), and setFieldSolverType().

◆ fsType_m

FieldSolverType FieldSolver::fsType_m
private

Definition at line 158 of file FieldSolver.h.

Referenced by getFieldSolverType(), initAmrSolver_m(), initSolver(), isAmrSolverType(), printInfo(), and setFieldSolverType().

◆ itsAmrObject_mp

std::unique_ptr<AmrObject> FieldSolver::itsAmrObject_mp
private

Definition at line 135 of file FieldSolver.h.

Referenced by getAmrObject(), initAmrObject_m(), and initAmrSolver_m().

◆ 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(), DumpEMFields::buildGrid(), DumpFields::buildGrid(), Distribution::calcPartPerDist(), Call::Call(), Distribution::checkEmissionParameters(), Distribution::checkIfEmitted(), Distribution::chooseInputMomentumUnits(), Constraint::Constraint(), Object::copyAttributes(), Distribution::create(), Distribution::createDistributionFromFile(), Distribution::createDistributionMultiGauss(), Distribution::createMatchedGaussDistribution(), Distribution::createOpalT(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), DVar::DVar(), Echo::Echo(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), Value::execute(), OptimizeCmd::execute(), SampleCmd::execute(), Beam::execute(), List::execute(), TrackCmd::execute(), TrackRun::execute(), FieldSolver(), Object::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(), OpalElement::getLength(), Line::getLength(), Sequence::getLength(), DVar::getLowerBound(), Beam::getMass(), TrackCmd::getMaxSteps(), getMT(), getMX(), 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(), getTagging_m(), Distribution::getTEmission(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), OpalTrimCoil::getTrimCoilType(), getType(), DVar::getUpperBound(), DVar::getVariable(), OpalSample::getVariable(), Distribution::getWeight(), TrackCmd::getZStart(), TrackCmd::getZStop(), hasPeriodicZ(), Help::Help(), initAmrObject_m(), initAmrSolver_m(), initCartesianFields(), BoundaryGeometry::initialize(), OpalSample::initialize(), OpalFilter::initOpalFilter(), OpalTrimCoil::initOpalTrimCoil(), ParticleMatterInteraction::initParticleMatterInteractionHandler(), initSolver(), OpalWake::initWakefunction(), Distribution::injectBeam(), Line::Line(), List::List(), List::list(), 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(), Sequence::parse(), Line::parse(), DumpEMFields::parseCoordinateSystem(), ParticleMatterInteraction::ParticleMatterInteraction(), OpalTrimCoil::print(), TrackRun::print(), Object::print(), Sequence::print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), DumpEMFields::print(), DumpFields::print(), Beam::print(), OpalWake::print(), ParticleMatterInteraction::print(), OpalFilter::print(), Distribution::printDistFlattop(), Distribution::printDistFromFile(), Distribution::printDistGauss(), Distribution::printEmissionModelAstra(), Distribution::printEmissionModelNone(), Object::printHelp(), Distribution::printInfo(), BoundaryGeometry::printInfo(), printInfo(), BoolConstant::printValue(), RealConstant::printValue(), RealVariable::printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), OpalElement::registerOwnership(), Object::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(), setMT(), setMX(), 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(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), 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(), OpalOctupole::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalOutputPlane::update(), OpalPepperPot::update(), OpalPolynomialTimeDependence::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalRingDefinition::update(), OpalSBend::update(), OpalSBend3D::update(), OpalScalingFFAMagnet::update(), OpalSeptum::update(), OpalSextupole::update(), OpalSlit::update(), OpalSolenoid::update(), OpalSource::update(), OpalStripper::update(), OpalTravelingWave::update(), OpalUndulator::update(), OpalVacuum::update(), OpalVariableRFCavity::update(), OpalVariableRFCavityFringeField::update(), OpalVerticalFFAMagnet::update(), OpalVKicker::update(), Beam::update(), OpalMultipoleT::update(), OpalSinusoidalTimeDependence::update(), OpalSplineTimeDependence::update(), Option::update(), OpalElement::updateUnknown(), ValueDefinition::value(), Value::Value(), Distribution::writeOutFileEmission(), Distribution::writeOutFileHeader(), and Distribution::writeOutFileInjection().

◆ itsBunch_m

PartBunchBase<double, 3>* FieldSolver::itsBunch_m
private

all the particles are here ...

Definition at line 155 of file FieldSolver.h.

Referenced by initAmrObject_m(), and initSolver().

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

◆ mesh_m

Mesh_t* FieldSolver::mesh_m
private

The cartesian mesh.

Definition at line 146 of file FieldSolver.h.

Referenced by FieldSolver(), initCartesianFields(), initSolver(), printInfo(), and ~FieldSolver().

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

◆ PL_m

std::unique_ptr<Layout_t> FieldSolver::PL_m
private

The particle layout.

Definition at line 152 of file FieldSolver.h.

Referenced by FieldSolver(), getParticleLayout(), initCartesianFields(), and printInfo().

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

◆ rpp_m

double FieldSolver::rpp_m
private

Definition at line 160 of file FieldSolver.h.

Referenced by getInteractionRadius().

◆ sharedFlag

bool Object::sharedFlag
privateinherited

Definition at line 271 of file Object.h.

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

◆ solver_m

PoissonSolver* FieldSolver::solver_m

the actual solver, should be a base object

Definition at line 124 of file FieldSolver.h.

Referenced by PartBunch::computeSelfFields(), PartBunch::computeSelfFields_cycl(), FieldSolver(), AmrPartBunch::getFieldSolver(), hasValidSolver(), initAmrSolver_m(), initSolver(), printInfo(), PartBunch::resizeMesh(), and ~FieldSolver().

◆ timeStamp

double Object::timeStamp
privateinherited

Definition at line 264 of file Object.h.

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