The global OPAL structure. More...

#include <OpalData.h>

Collaboration diagram for OpalData:

Classes
struct	ClearReference
	Clear Reference. More...

Public Types
enum class	OpenMode : unsigned short { UNDEFINED , WRITE , APPEND }
	Enum for writing to files. More...

Public Member Functions
	~OpalData ()
void	reset ()
	reset object for consecutive runs
void	apply (const ObjectFunction &)
	Apply a function to all objects.
void	create (Object *newObject)
	Create new object.
void	define (Object *newObject)
	Define a new object.
void	erase (const std::string &name)
	Delete existing entry.
Object *	find (const std::string &name)
	Find entry.
double	getP0 () const
	Return value of global reference momentum.
void	makeDirty (Object *object)
	Invalidate expressions.
void	printNames (std::ostream &stream, const std::string &pattern)
	Print all objects.
void	printAllNames (std::ostream &stream)
void	registerTable (Table *t)
	Register table.
void	unregisterTable (Table *t)
	Unregister table.
void	registerExpression (AttributeBase *)
	Register expression.
void	unregisterExpression (AttributeBase *)
	Unregister expression.
void	setP0 (ValueDefinition *p0)
	Set the global momentum.
void	storeTitle (const std::string &)
	Store the page title.
void	printTitle (std::ostream &)
	Print the page title.
std::string	getTitle ()
	Get the title string.
void	update ()
	Update all objects.
std::map< std::string, std::string >	getVariableData ()
std::vector< std::string >	getVariableNames ()
bool	isInOPALCyclMode ()
bool	isInOPALTMode ()
bool	isOptimizerRun ()
void	setInOPALCyclMode ()
void	setInOPALTMode ()
void	setOptimizerFlag ()
bool	isInPrepState ()
void	setInPrepState (bool state)
bool	hasPriorTrack ()
	true if in follow-up track
void	setPriorTrack (const bool &value=true)
	true if in follow-up track
bool	inRestartRun ()
	true if we do a restart run
void	setRestartRun (const bool &value=true)
	set OPAL in restart mode
void	setRestartStep (int s)
	store the location where to restart
int	getRestartStep ()
	get the step where to restart
std::string	getAuxiliaryOutputDirectory () const
	get the name of the the additional data directory
std::string	getInputFn ()
	get opals input filename
std::string	getInputBasename ()
	get input file name without extension
void	storeInputFn (const std::string &fn)
	store opals input filename
void	checkAndAddOutputFileName (const std::string &outfn)
	checks the output file names of all items to avoid duplicates
std::string	getRestartFileName ()
	get opals restart h5 format filename
void	setRestartFileName (std::string s)
	store opals restart h5 format filename
bool	hasRestartFile ()
	true if we do a restart from specified h5 file
void	setRestartDumpFreq (const int &N)
	set the dump frequency as found in restart file
int	getRestartDumpFreq () const
	get the dump frequency as found in restart file
void	setOpenMode (OpenMode openMode)
OpenMode	getOpenMode () const
void	setLastStep (const int &step)
	set the last step in a run for possible follow-up run
int	getLastStep () const
	get the last step from a possible previous run
bool	hasBunchAllocated ()
	true if we already allocated a ParticleBunch object
void	bunchIsAllocated ()
PartBunch_t *	getPartBunch ()
void	setPartBunch (PartBunch_t *p)
bool	hasDataSinkAllocated ()
	true if we already allocated a DataSink object
DataSink *	getDataSink ()
void	setDataSink (DataSink *s)
void	setGlobalPhaseShift (double shift)
	units: (sec)
double	getGlobalPhaseShift ()
	units: (sec)
