Variables
bool	echo = false
	Echo flag.

bool	info = true
	Info flag.

int	infoLevel = 1

bool	mtrace = false
	Trace flag.

bool	warn = true
	Warn flag.

int	warnLevel = 1

Random	rangen

int	seed = 123456789
	The current random seed.

int	psDumpFreq = 10
	The frequency to dump the phase space, i.e.dump data when steppsDumpFreq==0.

int	statDumpFreq = 10
	The frequency to dump statistical values, e.e. dump data when stepstatDumpFreq==0.

int	stepInfoFreq = 1
	The frequency to print per-step tracking status lines; 0 disables them.

bool	psDumpEachTurn = false
	phase space dump flag for OPAL-cycl

DumpFrame	psDumpFrame = DumpFrame::GLOBAL
	flag to decide in which coordinate frame the phase space will be dumped for OPAL-cycl

int	sptDumpFreq = 1
	The frequency to dump single particle trajectory of particles with ID = 0 & 1.

int	repartFreq = 10
	The frequency to do particles repartition for better load balance between nodes.

int	minBinEmitted = 10
	The number of bins that have to be emitted before the bin are squashed into a single bin.

int	minStepForRebin = 200
	The number of steps into the simulation before the bins are squashed into a single bin.

int	rebinFreq = 100
	The frequency to reset energy bin ID for all particles.

int	scSolveFreq = 1
	The frequency to solve space charge fields.

int	mtsSubsteps = 1

double	remotePartDel = 0.0

bool	rhoDump = false

bool	ebDump = false

bool	csrDump = false

int	autoPhase = 6

int	numBlocks = 0
	RCG: cycle length.

int	recycleBlocks = 0
	RCG: number of recycle blocks.

int	nLHS = 1
	number of old left hand sides used to extrapolate a new start vector

bool	cZero = false
	If true create symmetric distribution.

std::string	rngtype = std::string("RANDOM")
	random number generator

bool	enableHDF5 = true
	If true HDF5 files are written.

bool	enableVTK = true
	If true VTK files are written.

bool	asciidump = false

double	boundpDestroy = 10
	Governs how many sigmas away particles are deleted.

double	beamHaloBoundary = 0

bool	cloTuneOnly = false
	Do closed orbit and tune calculation only.

bool	idealized = false

bool	writeBendTrajectories = false

int	version = 10000
	opal version of input file

bool	memoryDump = false

double	haloShift = 0.0
	The constant parameter C to shift halo, by < w^4 > / < w^2 > ^2 - C (w=x,y,z)

unsigned int	delPartFreq = 1
	The frequency to delete particles (currently: OPAL-cycl only)

bool	computePercentiles = false

bool	useQMAttributes = false

bool	aggressiveStateSync = false

Variable Documentation

◆ aggressiveStateSync

bool Options::aggressiveStateSync = false

If true, every BunchStateHandler setter performs an ippl::Comm->allreduce so that the flag is guaranteed to be consistent across MPI ranks, even if the caller set it on a subset of ranks. Off by default because the extra collective on every state change has a noticeable cost in tight loops; enable it only for debugging or in contexts where rank-local divergence is possible.

Definition at line 111 of file Options.cpp.

