|
OPALX (Object Oriented Parallel Accelerator Library for Exascal) MINIorX
OPALX
|
#include <FieldSolverCmd.h>
Public Member Functions | |
| FieldSolverCmd () | |
| Exemplar constructor. | |
| virtual | ~FieldSolverCmd () |
| virtual FieldSolverCmd * | clone (const std::string &name) |
| Make clone. | |
| std::string | getType () |
| double | getNX () const |
| Return meshsize. | |
| double | getNY () const |
| Return meshsize. | |
| double | getNZ () const |
| Return meshsize. | |
| void | setNX (double) |
| void | setNY (double) |
| void | setNZ (double) |
| double | getBoxIncr () const |
| virtual void | update () |
| Update the field solver data. | |
| virtual void | execute () |
| Execute (init) the field solver data. | |
| bool | hasValidSolver () |
| void | setFieldSolverCmdType () |
| FieldSolverCmdType | getFieldSolverCmdType () const |
| ippl::Vector< bool, 3 > | getDomDec () const |
| Inform & | printInfo (Inform &os) const |
| 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. | |
| virtual bool | canReplaceBy (Object *object) |
| Test if replacement is allowed. | |
| 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 | print (std::ostream &) const |
| Print the object. | |
| virtual void | printValue (std::ostream &) const |
| virtual void | printHelp (std::ostream &) const |
| Print help. | |
| virtual void | replace (Object *oldObject, Object *newObject) |
| Replace references. | |
| bool | isBuiltin () const |
| True, if [b]this[/b] is a built-in object. | |
| virtual bool | isShared () const |
| Shared flag. | |
| virtual void | setShared (bool) |
| Set/reset shared flag. | |
| void | setDirty (bool) |
| Set/reset the [b]modified[/b] flag. | |
| bool | isDirty () const |
| True, if the [b]modified[/b] flag is set. | |
| void | setFlag (bool) |
| Flag/unflag this object, e. g. to control output of objects for. | |
| bool | isFlagged () const |
| True, if [b]this[/b] is flagged by setFlag(true). | |
| const Object * | getBaseObject () const |
| Return the object's base type object. | |
| const std::string & | getOpalName () const |
| Return object name. | |
| Object * | getParent () const |
| Return parent pointer. | |
| bool | isTreeMember (const Object *subTree) const |
| Test for tree membership. | |
| void | setOpalName (const std::string &name) |
| Set object name. | |
| void | setParent (Object *) |
| Set parent object. | |
| void | clear () |
| Clear the occurrence counter. | |
| int | increment () |
| Increment and return the occurrence counter. | |
| int | occurrenceCount () |
| Return the occurrence counter. | |
| void | registerReference (Invalidator *a) |
| Register a reference to this object. | |
| void | unregisterReference (Invalidator *a) |
| Unegister a reference to this object. | |
| void | registerOwnership (const AttributeHandler::OwnerType &itsClass) const |
| int | addReference () const |
| Increment reference count. | |
| int | removeReference () const |
| Decrement the reference count. | |
Static Public Member Functions | |
| static FieldSolverCmd * | find (const std::string &name) |
| Find named FieldSolverCmd. | |
Public Attributes | |
| std::vector< Attribute > | itsAttr |
| The object attributes. | |
Protected Attributes | |
| bool | builtin |
| Built-in flag. | |
| bool | modified |
| Dirty flag. | |
| bool | flagged |
| Object flag. | |
Private Member Functions | |
| FieldSolverCmd (const FieldSolverCmd &) | |
| void | operator= (const FieldSolverCmd &) |
| FieldSolverCmd (const std::string &name, FieldSolverCmd *parent) | |
Private Attributes | |
| std::string | fsName_m |
| FieldSolverCmdType | fsType_m |
| Object * | itsParent |
| std::string | itsName |
| std::string | itsHelp |
| int | occurrence |
| double | timeStamp |
| std::set< Invalidator * > | references |
| bool | sharedFlag |
| int | refCount |
Definition at line 51 of file FieldSolverCmd.h.
| FieldSolverCmd::FieldSolverCmd | ( | ) |
Exemplar constructor.
Definition at line 37 of file FieldSolverCmd.cpp.
References FIELDSOLVER::BBOXINCR, FIELDSOLVER::BCFFTX, FIELDSOLVER::BCFFTY, FIELDSOLVER::BCFFTZ, Definition::Definition(), FIELDSOLVER::GREENSF, Object::itsAttr, Attributes::makeBool(), Attributes::makePredefinedString(), Attributes::makeReal(), FIELDSOLVER::NX, FIELDSOLVER::NY, FIELDSOLVER::NZ, FIELDSOLVER::PARFFTX, FIELDSOLVER::PARFFTY, FIELDSOLVER::PARFFTZ, SIZE, and FIELDSOLVER::TYPE.
Referenced by clone(), FieldSolverCmd(), FieldSolverCmd(), find(), and operator=().
|
virtual |
Definition at line 79 of file FieldSolverCmd.cpp.
|
private |
|
private |
Definition at line 75 of file FieldSolverCmd.cpp.
References Definition::Definition(), and FieldSolverCmd().
|
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().
|
virtualinherited |
Test if replacement is allowed.
Reimplemented in Action, Beam, BoolConstant, BoundaryGeometry, Distribution, Element, OpalFilter, RealConstant, RealVariable, RealVector, StringConstant, and Table.
Definition at line 48 of file Object.cpp.
References Object().
Referenced by OpalData::define().
|
inherited |
|
virtual |
Make clone.
Implements Object.
Definition at line 82 of file FieldSolverCmd.cpp.
References FieldSolverCmd().
|
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().
|
virtual |
Execute (init) the field solver data.
Reimplemented from Object.
Definition at line 86 of file FieldSolverCmd.cpp.
References setFieldSolverCmdType(), and update().
|
static |
Find named FieldSolverCmd.
Definition at line 91 of file FieldSolverCmd.cpp.
References FieldSolverCmd(), OpalData::find(), and OpalData::getInstance().
Referenced by TrackRun::execute().
|
virtualinherited |
Find an attribute by name.
Definition at line 64 of file Object.cpp.
References itsAttr.
Referenced by OpalElement::getParticleMatterInteraction(), OpalElement::getTypeName(), OpalElement::getWakeF(), Line::parse(), parse(), OpalElement::parse(), OpalParser::parseAssign(), SequenceParser::parsePosition(), and parseShortcut().
|
virtualinherited |
|
inherited |
Return the object's base type object.
Definition at line 301 of file Object.cpp.
References itsParent, and Object().
| double FieldSolverCmd::getBoxIncr | ( | ) | const |
Definition at line 128 of file FieldSolverCmd.cpp.
References FIELDSOLVER::BBOXINCR, Attributes::getReal(), and Object::itsAttr.
|
virtualinherited |
Return the object category as a string.
Implements Object.
Definition at line 29 of file Definition.cpp.
|
inline |
Definition at line 113 of file FieldSolverCmd.h.
References Attributes::getBool(), Object::itsAttr, FIELDSOLVER::PARFFTX, FIELDSOLVER::PARFFTY, and FIELDSOLVER::PARFFTZ.
|
inline |
Definition at line 110 of file FieldSolverCmd.h.
References fsType_m.
| double FieldSolverCmd::getNX | ( | ) | const |
Return meshsize.
Definition at line 104 of file FieldSolverCmd.cpp.
References Attributes::getReal(), Object::itsAttr, and FIELDSOLVER::NX.
| double FieldSolverCmd::getNY | ( | ) | const |
Return meshsize.
Definition at line 108 of file FieldSolverCmd.cpp.
References Attributes::getReal(), Object::itsAttr, and FIELDSOLVER::NY.
| double FieldSolverCmd::getNZ | ( | ) | const |
Return meshsize.
Definition at line 112 of file FieldSolverCmd.cpp.
References Attributes::getReal(), Object::itsAttr, and FIELDSOLVER::NZ.
|
inherited |
Return object name.
Definition at line 308 of file Object.cpp.
References itsName.
Referenced by Macro::clone(), OpalOffset::OpalLocalCartesianOffset::clone(), OpalData::create(), OpalData::define(), Sequence::findDriftLength(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), LineTemplate::makeInstance(), makeInstance(), SequenceTemplate::makeInstance(), parse(), SequenceParser::parsePosition(), parseShortcut(), Beam::print(), BoolConstant::print(), Line::print(), print(), OpalElement::print(), OpalFilter::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), registerOwnership(), OpalElement::registerOwnership(), Line::replace(), Sequence::replace(), Beam::update(), BoundaryGeometry::update(), OpalFilter::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), and OpalOffset::OpalLocalCylindricalOffset::update().
|
inherited |
Return parent pointer.
Definition at line 313 of file Object.cpp.
References itsParent, and Object().
Referenced by OpalData::erase(), print(), OpalElement::print(), registerOwnership(), and OpalElement::registerOwnership().
| std::string FieldSolverCmd::getType | ( | ) |
Definition at line 100 of file FieldSolverCmd.cpp.
References Attributes::getString(), Object::itsAttr, and FIELDSOLVER::TYPE.
Referenced by setFieldSolverCmdType(), and update().
| bool FieldSolverCmd::hasValidSolver | ( | ) |
Definition at line 156 of file FieldSolverCmd.cpp.
|
inherited |
Increment and return the occurrence counter.
Definition at line 344 of file Object.cpp.
References occurrence.
Referenced by Line::parse(), and Sequence::storeLine().
|
inherited |
True, if [b]this[/b] is a built-in object.
Definition at line 266 of file Object.cpp.
References builtin.
Referenced by OpalData::define(), and OpalData::getVariableNames().
|
inherited |
True, if the [b]modified[/b] flag is set.
Definition at line 287 of file Object.cpp.
References modified.
|
inherited |
True, if [b]this[/b] is flagged by setFlag(true).
Definition at line 297 of file Object.cpp.
References flagged.
|
virtualinherited |
Shared flag.
Definition at line 271 of file Object.cpp.
References sharedFlag.
Referenced by Sequence::print().
|
inherited |
Test for tree membership.
Definition at line 318 of file Object.cpp.
References Object().
Referenced by Selector::handleElement(), and OpalParser::parseAssign().
|
virtualinherited |
Macro handler function.
Reimplemented in LineTemplate, MacroCmd, and SequenceTemplate.
Definition at line 89 of file Object.cpp.
References getOpalName(), and Object().
Referenced by OpalParser::parseDefine(), and OpalParser::parseMacro().
|
virtualinherited |
Macro handler function.
Reimplemented in Line, LineTemplate, MacroCmd, Sequence, and SequenceTemplate.
Definition at line 82 of file Object.cpp.
References Object().
Referenced by OpalParser::parseMacro().
|
inherited |
|
private |
|
virtualinherited |
Parse the object.
Reimplemented in Call, Echo, Help, Line, OpalElement, PSystem, Sequence, System, Title, and Value.
Definition at line 95 of file Object.cpp.
References Statement::delimiter(), findAttribute(), getOpalName(), Expressions::parseDelimiter(), Expressions::parseRealConst(), and Expressions::parseString().
Referenced by Sequence::parse(), OpalParser::parseAction(), OpalParser::parseDefine(), and SequenceTemplate::parseTemplate().
|
virtualinherited |
Parser for single-attribute commands.
Definition at line 127 of file Object.cpp.
References Statement::delimiter(), findAttribute(), getOpalName(), Statement::mark(), and Statement::word().
Referenced by Call::parse(), Echo::parse(), Help::parse(), PSystem::parse(), System::parse(), Title::parse(), and Value::parse().
|
virtualinherited |
Print the object.
Reimplemented in Beam, BoolConstant, DumpEMFields, DumpFields, Line, OpalElement, OpalFilter, OpalMarker, OpalMultipole, OpalMultipoleT, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalRingDefinition, RealConstant, RealVariable, RealVector, Sequence, and StringConstant.
Definition at line 159 of file Object.cpp.
References getOpalName(), getParent(), itsAttr, and Object().
Referenced by printValue().
|
virtualinherited |
Print help.
Definition at line 199 of file Object.cpp.
References gmsg, itsAttr, and itsHelp.
Referenced by Help::execute(), and main().
| Inform & FieldSolverCmd::printInfo | ( | Inform & | os | ) | const |
Definition at line 160 of file FieldSolverCmd.cpp.
References FIELDSOLVER::BBOXINCR, fsName_m, Attributes::getBool(), Object::getOpalName(), Attributes::getReal(), Attributes::getString(), FIELDSOLVER::GREENSF, Object::itsAttr, FIELDSOLVER::NX, FIELDSOLVER::NY, FIELDSOLVER::NZ, FIELDSOLVER::PARFFTX, FIELDSOLVER::PARFFTY, and FIELDSOLVER::PARFFTZ.
Referenced by operator<<().
|
inlinevirtualinherited |
Reimplemented in BoolConstant, RealConstant, RealVariable, RealVector, and StringConstant.
Definition at line 280 of file Object.h.
References print().
|
inherited |
Definition at line 189 of file Object.cpp.
References AttributeHandler::addAttributeOwner(), end(), getOpalName(), getParent(), and itsAttr.
Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Distribution::Distribution(), DumpEMFields::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().
|
inherited |
Register a reference to this object.
Definition at line 180 of file Object.cpp.
References references.
|
inlineinherited |
Replace references.
Reimplemented in Line, and Sequence.
Definition at line 256 of file Object.cpp.
References Object().
|
inherited |
Set/reset the [b]modified[/b] flag.
Definition at line 281 of file Object.cpp.
References modified.
Referenced by OpalData::define(), OpalData::makeDirty(), and RealVariable::RealVariable().
| void FieldSolverCmd::setFieldSolverCmdType | ( | ) |
|
inherited |
Flag/unflag this object, e. g. to control output of objects for.
Definition at line 292 of file Object.cpp.
References flagged.
| void FieldSolverCmd::setNX | ( | double | value | ) |
Definition at line 116 of file FieldSolverCmd.cpp.
References Object::itsAttr, FIELDSOLVER::NX, and Attributes::setReal().
| void FieldSolverCmd::setNY | ( | double | value | ) |
Definition at line 120 of file FieldSolverCmd.cpp.
References Object::itsAttr, FIELDSOLVER::NY, and Attributes::setReal().
| void FieldSolverCmd::setNZ | ( | double | value | ) |
Definition at line 124 of file FieldSolverCmd.cpp.
References Object::itsAttr, FIELDSOLVER::NZ, and Attributes::setReal().
|
inherited |
Set object name.
Definition at line 329 of file Object.cpp.
References itsName.
Referenced by Beam::update(), BoundaryGeometry::update(), and OpalFilter::update().
|
inherited |
Set parent object.
Definition at line 334 of file Object.cpp.
References itsParent, and Object().
Referenced by OpalData::erase().
|
virtualinherited |
Set/reset shared flag.
Reimplemented in Element.
Definition at line 276 of file Object.cpp.
References sharedFlag.
Referenced by OpalParser::parseDefine(), and Element::setShared().
|
virtualinherited |
|
virtualinherited |
|
inherited |
Unegister a reference to this object.
Definition at line 185 of file Object.cpp.
References references.
|
virtual |
Update the field solver data.
Reimplemented from Object.
Definition at line 133 of file FieldSolverCmd.cpp.
References fsName_m, getType(), Object::itsAttr, and FIELDSOLVER::TYPE.
Referenced by execute().
|
protectedinherited |
Built-in flag.
Definition at line 233 of file Object.h.
Referenced by Beam::Beam(), BoundaryGeometry::BoundaryGeometry(), isBuiltin(), Object(), Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().
|
protectedinherited |
|
private |
Definition at line 106 of file FieldSolverCmd.h.
Referenced by printInfo(), setFieldSolverCmdType(), and update().
|
private |
Definition at line 107 of file FieldSolverCmd.h.
Referenced by getFieldSolverCmdType(), and setFieldSolverCmdType().
|
inherited |
The object attributes.
Definition at line 216 of file Object.h.
Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), DumpFields::buildGrid(), Call::Call(), copyAttributes(), Distribution::Distribution(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), Echo::Echo(), Beam::execute(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), TrackCmd::execute(), TrackRun::execute(), Value::execute(), FieldSolverCmd::FieldSolverCmd(), findAttribute(), 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(), Line::getLength(), OpalElement::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(), Object(), Object(), 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(), Option::Option(), Line::parse(), Sequence::parse(), DumpEMFields::parseCoordinateSystem(), Beam::print(), BoolConstant::print(), DumpEMFields::print(), DumpFields::print(), print(), OpalFilter::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), TrackRun::print(), printHelp(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), BoolConstant::printValue(), RealConstant::printValue(), RealVariable::printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVariable::RealVariable(), RealVector::RealVector(), registerOwnership(), OpalElement::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(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), Beam::update(), FieldSolverCmd::update(), 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(), Option::update(), OpalElement::updateUnknown(), Value::Value(), ValueDefinition::value(), and ValueDefinition::value().
|
privateinherited |
Definition at line 258 of file Object.h.
Referenced by Object(), Object(), and printHelp().
|
privateinherited |
Definition at line 255 of file Object.h.
Referenced by getOpalName(), Object(), Object(), and setOpalName().
|
privateinherited |
Definition at line 252 of file Object.h.
Referenced by getBaseObject(), getParent(), Object(), Object(), and setParent().
|
protectedinherited |
|
privateinherited |
Definition at line 261 of file Object.h.
Referenced by clear(), increment(), Object(), Object(), and occurrenceCount().
|
mutableprivateinherited |
Definition at line 76 of file RCObject.h.
Referenced by addReference(), isShared(), RCObject(), RCObject(), and removeReference().
|
privateinherited |
Definition at line 268 of file Object.h.
Referenced by registerReference(), unregisterReference(), and ~Object().
|
privateinherited |
Definition at line 271 of file Object.h.
Referenced by isShared(), Object(), Object(), and setShared().