void	setGlobalGeometry (BoundaryGeometry *bg)
BoundaryGeometry *	getGlobalGeometry ()
bool	hasGlobalGeometry ()
void	setMaxPhase (std::string elName, double phi)
std::vector< MaxPhasesT >::iterator	getFirstMaxPhases ()
std::vector< MaxPhasesT >::iterator	getLastMaxPhases ()
int	getNumberOfMaxPhases ()
void	addEnergyData (double spos, double ekin)
energyEvolution_t::iterator	getFirstEnergyData ()
energyEvolution_t::iterator	getLastEnergyData ()
unsigned long long	getMaxTrackSteps ()
void	setMaxTrackSteps (unsigned long long s)
void	incMaxTrackSteps (unsigned long long s)
void	addProblemCharacteristicValue (const std::string &name, unsigned int value)
const std::map< std::string, unsigned int > &	getProblemCharacteristicValues () const
void	storeArguments (int argc, char *argv[])
std::vector< std::string >	getArguments ()

Static Public Member Functions
static OpalData *	getInstance ()
static void	deleteInstance ()
static void	stashInstance ()
static OpalData *	popInstance ()

Private Member Functions
	OpalData ()
	OpalData (const OpalData &)
void	operator= (const OpalData &)

Private Attributes
struct OpalDataImpl *	p

Static Private Attributes
static bool	isInstantiated = false
static OpalData *	instance = nullptr
static std::stack< OpalData * >	stashedInstances

Detailed Description

The global OPAL structure.

Definition at line 45 of file OpalData.h.

Member Enumeration Documentation

◆ OpenMode

enum class OpalData::OpenMode : unsigned short

strong

Enum for writing to files.

Enumerator
UNDEFINED
WRITE
APPEND

Definition at line 58 of file OpalData.h.

Constructor & Destructor Documentation

◆ ~OpalData()

OpalData::~OpalData ( )

Definition at line 251 of file OpalData.cpp.

References p.

◆ OpalData() [1/2]

OpalData::OpalData ( )

private

Definition at line 247 of file OpalData.cpp.

References p.

Referenced by getInstance(), OpalData(), operator=(), and popInstance().

Here is the caller graph for this function:

◆ OpalData() [2/2]

OpalData::OpalData ( const OpalData & )

private

References OpalData().

Here is the call graph for this function:

Member Function Documentation

◆ addEnergyData()

void OpalData::addEnergyData	(	double	spos,
		double	ekin )

Definition at line 409 of file OpalData.cpp.

References p.

◆ addProblemCharacteristicValue()

void OpalData::addProblemCharacteristicValue	(	const std::string &	name,
		unsigned int	value )

Definition at line 768 of file OpalData.cpp.

References p.

◆ apply()

void OpalData::apply ( const ObjectFunction & fun )

Apply a function to all objects.

Definition at line 467 of file OpalData.cpp.

References p.

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

Here is the caller graph for this function:

◆ bunchIsAllocated()

void OpalData::bunchIsAllocated ( )

Definition at line 368 of file OpalData.cpp.

References p.

◆ checkAndAddOutputFileName()

void OpalData::checkAndAddOutputFileName ( const std::string & outfn )

checks the output file names of all items to avoid duplicates

Definition at line 691 of file OpalData.cpp.

References hasBunchAllocated(), and p.

Referenced by LossDataSink::LossDataSink(), and PeakFinder::save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

void OpalData::create ( Object * newObject )

Create new object.

Definition at line 473 of file OpalData.cpp.

References Object::getOpalName(), and p.

Referenced by OpalMarker::OpalMarker(), RealConstant::RealConstant(), RealVariable::RealVariable(), and StringConstant::StringConstant().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ define()

void OpalData::define ( Object * newObject )

Define a new object.

Definition at line 486 of file OpalData.cpp.

References Object::canReplaceBy(), erase(), Object::getOpalName(), Options::info, Object::isBuiltin(), Table::isDependent(), p, Object::setDirty(), and setP0().

Referenced by Beam::Beam(), BoundaryGeometry::BoundaryGeometry(), OpalFilter::OpalFilter(), OpalParser::parseAssign(), OpalParser::parseDefine(), OpalParser::parseMacro(), and SequenceParser::parseMember().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteInstance()

void OpalData::deleteInstance ( )

static

Definition at line 205 of file OpalData.cpp.

References instance, and isInstantiated.

Referenced by popInstance().

Here is the caller graph for this function:

◆ erase()

void OpalData::erase ( const std::string & name )

