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.
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
int	boundpDestroyFreq = 10
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	amr = false
	Enable AMR if true.
int	amrYtDumpFreq = 10
	The frequency to dump AMR grid data and particles into file.
int	amrRegridFreq = 10
	After how many steps the AMR grid hierarchy is updated.
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	dumpBeamMatrix = false

Variable Documentation

◆ amr

bool Options::amr = false

Enable AMR if true.

Definition at line 99 of file Options.cpp.

Referenced by DataSink::init(), FieldSolver::isAmrSolverType(), DistributionMoments::isParticleExcluded(), FieldSolver::printInfo(), run_opal(), TrackRun::setupFieldsolver(), and Track::Track().

◆ amrRegridFreq

int Options::amrRegridFreq = 10

After how many steps the AMR grid hierarchy is updated.

Definition at line 103 of file Options.cpp.

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

◆ amrYtDumpFreq

int Options::amrYtDumpFreq = 10

The frequency to dump AMR grid data and particles into file.

Definition at line 101 of file Options.cpp.

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

◆ asciidump

bool Options::asciidump = false

Definition at line 85 of file Options.cpp.

Referenced by BeamStrippingPhysics::BeamStrippingPhysics(), Option::execute(), ParallelCyclotronTracker::execute(), Cyclotron::initialise(), FlexibleCollimator::initialise(), FlexibleCollimator::initialise(), Monitor::initialise(), PluginElement::initialise(), Source::initialise(), Option::Option(), Option::Option(), and ScatteringPhysics::ScatteringPhysics().

◆ autoPhase

int Options::autoPhase = 6

Definition at line 69 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 89 of file Options.cpp.

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

◆ boundpDestroyFreq

int Options::boundpDestroyFreq = 10

Definition at line 87 of file Options.cpp.

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

◆ cloTuneOnly

bool Options::cloTuneOnly = false

Do closed orbit and tune calculation only.

Definition at line 91 of file Options.cpp.

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

◆ computePercentiles

bool Options::computePercentiles = false

Definition at line 111 of file Options.cpp.

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

◆ csrDump

bool Options::csrDump = false

Definition at line 67 of file Options.cpp.

Referenced by CSRIGFWakeFunction::apply(), CSRWakeFunction::apply(), Option::execute(), Option::Option(), and Option::Option().

◆ cZero

bool Options::cZero = false

If true create symmetric distribution.

Definition at line 77 of file Options.cpp.

Referenced by Distribution::create(), Distribution::createOpalT(), Option::execute(), Option::Option(), Option::Option(), Distribution::printDist(), and Distribution::reflectDistribution().

◆ delPartFreq

unsigned int Options::delPartFreq = 1

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

Definition at line 109 of file Options.cpp.

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

◆ dumpBeamMatrix

bool Options::dumpBeamMatrix = false

Definition at line 113 of file Options.cpp.

Referenced by Option::execute(), StatWriter::fillHeader(), Option::Option(), Option::Option(), and StatWriter::write().

◆ ebDump

bool Options::ebDump = false

Definition at line 65 of file Options.cpp.

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

◆ echo

bool Options::echo = false

Echo flag.

Definition at line 26 of file Options.cpp.

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

◆ enableHDF5

bool Options::enableHDF5 = true

If true HDF5 files are written.

Definition at line 81 of file Options.cpp.

Referenced by DataSink::changeH5Wrapper(), DataSink::DataSink(), DataSink::dumpH5(), DataSink::dumpH5(), Option::execute(), DataSink::init(), TrackRun::initPhaseSpaceSink(), LossDataSink::LossDataSink(), Option::Option(), Option::Option(), and DataSink::storeCavityInformation().

◆ enableVTK

bool Options::enableVTK = true

If true VTK files are written.

Definition at line 83 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 107 of file Options.cpp.

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

◆ idealized

bool Options::idealized = false

Definition at line 93 of file Options.cpp.

Referenced by OpalBeamline::compute3DLattice(), 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(), Cyclotron::getFieldFromFile_AVFEQ(), Cyclotron::getFieldFromFile_Carbon(), Cyclotron::getFieldFromFile_FFA(), Option::Option(), Option::Option(), and Select::select().

◆ infoLevel

int Options::infoLevel = 1

Definition at line 29 of file Options.cpp.

Referenced by OpalSimulation::run().

◆ memoryDump

bool Options::memoryDump = false

Definition at line 105 of file Options.cpp.

Referenced by Option::execute(), DataSink::init(), 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 51 of file Options.cpp.

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

