Uses of Class
xal.tools.math.r3.R3

Packages that use R3
Package
Description
xal.model.elem
Modeling Elements Package Library
xal.model.probe
 
xal.model.probe.traj
 
xal.tools.beam
Contains classes for representing particle beams and various aspects and properties of particle beams.
xal.tools.beam.calc
xal.tools.beam.em
 
xal.tools.beam.ens
 
xal.tools.math.r3
 

  • Uses of R3 in xal.model.elem

    Methods in xal.model.elem with parameters of type R3
    Modifier and Type
    Method
    Description
    void
    Element.setAlign(R3 vecAlign)
    Set the alignment parameters all at once.
    void
    ElementSeq.setAlign(R3 vecAlign)
    Set the alignment parameters all at once.

  • Uses of R3 in xal.model.probe

    Methods in xal.model.probe that return R3
    Modifier and Type
    Method
    Description
    R3
    EnsembleProbe.electricField(R3 ptFld)
    Get the electric field at a point in R3 from the ensemble.
    R3
    TwissProbe.getBetatronPhase()
    Returns the betatron phase with space charge for all three phase planes.
    Methods in xal.model.probe with parameters of type R3
    Modifier and Type
    Method
    Description
    R3
    EnsembleProbe.electricField(R3 ptFld)
    Get the electric field at a point in R3 from the ensemble.
    void
    TwissProbe.setBetatronPhase(R3 vecPhase)
    Set the betatron phase for each phase plane.

  • Uses of R3 in xal.model.probe.traj

    Methods in xal.model.probe.traj that return R3
    Modifier and Type
    Method
    Description
    R3
    EnsembleProbeState.electricField(R3 ptFld)
    Get the electric field at a point in R3 from the ensemble.
    R3
    TwissProbeState.getBetatronPhase()
    Returns the betatron phase with space charge for all three phase planes.
    Methods in xal.model.probe.traj with parameters of type R3
    Modifier and Type
    Method
    Description
    R3
    EnsembleProbeState.electricField(R3 ptFld)
    Get the electric field at a point in R3 from the ensemble.
    void
    TwissProbeState.setBetatronPhase(R3 vecPhase)
    Set the betatron phase with space charge for each phase plane.

  • Uses of R3 in xal.tools.beam

    Methods in xal.tools.beam that return R3
    Modifier and Type
    Method
    Description
    R3
    PhaseVector.getMomentum()
    Get momentum coordinate in R3.
    R3
    PhaseVector.getPosition()
    Get position coordinates in R3.
    Methods in xal.tools.beam with parameters of type R3
    Modifier and Type
    Method
    Description
    static PhaseMatrix
    PhaseMatrix.spatialTranslation(R3 vecDispl)
    Create a phase matrix representing a linear translation operator on homogeneous phase space that only affects the spatial coordinates.
    Constructors in xal.tools.beam with parameters of type R3
    Modifier
    Constructor
    Description
     
    PhaseVector(R3 vecPos, R3 vecMom)
    Create a new instance of PhaseVector with specified initial value.

  • Uses of R3 in xal.tools.beam.calc

    Methods in xal.tools.beam.calc that return R3
    Modifier and Type
    Method
    Description
    protected R3
    CalculationEngine.calculatePhaseAdvance(PhaseMatrix matPhi, Twiss[] twsInit, Twiss[] twsFinal)
    Taken from TransferMapState.
    protected R3
    CalculationEngine.calculatePhaseAdvPerCell(PhaseMatrix matPhiCell)
    Taken from TransferMapTrajectory.
    protected R3
    CalculationEngine.calculateTunePerCell(PhaseMatrix matPhiCell)
    Taken from TransferMapTrajectory.
    R3
    CalculationsOnBeams.computeBetatronPhase(EnvelopeProbeState state)
    Computes and returns the "betatron phase" of a beam particle within the simulated envelope at the given state location.
    R3
    CalculationsOnMachines.computeBetatronPhase(TransferMapState state)
    This is the phase advance for the given state location.
    R3
    ISimulationResults.ISimEnvResults.computeBetatronPhase(S state)
    Get the betatron phase values at the given state location for all three phase planes.
    R3
    SimResultsAdaptor.computeBetatronPhase(ProbeState<?> state)
     
    R3
    CalculationsOnRings.computeFractionalTunes()
    Calculates the fractional phase tune for the ring from its one-turn matrix.
    R3
    CalculationsOnRings.computeFullTunes()
    Calculates and returns the full tune around the ring including the integer portion.
    R3
    CalculationsOnRings.computePhaseAdvanceBetween(TransferMapState state1, TransferMapState state2)
    Computes the phase advances between the given state locations for each phase plane.
    R3
    CalculationsOnBeams.periodBetatronPhaseAdvance()
    Returns the betatron phase advances from the simulation beginning to end (which are computed at instantiation).
    R3
    CalculationsOnParticles.periodBetatronPhaseAdvance()
    Returns the betatron phase advances from the simulation beginning to end (which are computed at instantiation).
    R3
    CalculationsOnRings.ringBetatronPhaseAdvance()
    Returns the betatron phase advances for the ring entrance (which are computed at instantiation).

  • Uses of R3 in xal.tools.beam.em

    Constructors in xal.tools.beam.em with parameters of type R3
    Modifier
    Constructor
    Description
     
    BeamEllipsoid(double dblGamma, R3 vec1stMmts, R3 vec2ndMmts)
    Construct a beam charge density ellipsoid where the second spatial moments and axial displacement are given directly.

  • Uses of R3 in xal.tools.beam.ens

    Methods in xal.tools.beam.ens that return R3
    Modifier and Type
    Method
    Description
    R3
    Particle.electricField(R3 ptFld)
    Computes the Coulomb electric field of the particle at the given field point.
    R3
    Particle.electricField(R3 ptFld, double radius)
    Computes electric field assuming the particle is an uniform sphere of charge with radius R.
    R3
    Particle.getMomentum()
    Get the velocity vector of the particle
    R3
    Particle.getPosition()
    Get the position vector of the particle
    R3
    Particle.magneticField(R3 ptFld)
    Computes magnetic field assuming the particle is an uniform sphere of charge with radius R.
    R3
    Particle.magneticField(R3 ptFld, double radius)
    Computes magnetic field assuming the particle is an uniform sphere of charge with radius R.
    R3
    Ensemble.totalCurrent()
    Get the total current of the ensemble.
    Methods in xal.tools.beam.ens with parameters of type R3
    Modifier and Type
    Method
    Description
    R3
    Particle.electricField(R3 ptFld)
    Computes the Coulomb electric field of the particle at the given field point.
    R3
    Particle.electricField(R3 ptFld, double radius)
    Computes electric field assuming the particle is an uniform sphere of charge with radius R.
    double
    Particle.electricPotential(R3 ptFld)
    Computes the Coulomb potential of the particle at the given field point.
    double
    Particle.electricPotential(R3 ptFld, double radius)
    Computes electric potential assuming the particle was an uniform sphere of charge with radius R.
    R3
    Particle.magneticField(R3 ptFld)
    Computes magnetic field assuming the particle is an uniform sphere of charge with radius R.
    R3
    Particle.magneticField(R3 ptFld, double radius)
    Computes magnetic field assuming the particle is an uniform sphere of charge with radius R.
    double
    Ensemble.potentialQuadExpansion(R3 pt, double q, PhaseMatrix matSigma)
    Computes the electric potential from a quadrupole multipole expansion.
    double
    Ensemble.potentialSummation(R3 ptFld)
    Computes the Coulomb potential of the ensemble at the given field point.

  • Uses of R3 in xal.tools.math.r3

    Methods in xal.tools.math.r3 that return R3
    Modifier and Type
    Method
    Description
    R3
    R3.cartesian2Cylindrical()
    Apply coordinate transform from cartesian to cylindrical coordinates.
    R3
    R3.cartesian2Spherical()
    Apply coordinate transform from cartesian to spherical coordinates.
    R3
    ClosedBox.centroid()
    Compute the centroid of the domain
    R3
    R3.clone()
    Creates and returns a deep copy of this vector.
    R3
    Grid.compPtCoords(int i, int j, int k)
    Return the coordinates in R3 of the grid point at index (i,j,k)
    R3
    Grid.compPtCoords(Z3 vecIndex)
    Return the coordinates in R3 of the grid point at index (i,j,k)
    R3
    R3.copy()
    Performs a deep copy operation.
    R3
    R3.cylindrical2Cartesian()
    Apply coordinate transform from cylindrical to cartesian coordinates
    R3
    ClosedBox.dimensions()
    Compute the dimensions of the domain
    R3
    PoissonGrid.fieldCartesian(R3 pt)
    Compute and return the field in cartesian coordinates at point pt as generated by the potential values on the grid.
    R3
    PoissonGrid.fieldCylindrical(R3 pt)
    Compute and return the field in cylindrical coordinates at point pt as generated by the potential values on the grid.
    R3
    PoissonGrid.fieldSpherical(R3 pt)
    Compute and return the field in spherical coordinates at point pt as generated by the potential values on the grid.
    R3
    Sphere.getCentroid()
    Get the centroid of the sphere
    R3
    Grid.getGridOrigin()
    Get the coordinates of the grid origin, i.e., the first grid vertex.
    R3
    Grid.getGridResolution()
    Get grid resolution.
    R3
    ClosedBox.getVertexMax()
    Get the maximum vertex
    R3
    ClosedBox.getVertexMin()
    Get the minimum vertex
    R3
    Grid.interpolateGradient(R3 pt)
    Compute and return the interpolated function gradient at the point pt.
    protected R3
    R3.newInstance(double[] arrVecInt)
     
    protected R3
    R3.newInstance(int size)
    Handles object creation required by the base class.
    static R3
    R3.parse(String strTokens)
    Create a new instance of R3 with initial value determined by the formatted string argument.
    R3
    R3.spherical2Cartesian()
    Apply coordinate tranform from spherical to cartesian coordinates
    R3
    R3.squared()
    Returns the vector of squared elements.
    R3
    R3.times(R3 r)
    Vector multiplication using three-dimensional cross product.
    R3
    R3x3.times(R3 vec)
    Nondestructive Matrix-Vector multiplication.
    static R3
    R3.zero()
    Create a new instance of the zero vector.
    Methods in xal.tools.math.r3 with parameters of type R3
    Modifier and Type
    Method
    Description
    boolean
    ClosedBox.boundary(R3 pt)
    Determine whether or not point pt is member of the boundary of this set.
    boolean
    Sphere.boundary(R3 pt)
    Determine whether a point is a boundary element of the sphere
    xal.tools.math.r3.Grid.GridCell
    Grid.compCellContaining(R3 pt)
    Return the grid cell containing this point.
    Z3
    Grid.compCellIndex(R3 pt)
    Compute the base vertex index of grid cell containing this point.
    R3
    PoissonGrid.fieldCartesian(R3 pt)
    Compute and return the field in cartesian coordinates at point pt as generated by the potential values on the grid.
    R3
    PoissonGrid.fieldCylindrical(R3 pt)
    Compute and return the field in cylindrical coordinates at point pt as generated by the potential values on the grid.
    R3
    PoissonGrid.fieldSpherical(R3 pt)
    Compute and return the field in spherical coordinates at point pt as generated by the potential values on the grid.
    R3
    Grid.interpolateGradient(R3 pt)
    Compute and return the interpolated function gradient at the point pt.
    double
    Grid.interpolateValue(R3 pt)
    Compute and return the interpolated function value at the point pt
    boolean
    ClosedBox.membership(R3 pt)
    Determine whether point pt is an element of the domain.
    boolean
    Sphere.membership(R3 pt)
    Determine whether a point is an element of the sphere
    boolean
    Grid.membershipGrid(R3 pt)
    Determine whether a point is an element of the domain of definition for this grid.
    double
    PoissonGrid.potential(R3 pt)
    Compute and return interpolated potential at a point pt within grid definition.
    R3
    R3.times(R3 r)
    Vector multiplication using three-dimensional cross product.
    R3
    R3x3.times(R3 vec)
    Nondestructive Matrix-Vector multiplication.
    Constructors in xal.tools.math.r3 with parameters of type R3
    Modifier
    Constructor
    Description
     
    R3(R3 vecPt)
    Creates a new instance of R3 initialized to argument.
     
    Sphere(R3 ptOrg, double dblRad)
    Creates a new instance of SphereR3 initialized to the arguments.