Delete existing entry.

Definition at line 547 of file OpalData.cpp.

References Object::getParent(), p, and Object::setParent().

Referenced by define().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ find()

Object * OpalData::find ( const std::string & name )

Find entry.

Definition at line 563 of file OpalData.cpp.

References p.

Referenced by Option::execute(), Expressions::ARefExpr< T >::fill(), Expressions::SRefAttr< T >::fill(), Expressions::SRefExpr< T >::fill(), Beam::find(), BeamSequence::find(), BoundaryGeometry::find(), Distribution::find(), Element::find(), FieldSolverCmd::find(), OpalFilter::find(), OpalParser::find(), Table::find(), getVariableData(), getVariableNames(), main(), LineTemplate::makeInstance(), SequenceTemplate::makeInstance(), OpalParser::parseAssign(), Line::parseList(), Expressions::parseStringValue(), ParallelTracker::setOptionalVariables(), and Sequence::updateList().

Here is the caller graph for this function:

◆ getArguments()

std::vector< std::string > OpalData::getArguments ( )

Definition at line 787 of file OpalData.cpp.

References p.

◆ getAuxiliaryOutputDirectory()

std::string OpalData::getAuxiliaryOutputDirectory ( ) const

get the name of the the additional data directory

Definition at line 677 of file OpalData.cpp.

Referenced by BoundaryGeometry::computeMeshVoxelization(), Fieldmap::lowResolutionWarning(), main(), LaserProfile::sampleDist(), OpalBeamline::save3DInput(), OpalBeamline::save3DLattice(), LaserProfile::saveData(), LaserProfile::saveHistogram(), IndexMap::saveSDDS(), MeshGenerator::write(), Fieldmap::write3DField(), DumpEMFields::writeFieldThis(), and DumpFields::writeFieldThis().

Here is the caller graph for this function:

◆ getDataSink()

DataSink * OpalData::getDataSink ( )

Definition at line 389 of file OpalData.cpp.

References p.

◆ getFirstEnergyData()

energyEvolution_t::iterator OpalData::getFirstEnergyData ( )

Definition at line 413 of file OpalData.cpp.

References p.

◆ getFirstMaxPhases()

std::vector< MaxPhasesT >::iterator OpalData::getFirstMaxPhases ( )

Definition at line 397 of file OpalData.cpp.

References p.

Referenced by ParallelTracker::restoreCavityPhases(), and H5PartWrapper::storeCavityInformation().

Here is the caller graph for this function:

◆ getGlobalGeometry()

BoundaryGeometry * OpalData::getGlobalGeometry ( )

Definition at line 459 of file OpalData.cpp.

References p.

◆ getGlobalPhaseShift()

double OpalData::getGlobalPhaseShift ( )

units: (sec)

Definition at line 450 of file OpalData.cpp.

References p.

Referenced by ParallelTracker::execute(), and H5PartWrapperForPT::writeHeader().

Here is the caller graph for this function:

◆ getInputBasename()

std::string OpalData::getInputBasename ( )

get input file name without extension

Definition at line 685 of file OpalData.cpp.

References p.

Referenced by FieldSolver< T, Dim >::dumpScalField(), FieldSolver< T, Dim >::dumpVectField(), DataSink::init(), main(), OpalBeamline::save3DInput(), OpalBeamline::save3DLattice(), IndexMap::saveSDDS(), and Monitor::writeStatistics().

Here is the caller graph for this function:

◆ getInputFn()

std::string OpalData::getInputFn ( )

get opals input filename

Definition at line 681 of file OpalData.cpp.

References p.

Referenced by LBalWriter::fillHeader(), StatWriter::fillHeader(), and MemoryProfiler::header().

Here is the caller graph for this function:

◆ getInstance()

OpalData * OpalData::getInstance ( )

static

Definition at line 195 of file OpalData.cpp.

References instance, isInstantiated, and OpalData().