◆ minStepForRebin

int Options::minStepForRebin = 200

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

Definition at line 53 of file Options.cpp.

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

◆ mtrace

bool Options::mtrace = false

Trace flag.

Definition at line 31 of file Options.cpp.

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

◆ mtsSubsteps

int Options::mtsSubsteps = 1

Definition at line 59 of file Options.cpp.

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

◆ nLHS

int Options::nLHS = 1

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

Definition at line 75 of file Options.cpp.

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

◆ numBlocks

int Options::numBlocks = 0

RCG: cycle length.

Definition at line 71 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 43 of file Options.cpp.

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

◆ 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 45 of file Options.cpp.

Referenced by ParallelCyclotronTracker::bunchDumpPhaseSpaceData(), ParallelCyclotronTracker::bunchDumpStatData(), ParallelCyclotronTracker::computePathLengthUpdate(), Option::handlePsDumpFrame(), ParallelCyclotronTracker::initDistInGlobalFrame(), Option::Option(), ParallelCyclotronTracker::visitCyclotron(), and H5PartWrapperForPC::writeStepHeader().

◆ 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 ParallelCyclotronTracker::bunchDumpPhaseSpaceData(), ThickTracker::dump_m(), Option::execute(), ParallelTTracker::execute(), Option::Option(), Option::Option(), TrackRun::print(), ParallelCyclotronTracker::update_m(), H5PartWrapperForPC::writeHeader(), 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 55 of file Options.cpp.

Referenced by ParallelCyclotronTracker::bunchMode_m(), Option::execute(), ParallelCyclotronTracker::initializeTracking_m(), ParallelCyclotronTracker::MtsTracker(), Option::Option(), and Option::Option().

◆ recycleBlocks

int Options::recycleBlocks = 0

RCG: number of recycle blocks.

Definition at line 73 of file Options.cpp.

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

◆ remotePartDel

double Options::remotePartDel = 0.0

Definition at line 61 of file Options.cpp.

Referenced by PartBunchBase< T, Dim >::boundp_destroyCycl(), PartBunchBase< T, Dim >::boundp_destroyT(), 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 49 of file Options.cpp.

Referenced by Option::execute(), ParallelCyclotronTracker::initializeTracking_m(), ParallelCyclotronTracker::MtsTracker(), Option::Option(), Option::Option(), ParallelCyclotronTracker::repartition(), and ParallelTTracker::setOptionalVariables().

◆ rhoDump

bool Options::rhoDump = false

Definition at line 63 of file Options.cpp.

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

◆ rngtype

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

random number generator

Definition at line 79 of file Options.cpp.

Referenced by Distribution::createDistributionMultiGauss(), Option::execute(), Distribution::generateFlattopT(), Distribution::generateFlattopZ(), Distribution::generateLongFlattopT(), Option::Option(), Option::Option(), and Distribution::selectRandomGenerator().

◆ scSolveFreq

int Options::scSolveFreq = 1

The frequency to solve space charge fields.

Definition at line 57 of file Options.cpp.

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

◆ seed

int Options::seed = 123456789

The current random seed.

Definition at line 37 of file Options.cpp.

Referenced by Distribution::create(), Option::execute(), Option::Option(), OpalSimulation::run(), and ScatteringPhysics::ScatteringPhysics().

◆ sptDumpFreq

int Options::sptDumpFreq = 1

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

Definition at line 47 of file Options.cpp.

Referenced by ParallelCyclotronTracker::bunchMode_m(), Option::execute(), ParallelCyclotronTracker::initializeTracking_m(), ParallelCyclotronTracker::MtsTracker(), Option::Option(), Option::Option(), ParallelCyclotronTracker::seoMode_m(), and ParallelCyclotronTracker::singleMode_m().

◆ 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 ThickTracker::dump_m(), Option::execute(), ParallelTTracker::execute(), Option::Option(), Option::Option(), TrackRun::print(), and ParallelCyclotronTracker::update_m().

◆ version

int Options::version = 10000

opal version of input file

Definition at line 97 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(), and Expressions::Rmsa().

◆ warnLevel

int Options::warnLevel = 1

Definition at line 34 of file Options.cpp.

Referenced by OpalSimulation::run().

◆ writeBendTrajectories

bool Options::writeBendTrajectories = false

Definition at line 95 of file Options.cpp.

Referenced by Bend2D::calculateRefTrajectory(), Option::execute(), Bend2D::getOutline(), RBend3D::initialise(), Option::Option(), and Option::Option().