Referenced by Option::execute(), BunchStateHandler::ContainerState::markMomentsClean(), BunchStateHandler::ContainerState::markMomentsDirty(), Option::Option(), Option::Option(), BunchStateHandler::setFirstRepartition(), BunchStateHandler::ContainerState::setUnitlessPositions(), BunchStateHandlerTest::SetUp(), BunchStateHandlerTest::TearDown(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ asciidump

bool Options::asciidump = false

Definition at line 87 of file Options.cpp.

Referenced by Option::execute(), PluginElement::initialise(), Monitor::initialise(), Option::Option(), and Option::Option().

◆ autoPhase

int Options::autoPhase = 6

Definition at line 71 of file Options.cpp.

Referenced by OrbitThreader::autophaseCavities(), Option::execute(), CavityAutophaser::optimizeCavityPhase(), Option::Option(), and Option::Option().

◆ beamHaloBoundary

double Options::beamHaloBoundary = 0

Definition at line 91 of file Options.cpp.

Referenced by DataSink::dumpSDDS(), Option::execute(), Option::Option(), and Option::Option().

◆ boundpDestroy

double Options::boundpDestroy = 10

Governs how many sigmas away particles are deleted.

Definition at line 89 of file Options.cpp.

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

◆ cloTuneOnly

bool Options::cloTuneOnly = false

Do closed orbit and tune calculation only.

Definition at line 93 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ computePercentiles

bool Options::computePercentiles = false

Definition at line 107 of file Options.cpp.

Referenced by DistributionMoments::computePercentiles(), Option::execute(), Option::Option(), Option::Option(), LossDataSink::saveH5(), and LossDataSink::writeHeaderH5().

◆ csrDump

bool Options::csrDump = false

Definition at line 69 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ cZero

bool Options::cZero = false

If true create symmetric distribution.

Definition at line 79 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ delPartFreq

unsigned int Options::delPartFreq = 1

The frequency to delete particles (currently: OPAL-cycl only)

Definition at line 105 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ ebDump

bool Options::ebDump = false

Definition at line 67 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), Option::Option(), H5PartWrapperForPT::writeHeader(), and H5PartWrapperForPT::writeStepData().

◆ echo

bool Options::echo = false

Echo flag.

Definition at line 26 of file Options.cpp.

Referenced by Option::execute(), main(), Option::Option(), and Option::Option().

◆ enableHDF5

bool Options::enableHDF5 = true

If true HDF5 files are written.

Definition at line 83 of file Options.cpp.

Referenced by DataSink::changeH5Wrappers(), DataSink::DataSink(), DataSink::dumpH5(), DataSink::dumpH5(), Option::execute(), DataSink::init(), LossDataSink::LossDataSink(), Option::Option(), Option::Option(), TestMultipoleT::SetUpTestSuite(), TestMultipoleTCurvedConstRadius::SetUpTestSuite(), TestMultipoleTStraight::SetUpTestSuite(), SolenoidPlacementTest::SetUpTestSuite(), TestVariableRFCavity::SetUpTestSuite(), OrbitThreaderTest::SetUpTestSuite(), OpalBeamlinePlacementTest::SetUpTestSuite(), and DataSink::storeCavityInformation().

◆ enableVTK

bool Options::enableVTK = true

If true VTK files are written.

Definition at line 85 of file Options.cpp.

Referenced by BoundaryGeometry::computeMeshVoxelization(), Option::execute(), Option::Option(), Option::Option(), and DataSink::writeGeomToVtk().

◆ haloShift

double Options::haloShift = 0.0

The constant parameter C to shift halo, by < w^4 > / < w^2 > ^2 - C (w=x,y,z)

Definition at line 103 of file Options.cpp.

Referenced by DistributionMoments::computeMoments(), Option::execute(), Option::Option(), and Option::Option().

◆ idealized

bool Options::idealized = false

Definition at line 95 of file Options.cpp.

Referenced by OpalBeamline::compileCompatibilityPlacement(), Option::execute(), Option::Option(), and Option::Option().

◆ info

bool Options::info = true

Info flag.

Definition at line 28 of file Options.cpp.

Referenced by OpalData::define(), Call::execute(), Option::execute(), Option::Option(), Option::Option(), and Select::select().

◆ infoLevel

int Options::infoLevel = 1

Definition at line 29 of file Options.cpp.

◆ memoryDump

bool Options::memoryDump = false

Definition at line 101 of file Options.cpp.

Referenced by Option::Option(), and Option::Option().

◆ minBinEmitted

int Options::minBinEmitted = 10

The number of bins that have to be emitted before the bin are squashed into a single bin.

Definition at line 53 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ minStepForRebin

int Options::minStepForRebin = 200

The number of steps into the simulation before the bins are squashed into a single bin.

Definition at line 55 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ mtrace

bool Options::mtrace = false

Trace flag.

Definition at line 31 of file Options.cpp.

Referenced by Option::execute(), OpalParser::execute(), Option::Option(), and Option::Option().

◆ mtsSubsteps

int Options::mtsSubsteps = 1

Definition at line 61 of file Options.cpp.

Referenced by Option::execute(), and Option::Option().

◆ nLHS

int Options::nLHS = 1

number of old left hand sides used to extrapolate a new start vector

Definition at line 77 of file Options.cpp.