Referenced by Expressions::AAutomatic< T >::AAutomatic(), Expressions::AAutomatic< T >::AAutomatic(), SDDSWriter::addDefaultParameters(), Beam::Beam(), BoundaryGeometry::BoundaryGeometry(), Fieldmap::checkMap(), BoundaryGeometry::computeMeshVoxelization(), FieldSolver< T, Dim >::dumpScalField(), FieldSolver< T, Dim >::dumpVectField(), Help::execute(), IfStatement::execute(), OpalParser::execute(), Option::execute(), ParallelTracker::execute(), Select::execute(), Title::execute(), TrackRun::execute(), WhileStatement::execute(), Expressions::ARefExpr< T >::fill(), Expressions::SRefAttr< T >::fill(), Expressions::SRefExpr< T >::fill(), ElementPositionWriter::fillHeader(), LBalWriter::fillHeader(), StatWriter::fillHeader(), Beam::find(), BeamSequence::find(), BoundaryGeometry::find(), Distribution::find(), Element::find(), FieldSolverCmd::find(), OpalFilter::find(), OpalParser::find(), Table::find(), Expressions::getEkin(), FM3DDynamic::getOnaxisEz(), CavityAutophaser::getPhaseAtMaxEnergy(), Attributes::getString(), Attributes::getStringArray(), getVariableData(), getVariableNames(), H5PartWrapperForPT::H5PartWrapperForPT(), MemoryProfiler::header(), DataSink::init(), TrackRun::initDataSink(), OrbitThreader::integrate(), LossDataSink::LossDataSink(), Fieldmap::lowResolutionWarning(), main(), LineTemplate::makeInstance(), SequenceTemplate::makeInstance(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), OrbitThreader::OrbitThreader(), Line::parse(), OpalParser::parse(), SequenceParser::parse(), OpalParser::parseAssign(), OpalParser::parseDefine(), Line::parseList(), OpalParser::parseMacro(), SequenceParser::parseMember(), Expressions::parseRelation(), Expressions::parseStringValue(), Distribution::printInfo(), H5PartWrapperForPT::readHeader(), RealConstant::RealConstant(), RealVariable::RealVariable(), ParallelTracker::restoreCavityPhases(), LaserProfile::sampleDist(), Expressions::SAutomatic< T >::SAutomatic(), Expressions::SAutomatic< T >::SAutomatic(), LossDataSink::save(), PeakFinder::save(), PluginElement::save(), OpalBeamline::save3DInput(), OpalBeamline::save3DLattice(), LaserProfile::saveData(), LaserProfile::saveHistogram(), IndexMap::saveSDDS(), ParallelTracker::setOptionalVariables(), PartBunch< PLayout, T, Dim >::setSolver(), TrackRun::setupBoundaryGeometry(), H5PartWrapper::storeCavityInformation(), Sequence::storeLine(), StringConstant::StringConstant(), Table::Table(), Track::Track(), TrackRun::TrackRun(), TrackRun::TrackRun(), OpalMultipole::update(), OpalSolenoid::update(), Sequence::updateList(), MeshGenerator::write(), StatWriter::write(), Fieldmap::write3DField(), DumpEMFields::writeFieldThis(), DumpFields::writeFieldThis(), H5PartWrapperForPT::writeHeader(), Monitor::writeStatistics(), Expressions::AAutomatic< T >::~AAutomatic(), Expressions::SAutomatic< T >::~SAutomatic(), and Table::~Table().

Here is the call graph for this function:

◆ getLastEnergyData()

energyEvolution_t::iterator OpalData::getLastEnergyData ( )

Definition at line 417 of file OpalData.cpp.

References p.

◆ getLastMaxPhases()

std::vector< MaxPhasesT >::iterator OpalData::getLastMaxPhases ( )

Definition at line 401 of file OpalData.cpp.

References p.

Referenced by ParallelTracker::restoreCavityPhases(), and H5PartWrapper::storeCavityInformation().

Here is the caller graph for this function:

◆ getLastStep()

int OpalData::getLastStep ( ) const

get the last step from a possible previous run

Definition at line 360 of file OpalData.cpp.

References p.

◆ getMaxTrackSteps()

unsigned long long OpalData::getMaxTrackSteps ( )

