|
OPAL (Object Oriented Parallel Accelerator Library)
2.2.0
OPAL
|
The global OPAL option flags. More...
Enumerations | |
| enum | DumpFrame { GLOBAL =0, BUNCH_MEAN =1, REFERENCE =2 } |
Variables | |
| bool | echo = false |
| Echo flag. More... | |
| bool | info = true |
| Info flag. More... | |
| int | infoLevel = 1 |
| bool | warn = true |
| Warn flag. More... | |
| int | warnLevel = 1 |
| bool | csrDump = false |
| bool | ppdebug = false |
| ppdebug flag. More... | |
| bool | cZero = false |
| if true create symmetric distribution More... | |
| bool | asciidump = false |
| double | remotePartDel = 0.0 |
| double | beamHaloBoundary = 0 |
| bool | writeBendTrajectories = false |
| bool | mtrace = false |
| Trace flag. More... | |
| bool | psDumpEachTurn = false |
| phase space dump flag for OPAL-cycl More... | |
| DumpFrame | psDumpFrame = GLOBAL |
| flag to decide in which coordinate frame the phase space will be dumped for OPAL-cycl More... | |
| bool | rhoDump = false |
| bool | ebDump = false |
| bool | enableHDF5 = true |
| If true HDF5 files are written. More... | |
| Random | rangen |
| Random generator. More... | |
| int | seed = 123456789 |
| The current random seed. More... | |
| int | autoPhase = 6 |
| int | psDumpFreq = 10 |
| The frequency to dump the phase space, i.e.dump data when steppsDumpFreq==0. More... | |
| int | statDumpFreq = 10 |
| The frequency to dump statistical values, e.e. dump data when stepstatDumpFreq==0. More... | |
| int | sptDumpFreq = 1 |
| The frequency to dump single particle trajectory of particles with ID = 0 & 1. More... | |
| int | repartFreq = 10 |
| The frequency to do particles repartition for better load balance between nodes. More... | |
| int | minBinEmitted = 10 |
| The number of bins that have to be emitted before the bin are squashed into a single bin. More... | |
| int | minStepForRebin = 200 |
| The number of steps into the simulation before the bins are squashed into a single bin. More... | |
| int | rebinFreq = 100 |
| The frequency to reset energy bin ID for all particles. More... | |
| int | scSolveFreq = 1 |
| The frequency to solve space charge fields. More... | |
| int | mtsSubsteps = 1 |
| int | surfDumpFreq = -1 |
| The frequency to dump the particle-geometry surface interation data. More... | |
| int | numBlocks = 0 |
| RCG: cycle length. More... | |
| int | recycleBlocks = 0 |
| RCG: number of recycle blocks. More... | |
| int | nLHS = 1 |
| number of old left hand sides used to extrapolate a new start vector More... | |
| std::string | rngtype = std::string("RANDOM") |
| random number generator More... | |
| bool | cloTuneOnly = false |
| Do closed orbit and tune calculation only. More... | |
| int | boundpDestroyFreq = 10 |
| bool | idealized = false |
| int | version = 10000 |
| opal version of input file More... | |
| bool | amr = false |
| int | amrYtDumpFreq = 10 |
| The frequency to dump AMR grid data and particles into file. More... | |
| int | amrRegridFreq = 10 |
| 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) More... | |
| unsigned int | delPartFreq = 1 |
| The frequency to delete particles (currently: OPAL-cycl only) More... | |
The global OPAL option flags.
| enum Options::DumpFrame |
| Enumerator | |
|---|---|
| GLOBAL | |
| BUNCH_MEAN | |
| REFERENCE | |
Definition at line 5 of file OptionTypes.h.
| bool Options::amr = false |
Definition at line 100 of file Options.cpp.
Referenced by Option::execute(), DataSink::init(), FieldSolver::isAmrSolverType(), Option::Option(), FieldSolver::printInfo(), TrackRun::setupFieldsolver(), and Track::Track().
| int Options::amrRegridFreq = 10 |
Definition at line 105 of file Options.cpp.
Referenced by AmrBoxLib::computeSelfFields_cycl(), Option::execute(), and Option::Option().
| int Options::amrYtDumpFreq = 10 |
The frequency to dump AMR grid data and particles into file.
Definition at line 103 of file Options.cpp.
Referenced by AmrBoxLib::computeSelfFields_cycl(), Option::execute(), and Option::Option().
| bool Options::asciidump = false |
Definition at line 18 of file Options.cpp.
Referenced by BeamStrippingPhysics::BeamStrippingPhysics(), CollimatorPhysics::CollimatorPhysics(), Option::execute(), ParallelCyclotronTracker::execute(), PluginElement::initialise(), Source::initialise(), FlexibleCollimator::initialise(), Degrader::initialise(), Monitor::initialise(), Cyclotron::initialise(), Option::Option(), PartBunchBase< T, Dim >::PartBunchBase(), and PartBunchBase< T, Dim >::setup().
| int Options::autoPhase = 6 |
Definition at line 45 of file Options.cpp.
Referenced by OrbitThreader::autophaseCavities(), Option::execute(), ParallelSliceTracker::handleAutoPhasing(), CavityAutophaser::optimizeCavityPhase(), and Option::Option().
| double Options::beamHaloBoundary = 0 |
Definition at line 24 of file Options.cpp.
Referenced by Option::execute(), Option::Option(), and StatWriter::write().
| int Options::boundpDestroyFreq = 10 |
Definition at line 91 of file Options.cpp.
Referenced by ParallelCyclotronTracker::computeSpaceChargeFields_m(), and Option::Option().
| bool Options::cloTuneOnly = false |
Do closed orbit and tune calculation only.
Definition at line 87 of file Options.cpp.
Referenced by Distribution::createMatchedGaussDistribution(), Option::execute(), and Option::Option().
| bool Options::csrDump = false |
Definition at line 12 of file Options.cpp.
Referenced by CSRIGFWakeFunction::apply(), CSRWakeFunction::apply(), Option::execute(), and Option::Option().
| bool Options::cZero = false |
if true create symmetric distribution
Definition at line 16 of file Options.cpp.
Referenced by Distribution::create(), Distribution::createOpalT(), Option::execute(), Option::Option(), Distribution::printDist(), and Distribution::reflectDistribution().
| unsigned int Options::delPartFreq = 1 |
The frequency to delete particles (currently: OPAL-cycl only)
Definition at line 112 of file Options.cpp.
Referenced by ParallelCyclotronTracker::deleteParticle(), Option::execute(), and Option::Option().
| bool Options::ebDump = false |
Definition at line 33 of file Options.cpp.
Referenced by Option::execute(), Option::Option(), FM3DDynamic::readMap(), H5PartWrapperForPC::writeHeader(), H5PartWrapperForPT::writeHeader(), H5PartWrapperForPT::writeStepData(), and H5PartWrapperForPC::writeStepData().
| bool Options::echo = false |
Echo flag.
Definition at line 7 of file Options.cpp.
Referenced by Option::execute(), main(), and Option::Option().
| bool Options::enableHDF5 = true |
If true HDF5 files are written.
Definition at line 35 of file Options.cpp.
Referenced by DataSink::changeH5Wrapper(), DataSink::DataSink(), DataSink::dumpH5(), Option::execute(), DataSink::init(), Option::Option(), LossDataSink::save(), and DataSink::storeCavityInformation().
| 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 110 of file Options.cpp.
Referenced by PartBunchBase< T, Dim >::calcMoments(), Option::execute(), and Option::Option().
| bool Options::idealized = false |
Definition at line 94 of file Options.cpp.
Referenced by OpalBeamline::compute3DLattice(), Option::execute(), and Option::Option().
| bool Options::info = true |
Info flag.
Definition at line 8 of file Options.cpp.
Referenced by OpalData::define(), SetIntegrator::execute(), EditMove::execute(), EditReflect::execute(), EditRemove::execute(), EditReplace::execute(), EditSelect::execute(), Call::execute(), EditCycle::execute(), EditFlatten::execute(), Option::execute(), ConstraintCmd::execute(), EditInstall::execute(), Cyclotron::getFieldFromFile_AVFEQ(), Cyclotron::getFieldFromFile_Carbon(), Cyclotron::getFieldFromFile_FFA(), FM1DProfile2::getFieldstrength(), FieldSolver::initAmrObject_m(), MLPoissonSolver::mlmg_m(), Option::Option(), UniformCartesian< D, T >::print(), OpalSimulation::run(), Select::select(), DiscParticle::write(), AmrYtWriter::writeBunch(), and AmrYtWriter::writeParticles_m().
| int Options::infoLevel = 1 |
Definition at line 9 of file Options.cpp.
Referenced by OpalSimulation::run().
| bool Options::memoryDump = false |
Definition at line 108 of file Options.cpp.
Referenced by Option::execute(), DataSink::init(), and Option::Option().
| 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 63 of file Options.cpp.
Referenced by Option::Option(), and ParallelTTracker::setOptionalVariables().
| int Options::minStepForRebin = 200 |
The number of steps into the simulation before the bins are squashed into a single bin.
Definition at line 66 of file Options.cpp.
Referenced by Option::Option(), and ParallelTTracker::setOptionalVariables().
| bool Options::mtrace = false |
Trace flag.
Definition at line 29 of file Options.cpp.
Referenced by Option::execute(), OpalParser::execute(), and Option::Option().
| int Options::mtsSubsteps = 1 |
Definition at line 75 of file Options.cpp.
Referenced by Option::execute(), ParallelCyclotronTracker::MtsTracker(), and Option::Option().
| int Options::nLHS = 1 |
number of old left hand sides used to extrapolate a new start vector
Definition at line 83 of file Options.cpp.
Referenced by Option::execute(), and Option::Option().
| int Options::numBlocks = 0 |
RCG: cycle length.
Definition at line 81 of file Options.cpp.
Referenced by Option::execute(), and Option::Option().
| bool Options::ppdebug = false |
ppdebug flag.
Definition at line 13 of file Options.cpp.
Referenced by BoundaryGeometry::createPriPart(), Distribution::createPriPart(), Option::execute(), SecondaryEmissionPhysics::nSec(), and Option::Option().
| bool Options::psDumpEachTurn = false |
phase space dump flag for OPAL-cycl
Definition at line 30 of file Options.cpp.
Referenced by Option::execute(), Option::Option(), and ParallelCyclotronTracker::update_m().
flag to decide in which coordinate frame the phase space will be dumped for OPAL-cycl
Definition at line 31 of file Options.cpp.
Referenced by ParallelCyclotronTracker::bunchDumpPhaseSpaceData(), ParallelCyclotronTracker::bunchDumpStatData(), ParallelCyclotronTracker::computePathLengthUpdate(), Option::handlePsDumpFrame(), ParallelCyclotronTracker::initDistInGlobalFrame(), Option::Option(), ParallelCyclotronTracker::visitCyclotron(), and H5PartWrapperForPC::writeStepHeader().
| int Options::psDumpFreq = 10 |
The frequency to dump the phase space, i.e.dump data when steppsDumpFreq==0.
Definition at line 48 of file Options.cpp.
Referenced by ParallelCyclotronTracker::bunchDumpPhaseSpaceData(), ThickTracker::dump_m(), ParallelSliceTracker::dumpStats(), Option::execute(), ParallelTTracker::execute(), Option::Option(), TrackRun::setupCyclotronTracker(), TrackRun::setupSliceTracker(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), ParallelCyclotronTracker::update_m(), H5PartWrapperForPC::writeHeader(), H5PartWrapperForPT::writeHeader(), H5PartWrapperForPS::writeHeader(), and ParallelSliceTracker::writePhaseSpace().
| Random Options::rangen |
Random generator.
Definition at line 38 of file Options.cpp.
Referenced by Option::execute(), Expressions::gauss(), Expressions::ranf(), and Expressions::Tgauss().
| int Options::rebinFreq = 100 |
The frequency to reset energy bin ID for all particles.
Definition at line 69 of file Options.cpp.
Referenced by ParallelCyclotronTracker::bunchMode_m(), Option::execute(), ParallelCyclotronTracker::initializeTracking_m(), ParallelCyclotronTracker::MtsTracker(), and Option::Option().
| int Options::recycleBlocks = 0 |
RCG: number of recycle blocks.
Definition at line 82 of file Options.cpp.
Referenced by Option::execute(), and Option::Option().
| double Options::remotePartDel = 0.0 |
Definition at line 22 of file Options.cpp.
Referenced by PartBunchBase< T, Dim >::boundp_destroy(), Option::execute(), and Option::Option().
| int Options::repartFreq = 10 |
The frequency to do particles repartition for better load balance between nodes.
Definition at line 60 of file Options.cpp.
Referenced by Option::execute(), ParallelCyclotronTracker::initializeTracking_m(), ParallelCyclotronTracker::MtsTracker(), Option::Option(), ParallelCyclotronTracker::repartition(), and ParallelTTracker::setOptionalVariables().
| bool Options::rhoDump = false |
Definition at line 32 of file Options.cpp.
Referenced by Option::execute(), Option::Option(), H5PartWrapperForPT::writeHeader(), H5PartWrapperForPT::writeStepData(), and H5PartWrapperForPC::writeStepData().
| std::string Options::rngtype = std::string("RANDOM") |
random number generator
Definition at line 85 of file Options.cpp.
Referenced by Option::execute(), Distribution::generateFlattopT(), Distribution::generateFlattopZ(), Distribution::generateLongFlattopT(), Option::Option(), and Distribution::selectRandomGenerator().
| int Options::scSolveFreq = 1 |
The frequency to solve space charge fields.
Definition at line 72 of file Options.cpp.
Referenced by Option::execute(), ParallelCyclotronTracker::initializeTracking_m(), and Option::Option().
| int Options::seed = 123456789 |
The current random seed.
Definition at line 41 of file Options.cpp.
Referenced by CollimatorPhysics::CollimatorPhysics(), Distribution::create(), SampleCmd::execute(), Option::execute(), RNGXDiv::GetSeed(), Random::init55(), OpalSample::initialize(), Option::Option(), OpalSimulation::run(), RNGStream::setGlobalSeed(), RNGBitReverse::SetSeed(), and RNGRand::SetSeed().
| int Options::sptDumpFreq = 1 |
The frequency to dump single particle trajectory of particles with ID = 0 & 1.
Definition at line 57 of file Options.cpp.
Referenced by ParallelCyclotronTracker::bunchMode_m(), Option::execute(), ParallelCyclotronTracker::initializeTracking_m(), ParallelCyclotronTracker::MtsTracker(), Option::Option(), ParallelCyclotronTracker::seoMode_m(), and ParallelCyclotronTracker::singleMode_m().
| int Options::statDumpFreq = 10 |
The frequency to dump statistical values, e.e. dump data when stepstatDumpFreq==0.
Definition at line 54 of file Options.cpp.
Referenced by ThickTracker::dump_m(), ParallelSliceTracker::dumpStats(), Option::execute(), ParallelTTracker::execute(), Option::Option(), TrackRun::setupCyclotronTracker(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), ParallelCyclotronTracker::update_m(), and ParallelSliceTracker::writePhaseSpace().
| int Options::surfDumpFreq = -1 |
The frequency to dump the particle-geometry surface interation data.
Definition at line 78 of file Options.cpp.
Referenced by Option::execute(), and Option::Option().
| int Options::version = 10000 |
opal version of input file
Definition at line 97 of file Options.cpp.
Referenced by Option::execute(), TrackRun::execute(), and Option::Option().
| bool Options::warn = true |
Warn flag.
Definition at line 10 of file Options.cpp.
Referenced by Expressions::AbsMax(), VaryCmd::execute(), Option::execute(), ThreadBpm::execute(), ThreadAll::execute(), Micado::execute(), Survey::execute(), Twiss::execute(), Period::fill(), CmdArguments::getArg(), Edit::installMultiple(), Edit::installSingle(), Edit::invalidLine(), Edit::invalidShare(), Expressions::Maxa(), Expressions::Mina(), Edit::moveMultiple(), Edit::moveSingleAbs(), Edit::moveSingleRel(), Option::Option(), Edit::removeMultiple(), Edit::removeSingle(), Edit::replaceMultiple(), Edit::replaceSingle(), Expressions::Rmsa(), OpalSimulation::run(), and Selector::Selector().
| int Options::warnLevel = 1 |
Definition at line 11 of file Options.cpp.
Referenced by OpalSimulation::run().
| bool Options::writeBendTrajectories = false |
Definition at line 26 of file Options.cpp.
Referenced by Bend2D::calculateRefTrajectory(), Option::execute(), Bend2D::getOutline(), RBend3D::initialise(), and Option::Option().
1.8.5