Referenced by Option::execute(), and Option::Option().

◆ numBlocks

int Options::numBlocks = 0

RCG: cycle length.

Definition at line 73 of file Options.cpp.

Referenced by Option::execute(), and Option::Option().

◆ psDumpEachTurn

bool Options::psDumpEachTurn = false

phase space dump flag for OPAL-cycl

Definition at line 45 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ psDumpFrame

DumpFrame Options::psDumpFrame = DumpFrame::GLOBAL

flag to decide in which coordinate frame the phase space will be dumped for OPAL-cycl

Definition at line 47 of file Options.cpp.

Referenced by Option::handlePsDumpFrame(), and Option::Option().

◆ psDumpFreq

int Options::psDumpFreq = 10

The frequency to dump the phase space, i.e.dump data when steppsDumpFreq==0.

Definition at line 39 of file Options.cpp.

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

◆ rangen

Random Options::rangen

Definition at line 36 of file Options.cpp.

Referenced by Option::execute(), Expressions::gauss(), Expressions::ranf(), and Expressions::Tgauss().

◆ rebinFreq

int Options::rebinFreq = 100

The frequency to reset energy bin ID for all particles.

Definition at line 57 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ recycleBlocks

int Options::recycleBlocks = 0

RCG: number of recycle blocks.

Definition at line 75 of file Options.cpp.

Referenced by Option::execute(), and Option::Option().

◆ remotePartDel

double Options::remotePartDel = 0.0

Definition at line 63 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ repartFreq

int Options::repartFreq = 10

The frequency to do particles repartition for better load balance between nodes.

Definition at line 51 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), Option::Option(), and ParallelTracker::setOptionalVariables().

◆ rhoDump

bool Options::rhoDump = false

Definition at line 65 of file Options.cpp.

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

◆ rngtype

std::string Options::rngtype = std::string("RANDOM")

random number generator

Definition at line 81 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ scSolveFreq

int Options::scSolveFreq = 1

The frequency to solve space charge fields.

Definition at line 59 of file Options.cpp.

Referenced by Option::execute(), and Option::Option().

◆ seed

int Options::seed = 123456789

The current random seed.

Definition at line 37 of file Options.cpp.

Referenced by OpalFlatTop::determineHostSeed(), FlatTop::determineRandInit(), OpalFlatTop::determineRandInit(), Option::execute(), Gaussian::initRandomPool(), MultiVariateGaussian::initRandomPool(), main(), Option::Option(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), and TEST().

◆ sptDumpFreq

int Options::sptDumpFreq = 1

The frequency to dump single particle trajectory of particles with ID = 0 & 1.

Definition at line 49 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ statDumpFreq

int Options::statDumpFreq = 10

The frequency to dump statistical values, e.e. dump data when stepstatDumpFreq==0.

Definition at line 41 of file Options.cpp.

Referenced by ParallelTracker::execute(), Option::execute(), Option::Option(), Option::Option(), and TrackRun::print().

◆ stepInfoFreq

int Options::stepInfoFreq = 1

The frequency to print per-step tracking status lines; 0 disables them.

Definition at line 43 of file Options.cpp.

Referenced by ParallelTracker::dumpStats(), Option::execute(), Option::Option(), and Option::Option().

◆ useQMAttributes

bool Options::useQMAttributes = false

If true, store Q/M as per-particle attributes (accessible via getQView()/getMView()). If false (default), use a single shared value per container to save memory.

Definition at line 109 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().

◆ version

int Options::version = 10000

opal version of input file

Definition at line 99 of file Options.cpp.

Referenced by Option::execute(), TrackRun::execute(), Option::Option(), and Option::Option().

◆ warn

bool Options::warn = true

Warn flag.

Definition at line 33 of file Options.cpp.

Referenced by Expressions::AbsMax(), Option::execute(), Expressions::Maxa(), Expressions::Mina(), Option::Option(), Option::Option(), Expressions::Rmsa(), and Selector::Selector().

◆ warnLevel

int Options::warnLevel = 1

Definition at line 34 of file Options.cpp.

◆ writeBendTrajectories

bool Options::writeBendTrajectories = false

Definition at line 97 of file Options.cpp.

Referenced by Option::execute(), Option::Option(), and Option::Option().