Definition at line 235 of file OpalData.cpp.

References p.

◆ getNumberOfMaxPhases()

int OpalData::getNumberOfMaxPhases ( )

Definition at line 405 of file OpalData.cpp.

References p.

Referenced by H5PartWrapper::storeCavityInformation().

Here is the caller graph for this function:

◆ getOpenMode()

OpalData::OpenMode OpalData::getOpenMode ( ) const

Definition at line 352 of file OpalData.cpp.

References p.

Referenced by LossDataSink::save(), and PluginElement::save().

Here is the caller graph for this function:

◆ getP0()

double OpalData::getP0 ( ) const

Return value of global reference momentum.

Definition at line 567 of file OpalData.cpp.

References Units::GeV2eV, and p.

Referenced by OpalMultipole::update(), and OpalSolenoid::update().

Here is the caller graph for this function:

◆ getPartBunch()

PartBunch_t * OpalData::getPartBunch ( )

Definition at line 376 of file OpalData.cpp.

References p.

Referenced by Expressions::getEkin().

Here is the caller graph for this function:

◆ getProblemCharacteristicValues()

const std::map< std::string, unsigned int > & OpalData::getProblemCharacteristicValues ( ) const

Definition at line 776 of file OpalData.cpp.

References p.

◆ getRestartDumpFreq()

int OpalData::getRestartDumpFreq ( ) const

get the dump frequency as found in restart file

Definition at line 344 of file OpalData.cpp.

References p.

◆ getRestartFileName()

std::string OpalData::getRestartFileName ( )

get opals restart h5 format filename

Definition at line 327 of file OpalData.cpp.

References p.

◆ getRestartStep()

int OpalData::getRestartStep ( )

get the step where to restart

Definition at line 323 of file OpalData.cpp.

References p.

◆ getTitle()

std::string OpalData::getTitle ( )

Get the title string.

Definition at line 673 of file OpalData.cpp.

References p.

◆ getVariableData()

std::map< std::string, std::string > OpalData::getVariableData ( )

Definition at line 726 of file OpalData.cpp.

References find(), getInstance(), RealVariable::getReal(), StringConstant::getString(), and getVariableNames().

Here is the call graph for this function:

◆ getVariableNames()

std::vector< std::string > OpalData::getVariableNames ( )

Definition at line 748 of file OpalData.cpp.

References find(), Object::getCategory(), getInstance(), Object::isBuiltin(), and p.

Referenced by getVariableData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasBunchAllocated()

bool OpalData::hasBunchAllocated ( )

true if we already allocated a ParticleBunch object

Definition at line 364 of file OpalData.cpp.

References p.

Referenced by checkAndAddOutputFileName().

Here is the caller graph for this function:

◆ hasDataSinkAllocated()

bool OpalData::hasDataSinkAllocated ( )

true if we already allocated a DataSink object

Definition at line 380 of file OpalData.cpp.

References p.

◆ hasGlobalGeometry()

bool OpalData::hasGlobalGeometry ( )

Definition at line 463 of file OpalData.cpp.

References p.

◆ hasPriorTrack()

bool OpalData::hasPriorTrack ( )

true if in follow-up track

Definition at line 303 of file OpalData.cpp.

References p.

◆ hasRestartFile()

bool OpalData::hasRestartFile ( )

true if we do a restart from specified h5 file

Definition at line 336 of file OpalData.cpp.

References p.

◆ incMaxTrackSteps()

void OpalData::incMaxTrackSteps ( unsigned long long s )

Definition at line 243 of file OpalData.cpp.

References p.

◆ inRestartRun()

bool OpalData::inRestartRun ( )

true if we do a restart run

Definition at line 311 of file OpalData.cpp.

References p.

Referenced by main().

Here is the caller graph for this function:

◆ isInOPALCyclMode()

bool OpalData::isInOPALCyclMode ( )

Definition at line 271 of file OpalData.cpp.

References p.

◆ isInOPALTMode()

bool OpalData::isInOPALTMode ( )

Definition at line 275 of file OpalData.cpp.

References p.

◆ isInPrepState()

