C++ API Reference#
Namespaces#
Classes and Structs#
- Class BaseBoundary2D
- Inheritance Relationships
- Class Documentation
BaseBoundary2DBaseBoundary2D()~BaseBoundary2D()getMaxX()getMinX()getMaxY()getMinY()addBoundaryPotential()getNumberOfPoints()getNumberOfModes()isInitialized()getBoundaryPointX()getBoundaryPointY()setBoundaryPoint()initializeBPs()getShapeName()getShapeType()isInside()NO_SHAPEIS_INSIDEIS_OUTSIDETO_BE_KILLEDPI_gaussjinv()lsq_fuctions()shape_shape_type_no_shape_key_xDim_yDim_initialized_xMin_xMax_yMin_yMax_nPoints_bArrX_bArrY_nModes_BPrnorm_bnd_phi_arr_lsq_func_vctr_lsq_coef_vctr_ipiv_tmpindxr_tmpindxc_tmpLSQ_matrix_tmp_matrix_
- Class Bunch
- Inheritance Relationships
- Class Documentation
BunchBunch()~Bunch()x()y()z()px()py()pz()dE()xp()yp()flag()coordPartArr()coordArr()ringwrap()addParticle()deleteParticleFast()recoverParticle()deleteParticle()compress()getMass()getClassicalRadius()getCharge()getMacroSize()getB_Rho()setMass()setCharge()setMacroSize()getSize()getSizeGlobal()getSizeGlobalFromMemory()getTotalCount()getCapacity()print()print()readBunchCoords()readBunchCoords()readParticleAttributesNames()readParticleAttributes()deleteAllParticles()addParticleAttributes()hasParticleAttributes()removeParticleAttributes()removeAllParticleAttributes()getParticleAttributes()getParticleAttributesNames()clearAllParticleAttributesAndMemorize()restoreAllParticleAttributesFromMemory()getSyncPart()getBunchAttributes()getBunchAttributeDouble()getBunchAttributeInt()setBunchAttribute()setBunchAttribute()getIntBunchAttributeNames()getDoubleBunchAttributeNames()initBunchAttributes()copyEmptyBunchTo()copyBunchTo()addParticlesTo()getMPI_Comm_Local()setMPI_Comm_Local()getMPI_Size()getMPI_Rank()init()arrAttrmasschargeclassicalRadiusenergymacroSizeForAllnDimnTotalSizenSizenNewnChunknChunkMinsizeGlobalarrFlagarrCoordneedOfCompressattrCntrMapattrCntrSizeMapattrCntrSizeattributesSizeattrCntrLowIndMapattrCntrUppIndMapattrCntrMapTempattrCntrVectbunchAttrsyncPartiMPIinirank_MPIsize_MPIpyComm_Localpy_wrapper
- Class BunchTwissAnalysis
- Inheritance Relationships
- Class Documentation
BunchTwissAnalysisBunchTwissAnalysis()~BunchTwissAnalysis()analyzeBunch()getCorrelation()getAverage()getGlobalCount()getGlobalMacrosize()getEffectiveEmittance()getEffectiveAlpha()getEffectiveBeta()getEffectiveGamma()getEmittance()getEmittanceNormalized()getAlpha()getBeta()getGamma()getDispersion()getDispersionDerivative()computeBunchMoments()getBunchMoment()
- Class FieldTracker
- Inheritance Relationships
- Class Documentation
FieldTrackerFieldTracker()trackBunch()BGrid3D()ParseGrid3D()initVars()nodeCalculator()setPathVariable()XGridYGridZGridBXGridBYGridBZGridBMagGridnXGridnYGridnZGridBxField3DByField3DBzField3DxField3DyField3DzField3D_length_xrefi_xreff_yrefi_yreff_eulerai_eulerbi_eulergi_euleraf_eulerbf_eulergf_zi_zf_ds_srefrmax_betaX_betaY_alphaX_alphaY_etaX_etaPXxFoilMinxFoilMaxyFoilMinyFoilMaxzFoilMinzFoilMaxdoRefPath_nitersrMaxfoilAngle_residsMaxgetPathBScalezsymmetry
- Class Grid1D
- Inheritance Relationships
- Class Documentation
Grid1DGrid1D()Grid1D()Grid1D()~Grid1D()setGridZ()getArr()getMinZ()getMaxZ()getSizeZ()getSum()getStepZ()getGridZ()isInside()setZero()multiply()setValue()getValueOnGrid()getValue()getValueSmoothed()binBunch()binBunch()binBunchSmoothed()binBunchSmoothed()binBunchByParticle()binBunchByParticle()binBunchSmoothedByParticle()binBunchSmoothedByParticle()binBunchMoment()binBunchSmoothedMoment()binValue()binValueSmoothed()binMoment()binMomentSmoothed()calcGradient()calcGradientSmoothed()synchronizeMPI()arr_zSize_dz_zMin_zMax_
- Class Grid2D
- Inheritance Relationships
- Class Documentation
Grid2DGrid2D()Grid2D()~Grid2D()setZero()getArr()getValue()getValueOnGrid()setValue()binBunch()binBunch()binValue()binBunchBilinear()binBunchBilinear()binValueBilinear()calcGradient()calcGradient()calcGradientBilinear()interpolateBilinear()getSizeX()getSizeY()synchronizeMPI()isInside()getIndAndFracX()getIndAndFracY()getBilinearIndAndFracX()getBilinearIndAndFracY()getGridX()getGridY()getStepX()getStepY()getMaxX()getMinX()getSum()getMaxY()getMinY()multiply()setGridX()setGridY()arr_xSize_ySize_dx_dy_xMin_xMax_yMin_yMax_
- Class Grid3D
- Inheritance Relationships
- Class Documentation
Grid3DGrid3D()~Grid3D()getArr3D()getSlice2D()getGrid2D()getSizeX()getSizeY()getSizeZ()getGridX()getGridY()getGridZ()getStepX()getStepY()getStepZ()getMaxX()getMinX()getMaxY()getMinY()getMaxZ()getMinZ()setGridX()setGridY()setGridZ()getValueOnGrid()setValue()setZero()multiply()setLongWrapping()getLongWrapping()binBunch()binBunch()binBunchSlice2D()binValueSlice2D()binValue()calcGradient()getValue()getSum()getSliceSum()getSliceSum()synchronizeMPI()calcValueOnX()calcValueOnY()calcSheetGradient()getIndAndFracX()getIndAndFracY()getGridIndAndFrac()Arr3Dgrid2dArrnZ_nX_nY_xMin_xMax_yMin_yMax_zMin_zMax_dx_dy_dz_longWrapping
- Class Function
- Inheritance Relationships
- Class Documentation
OrbitUtils::FunctionFunction()~Function()setStepEps()getStepEps()add()add()updatePoint()updatePoint()removePoint()getSize()x()y()err()xArr()yArr()errArr()getMinX()getMinY()getMaxX()getMaxY()clean()cleanMemory()getY()getYP()getYErr()getX()setConstStep()isStepConst()setInverse()print()print()normalize()
- Class PoissonSolver3D
- Inheritance Relationships
- Class Documentation
PoissonSolver3DPoissonSolver3D()PoissonSolver3D()~PoissonSolver3D()getSizeX()getSizeY()getSizeZ()getMaxX()getMinX()getMaxY()getMinY()getMaxZ()getMinZ()getStepX()getStepY()getStepZ()setGridX()setGridY()setGridZ()findPotential()checkSizes()init()xSize_ySize_zSize_xMin_xMax_yMin_yMax_zMin_zMax_dx_dy_dz_
- Class PoissonSolverFFT3D
- Inheritance Relationships
- Class Documentation
PoissonSolverFFT3DPoissonSolverFFT3D()PoissonSolverFFT3D()~PoissonSolverFFT3D()setNumberOfExternalBunches()setSpacingOfExternalBunches()getNumberOfExternalBunches()getSpacingOfExternalBunches()setGridX()setGridY()setGridZ()setGridXYZ()updateGreenFunction()findPotential()init()_defineGreenF()xSize2_ySize2_zSize2_greensF_in_in_res_out_green_out_out_res_planForward_greenF_planForward_planBackward_nBunches_lambda_
- Class SpaceChargeCalc3D
- Inheritance Relationships
- Class Documentation
SpaceChargeCalc3DSpaceChargeCalc3D()~SpaceChargeCalc3D()trackBunch()getRhoGrid()getPhiGrid()setRatioLimit()getRatioLimit()setNumberOfExternalBunches()setFrequencyOfBunches()getNumberOfExternalBunches()getFrequencyOfBunches()poissonSolverrhoGridphiGridbunchExtremaCalcxy_ratioxz_ratioratio_limitnBunches_frequency_
- Class SpaceChargeCalcUnifEllipse
- Inheritance Relationships
- Class Documentation
SpaceChargeCalcUnifEllipseSpaceChargeCalcUnifEllipse()~SpaceChargeCalcUnifEllipse()trackBunch()bunchAnalysis()calculateField()getEllipsFieldCalculator()getNEllipses()nEllipsestotal_macrosizex_centery_centerz_centerx2_avgy2_avgz2_avgxMinxMaxyMinyMaxzMinzMaxa_ellipsb_ellipsc_ellipsa2_ellipsb2_ellipsc2_ellipsellipsoidCalc_arrmacroSizesEll_arrmacroSizesEll_MPI_arr
- Class SuperFishFieldSource
- Inheritance Relationships
- Class Documentation
SuperFishFieldSourceSuperFishFieldSource()~SuperFishFieldSource()getElectricMagneticField()setPhase()getPhase()setFieldCenterPos()getFieldCenterPos()setFrequency()getFrequency()setAmplitude()getAmplitude()getAvgField()getLength()setDirectionZ()getDirectionZ()setSymmetry()getSymmetry()getTimeInit()setTimeInit()getGrid2D_Ez()getGrid2D_Er()getGrid2D_H()setGrid2D_Fields()
- Class SyncPart
- Class Documentation
SyncPart~SyncPart()setPyWrapper()getPyWrapper()getEnergy()getMass()setTime()getTime()setXYZ()setXYZ()setX()setY()setZ()getX()getY()getZ()setPXYZ()setPXYZ()setPX()setPY()setPZ()setMomentum()getPX()getPY()getPZ()getMomentum()setNormalX()getNormalXX()getNormalXY()getNormalXZ()getNormalYX()getNormalYY()getNormalYZ()getBeta()getGamma()momentumToEnergy()energyToMomentum()init()
- Class Documentation
- Class TImpedance
- Inheritance Relationships
- Class Documentation
TImpedanceTImpedance()~TImpedance()assignLatFuncs()assignImpedanceX()assignImpedanceY()trackBunch()_prepareToKick()_kick()_length_nMacrosMin_nBins_useX_useY_qX_alphaX_betaX_qY_alphaY_betaY_charge2TKick_TurnszGridbunchExtremaCalc_xCentroid_xpCentroid_yCentroid_ypCentroid_phiCount_zXImped_nplus_zXImped_nminus_zYImped_nplus_zYImped_nminus_FFTResult1_FFTResult2_q_alpha_beta_Centroid_pCentroid_zImped_nplus_zImped_nminus_in_out_plan
- Class RungeKuttaTracker
- Inheritance Relationships
- Class Documentation
TrackerRK4::RungeKuttaTrackerRungeKuttaTracker()~RungeKuttaTracker()setSpatialEps()getSpatialEps()getTimeStep()setInitialStepsNumber()getInitialStepsNumber()getStepsNumber()setLength()getLength()setEntrPlane()setExitPlane()getEntrPlane()getExitPlane()trackBunch()track()isOutside()isOutside()isAfterEntrance()isAfterEntrance()isBeforeExit()isBeforeExit()