|
OPAL (Object Oriented Parallel Accelerator Library)
2021.1.99
OPAL
|
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 | mtrace = false |
| Trace flag. More... | |
| bool | warn = true |
| Warn flag. More... | |
| int | warnLevel = 1 |
| Random | rangen |
| int | seed = 123456789 |
| The current random seed. More... | |
| 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... | |
| 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... | |
| 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 |
| double | remotePartDel = 0.0 |
| bool | rhoDump = false |
| bool | ebDump = false |
| bool | csrDump = false |
| int | autoPhase = 6 |
| 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... | |
| bool | cZero = false |
| If true create symmetric distribution. More... | |
| std::string | rngtype = std::string("RANDOM") |
| random number generator More... | |
| bool | enableHDF5 = true |
| If true HDF5 files are written. More... | |
| bool | enableVTK = true |
| If true VTK files are written. More... | |
| bool | asciidump = false |
| int | boundpDestroyFreq = 10 |
| double | beamHaloBoundary = 0 |
| bool | cloTuneOnly = false |
| Do closed orbit and tune calculation only. More... | |
| bool | idealized = false |
| bool | writeBendTrajectories = false |
| int | version = 10000 |
| opal version of input file More... | |
| bool | amr = false |
| Enable AMR if true. More... | |
| int | amrYtDumpFreq = 10 |
| The frequency to dump AMR grid data and particles into file. More... | |
| int | amrRegridFreq = 10 |
| After how many steps the AMR grid hierarchy is updated. More... | |
| 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... | |
| enum Options::DumpFrame |
| Enumerator | |
|---|---|
| GLOBAL | |
| BUNCH_MEAN | |
| REFERENCE | |
Definition at line 5 of file OptionTypes.h.
| 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().
| 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(), and Option::Option().
| 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(), Option::execute(), and Option::Option().
| bool Options::asciidump = false |
Definition at line 85 of file Options.cpp.
Referenced by BeamStrippingPhysics::BeamStrippingPhysics(), ParallelCyclotronTracker::execute(), Option::execute(), Degrader::initialise(), PluginElement::initialise(), Cyclotron::initialise(), FlexibleCollimator::initialise(), Monitor::initialise(), Source::initialise(), Option::Option(), and ScatteringPhysics::ScatteringPhysics().
| int Options::autoPhase = 6 |
Definition at line 69 of file Options.cpp.
Referenced by OrbitThreader::autophaseCavities(), Option::execute(), CavityAutophaser::optimizeCavityPhase(), and Option::Option().
| double Options::beamHaloBoundary = 0 |
Definition at line 89 of file Options.cpp.
Referenced by DataSink::dumpSDDS(), Option::execute(), and Option::Option().
| int Options::boundpDestroyFreq = 10 |
Definition at line 87 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 91 of file Options.cpp.
Referenced by Distribution::createMatchedGaussDistribution(), Option::execute(), and Option::Option().
| bool Options::csrDump = false |
Definition at line 67 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 77 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 109 of file Options.cpp.
Referenced by ParallelCyclotronTracker::deleteParticle(), Option::execute(), and Option::Option().
| bool Options::ebDump = false |
Definition at line 65 of file Options.cpp.
Referenced by Option::execute(), Option::Option(), FM3DDynamic::readMap(), H5PartWrapperForPC::writeHeader(), H5PartWrapperForPT::writeHeader(), H5PartWrapperForPC::writeStepData(), and H5PartWrapperForPT::writeStepData().
| bool Options::echo = false |
Echo flag.
Definition at line 26 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 81 of file Options.cpp.
Referenced by DataSink::changeH5Wrapper(), DataSink::DataSink(), DataSink::dumpH5(), Option::execute(), DataSink::init(), LossDataSink::LossDataSink(), Option::Option(), and DataSink::storeCavityInformation().
| 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(), and DataSink::writeGeomToVtk().
| 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(), and Option::Option().
| bool Options::idealized = false |
Definition at line 93 of file Options.cpp.
Referenced by OpalBeamline::compute3DLattice(), Option::execute(), and Option::Option().
| bool Options::info = true |
Info flag.
Definition at line 28 of file Options.cpp.
Referenced by AmrBoxLib::create(), OpalData::define(), Call::execute(), Option::execute(), Cyclotron::getFieldFromFile_AVFEQ(), Cyclotron::getFieldFromFile_Carbon(), Cyclotron::getFieldFromFile_FFA(), FM1DProfile2::getFieldstrength(), FieldSolver::initAmrObject_m(), AmrBoxLib::initParmParse_m(), MLPoissonSolver::mlmg_m(), matheval::detail::expectation_handler::operator()(), Option::Option(), UniformCartesian< Dim, MFLOAT >::print(), OpalSimulation::run(), Select::select(), DiscParticle::write(), DiscParticle::write_data(), AmrYtWriter::writeBunch(), and AmrYtWriter::writeParticles_m().
| int Options::infoLevel = 1 |
Definition at line 29 of file Options.cpp.
Referenced by IpplInfoWrapper::IpplInfoWrapper(), OpalSimulation::run(), and run_opal().
| bool Options::memoryDump = false |
Definition at line 105 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 51 of file Options.cpp.
Referenced by Option::execute(), 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 53 of file Options.cpp.
Referenced by Option::execute(), Option::Option(), and ParallelTTracker::setOptionalVariables().
| bool Options::mtrace = false |
Trace flag.
Definition at line 31 of file Options.cpp.
Referenced by Option::execute(), OpalParser::execute(), and Option::Option().
| int Options::mtsSubsteps = 1 |
Definition at line 59 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 75 of file Options.cpp.
Referenced by Option::execute(), MGPoissonSolver::MGPoissonSolver(), and Option::Option().
| int Options::numBlocks = 0 |
RCG: cycle length.
Definition at line 71 of file Options.cpp.
Referenced by Option::execute(), MGPoissonSolver::MGPoissonSolver(), and Option::Option().
| 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(), and ParallelCyclotronTracker::update_m().
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().
| 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(), ParallelTTracker::execute(), Option::execute(), Option::Option(), TrackRun::setupCyclotronTracker(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), ParallelCyclotronTracker::update_m(), H5PartWrapperForPC::writeHeader(), and H5PartWrapperForPT::writeHeader().
| Random Options::rangen |
Definition at line 36 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 55 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 73 of file Options.cpp.
Referenced by Option::execute(), MGPoissonSolver::MGPoissonSolver(), and Option::Option().
| 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(), and Option::Option().
| 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(), ParallelCyclotronTracker::repartition(), and ParallelTTracker::setOptionalVariables().
| bool Options::rhoDump = false |
Definition at line 63 of file Options.cpp.
Referenced by Option::execute(), Option::Option(), H5PartWrapperForPT::writeHeader(), H5PartWrapperForPC::writeStepData(), and H5PartWrapperForPT::writeStepData().
| 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(), and Distribution::selectRandomGenerator().
| 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().
| int Options::seed = 123456789 |
The current random seed.
Definition at line 37 of file Options.cpp.
Referenced by Undulator::apply(), Distribution::create(), Option::execute(), SampleCmd::execute(), LatinHyperCube::fillBins_m(), RNGStream::getInstance(), RNGXDiv::GetSeed(), Random::init55(), OpalSample::initialize(), Option::Option(), Random::Random(), Random::reseed(), OpalSimulation::run(), ScatteringPhysics::ScatteringPhysics(), RNGStream::setGlobalSeed(), RNGXDiv::SetSeed(), and RNGXDivSequence::SetSeed().
| 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(), 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 41 of file Options.cpp.
Referenced by ThickTracker::dump_m(), ParallelTTracker::execute(), Option::execute(), Option::Option(), TrackRun::setupCyclotronTracker(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), and ParallelCyclotronTracker::update_m().
| int Options::version = 10000 |
opal version of input file
Definition at line 97 of file Options.cpp.
Referenced by BOOST_FUSION_ADAPT_STRUCT(), Option::execute(), TrackRun::execute(), and Option::Option().
| bool Options::warn = true |
Warn flag.
Definition at line 33 of file Options.cpp.
Referenced by Expressions::AbsMax(), Option::execute(), CmdArguments::getArg(), Expressions::Maxa(), Expressions::Mina(), Option::Option(), Expressions::Rmsa(), OpalSimulation::run(), and Selector::Selector().
| int Options::warnLevel = 1 |
Definition at line 34 of file Options.cpp.
Referenced by IpplInfoWrapper::IpplInfoWrapper(), OpalSimulation::run(), and run_opal().
| bool Options::writeBendTrajectories = false |
Definition at line 95 of file Options.cpp.
Referenced by Bend2D::calculateRefTrajectory(), Option::execute(), Bend2D::getOutline(), RBend3D::initialise(), and Option::Option().
1.9.1