bool OpalData::isInPrepState ( )

Definition at line 295 of file OpalData.cpp.

References p.

◆ isOptimizerRun()

bool OpalData::isOptimizerRun ( )

Definition at line 279 of file OpalData.cpp.

References p.

◆ makeDirty()

void OpalData::makeDirty ( Object * object )

Invalidate expressions.

Definition at line 571 of file OpalData.cpp.

References p, and Object::setDirty().

Referenced by SequenceParser::parse(), and OpalParser::parseAssign().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void OpalData::operator= ( const OpalData & )

private

References OpalData().

Here is the call graph for this function:

◆ popInstance()

OpalData * OpalData::popInstance ( )

static

Definition at line 222 of file OpalData.cpp.

References deleteInstance(), instance, isInstantiated, OpalData(), and stashedInstances.

Here is the call graph for this function:

◆ printAllNames()

void OpalData::printAllNames ( std::ostream & stream )

Definition at line 577 of file OpalData.cpp.

References p.

◆ printNames()

void OpalData::printNames	(	std::ostream &	stream,
		const std::string &	pattern )

Print all objects.

Definition at line 606 of file OpalData.cpp.

References RegularExpression::match(), and p.

Here is the call graph for this function:

◆ printTitle()

void OpalData::printTitle ( std::ostream & os )

Print the page title.

Definition at line 669 of file OpalData.cpp.

References p.

◆ registerExpression()

void OpalData::registerExpression ( AttributeBase * expr )

Register expression.

Definition at line 649 of file OpalData.cpp.

References p.

Referenced by Expressions::AAutomatic< T >::AAutomatic(), Expressions::AAutomatic< T >::AAutomatic(), Expressions::SAutomatic< T >::SAutomatic(), and Expressions::SAutomatic< T >::SAutomatic().

Here is the caller graph for this function:

◆ registerTable()

void OpalData::registerTable ( Table * t )

Register table.

Definition at line 637 of file OpalData.cpp.

References p.

Referenced by Table::Table().

Here is the caller graph for this function:

◆ reset()

void OpalData::reset ( )

reset object for consecutive runs

Definition at line 255 of file OpalData.cpp.

References p.

◆ setDataSink()

void OpalData::setDataSink ( DataSink * s )

Definition at line 384 of file OpalData.cpp.

References p.

◆ setGlobalGeometry()

void OpalData::setGlobalGeometry ( BoundaryGeometry * bg )

Definition at line 455 of file OpalData.cpp.

References p.

Referenced by TrackRun::setupBoundaryGeometry().

Here is the caller graph for this function:

◆ setGlobalPhaseShift()

void OpalData::setGlobalPhaseShift ( double shift )

units: (sec)

Definition at line 445 of file OpalData.cpp.

References p.

Referenced by ParallelTracker::execute(), and H5PartWrapperForPT::readHeader().

Here is the caller graph for this function:

◆ setInOPALCyclMode()

void OpalData::setInOPALCyclMode ( )

Definition at line 283 of file OpalData.cpp.

References p.

◆ setInOPALTMode()

void OpalData::setInOPALTMode ( )

Definition at line 287 of file OpalData.cpp.

References p.

Referenced by TrackRun::execute().

Here is the caller graph for this function:

◆ setInPrepState()

void OpalData::setInPrepState ( bool state )

Definition at line 299 of file OpalData.cpp.

References p.

Referenced by ParallelTracker::execute().

Here is the caller graph for this function:

◆ setLastStep()

void OpalData::setLastStep ( const int & step )

set the last step in a run for possible follow-up run

Definition at line 356 of file OpalData.cpp.

References p.

◆ setMaxPhase()

void OpalData::setMaxPhase	(	std::string	elName,
		double	phi )

Definition at line 393 of file OpalData.cpp.

References p.

Referenced by CavityAutophaser::getPhaseAtMaxEnergy().

Here is the caller graph for this function:

◆ setMaxTrackSteps()

void OpalData::setMaxTrackSteps ( unsigned long long s )

Definition at line 239 of file OpalData.cpp.

References p.

◆ setOpenMode()

void OpalData::setOpenMode ( OpenMode openMode )

Definition at line 348 of file OpalData.cpp.

References p.

Referenced by ParallelTracker::execute(), and LossDataSink::LossDataSink().

Here is the caller graph for this function:

◆ setOptimizerFlag()

void OpalData::setOptimizerFlag ( )

Definition at line 291 of file OpalData.cpp.

References p.

◆ setP0()

void OpalData::setP0 ( ValueDefinition * p0 )

Set the global momentum.

Definition at line 657 of file OpalData.cpp.

References p.

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

Here is the caller graph for this function:

◆ setPartBunch()

void OpalData::setPartBunch ( PartBunch_t * p )

Definition at line 372 of file OpalData.cpp.

References p.

◆ setPriorTrack()

void OpalData::setPriorTrack ( const bool & value = true )

true if in follow-up track

Definition at line 307 of file OpalData.cpp.

References p.

◆ setRestartDumpFreq()

void OpalData::setRestartDumpFreq ( const int & N )

set the dump frequency as found in restart file

Definition at line 340 of file OpalData.cpp.

References p.

Referenced by H5PartWrapperForPT::readHeader().

Here is the caller graph for this function:

◆ setRestartFileName()

void OpalData::setRestartFileName ( std::string s )

store opals restart h5 format filename

Definition at line 331 of file OpalData.cpp.

References p.

Referenced by main().

Here is the caller graph for this function:

◆ setRestartRun()

void OpalData::setRestartRun ( const bool & value = true )

set OPAL in restart mode

Definition at line 315 of file OpalData.cpp.

References p.

Referenced by main().

Here is the caller graph for this function:

◆ setRestartStep()

void OpalData::setRestartStep ( int s )

store the location where to restart

Definition at line 319 of file OpalData.cpp.

References p.

Referenced by H5PartWrapperForPT::H5PartWrapperForPT(), and main().

Here is the caller graph for this function:

◆ stashInstance()

void OpalData::stashInstance ( )

static

Definition at line 211 of file OpalData.cpp.

References instance, isInstantiated, MAX_NUM_INSTANCES, and stashedInstances.

◆ storeArguments()

void OpalData::storeArguments	(	int	argc,
		char *	argv[] )

Definition at line 780 of file OpalData.cpp.

References p.

Referenced by main().

Here is the caller graph for this function:

◆ storeInputFn()

void OpalData::storeInputFn ( const std::string & fn )

store opals input filename

Definition at line 665 of file OpalData.cpp.

References p.

Referenced by main().

Here is the caller graph for this function:

◆ storeTitle()

void OpalData::storeTitle ( const std::string & title )

Store the page title.

Definition at line 661 of file OpalData.cpp.

References p.

Referenced by Title::execute().

Here is the caller graph for this function:

◆ unregisterExpression()

void OpalData::unregisterExpression ( AttributeBase * expr )

Unregister expression.

Definition at line 653 of file OpalData.cpp.

References p.

Referenced by Expressions::AAutomatic< T >::~AAutomatic(), and Expressions::SAutomatic< T >::~SAutomatic().

Here is the caller graph for this function:

◆ unregisterTable()

void OpalData::unregisterTable ( Table * t )

Unregister table.

Definition at line 641 of file OpalData.cpp.

References p.

Referenced by Table::~Table().

Here is the caller graph for this function:

◆ update()

void OpalData::update ( )

Update all objects.

Definition at line 701 of file OpalData.cpp.

References p.

Referenced by IfStatement::execute(), OpalParser::execute(), and WhileStatement::execute().

Here is the caller graph for this function:

Member Data Documentation

◆ instance

OpalData * OpalData::instance = nullptr

staticprivate

Definition at line 261 of file OpalData.h.

Referenced by deleteInstance(), getInstance(), popInstance(), and stashInstance().

◆ isInstantiated

bool OpalData::isInstantiated = false

staticprivate

Definition at line 260 of file OpalData.h.

Referenced by deleteInstance(), getInstance(), popInstance(), and stashInstance().

◆ p

struct OpalDataImpl* OpalData::p

private

Definition at line 271 of file OpalData.h.

Referenced by addEnergyData(), addProblemCharacteristicValue(), apply(), bunchIsAllocated(), checkAndAddOutputFileName(), create(), define(), erase(), find(), getArguments(), getDataSink(), getFirstEnergyData(), getFirstMaxPhases(), getGlobalGeometry(), getGlobalPhaseShift(), getInputBasename(), getInputFn(), getLastEnergyData(), getLastMaxPhases(), getLastStep(), getMaxTrackSteps(), getNumberOfMaxPhases(), getOpenMode(), getP0(), getPartBunch(), getProblemCharacteristicValues(), getRestartDumpFreq(), getRestartFileName(), getRestartStep(), getTitle(), getVariableNames(), hasBunchAllocated(), hasDataSinkAllocated(), hasGlobalGeometry(), hasPriorTrack(), hasRestartFile(), incMaxTrackSteps(), inRestartRun(), isInOPALCyclMode(), isInOPALTMode(), isInPrepState(), isOptimizerRun(), makeDirty(), OpalData(), printAllNames(), printNames(), printTitle(), registerExpression(), registerTable(), reset(), setDataSink(), setGlobalGeometry(), setGlobalPhaseShift(), setInOPALCyclMode(), setInOPALTMode(), setInPrepState(), setLastStep(), setMaxPhase(), setMaxTrackSteps(), setOpenMode(), setOptimizerFlag(), setP0(), setPartBunch(), setPriorTrack(), setRestartDumpFreq(), setRestartFileName(), setRestartRun(), setRestartStep(), storeArguments(), storeInputFn(), storeTitle(), unregisterExpression(), unregisterTable(), update(), and ~OpalData().

◆ stashedInstances

std::stack< OpalData * > OpalData::stashedInstances

staticprivate

Definition at line 262 of file OpalData.h.

Referenced by popInstance(), and stashInstance().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ OpenMode

Constructor & Destructor Documentation

◆ ~OpalData()

◆ OpalData() [1/2]

◆ OpalData() [2/2]

Member Function Documentation

◆ addEnergyData()

◆ addProblemCharacteristicValue()

◆ apply()

◆ bunchIsAllocated()

◆ checkAndAddOutputFileName()

◆ create()

◆ define()

◆ deleteInstance()

◆ erase()

◆ find()

◆ getArguments()

◆ getAuxiliaryOutputDirectory()

◆ getDataSink()

◆ getFirstEnergyData()

◆ getFirstMaxPhases()

◆ getGlobalGeometry()

◆ getGlobalPhaseShift()

◆ getInputBasename()

◆ getInputFn()

◆ getInstance()

◆ getLastEnergyData()

◆ getLastMaxPhases()

◆ getLastStep()

◆ getMaxTrackSteps()

◆ getNumberOfMaxPhases()

◆ getOpenMode()

◆ getP0()

◆ getPartBunch()

◆ getProblemCharacteristicValues()

◆ getRestartDumpFreq()

◆ getRestartFileName()

◆ getRestartStep()

◆ getTitle()

◆ getVariableData()

◆ getVariableNames()

◆ hasBunchAllocated()

◆ hasDataSinkAllocated()

◆ hasGlobalGeometry()

◆ hasPriorTrack()

◆ hasRestartFile()

◆ incMaxTrackSteps()

◆ inRestartRun()

◆ isInOPALCyclMode()

◆ isInOPALTMode()

◆ isInPrepState()

◆ isOptimizerRun()

◆ makeDirty()

◆ operator=()

◆ popInstance()

◆ printAllNames()

◆ printNames()

◆ printTitle()

◆ registerExpression()

◆ registerTable()

◆ reset()

◆ setDataSink()

◆ setGlobalGeometry()

◆ setGlobalPhaseShift()

◆ setInOPALCyclMode()

◆ setInOPALTMode()

◆ setInPrepState()

◆ setLastStep()

◆ setMaxPhase()

◆ setMaxTrackSteps()

◆ setOpenMode()