Module simpa.acc

Package simpa.acc.api

Class EllipseBeam

java.lang.Object

simpa.acc.api.Beam

simpa.acc.api.EllipseBeam

public class EllipseBeam
extends Beam

Special beam mainly for optics calculations. All particles lie on the same phase space ellipse.

Author:

lbojtar

Constructor Summary

Constructors

Constructor	Description
EllipseBeam(List<Particle> particles, ReferenceOrbit refOrbit, PotentialProvider potProvider, String name)
EllipseBeam(EllipseBeamSampler beamSampler, double nomMomentum, ReferenceOrbit refOrbit, double longiPos, PotentialProvider potProvider, double mass, double charge, int nbOfSamples, String name)

Method Summary

Modifier and Type	Method	Description
Beam	copy(Beam b, PotentialProvider pp)
EllipseBeamSampler	getBeamSampler()

Methods inherited from class simpa.acc.api.Beam

calculateBeamPosition, getName, getNominalMomentum, getParticles, getPotentialProvider, getReferenceOrbit, setName, setReferenceOrbit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EllipseBeam

public EllipseBeam(EllipseBeamSampler beamSampler,
 double nomMomentum,
 ReferenceOrbit refOrbit,
 double longiPos,
 PotentialProvider potProvider,
 double mass,
 double charge,
 int nbOfSamples,
 String name)
            throws KnownFatalException

Throws:

KnownFatalException

EllipseBeam

public EllipseBeam(List<Particle> particles,
 ReferenceOrbit refOrbit,
 PotentialProvider potProvider,
 String name)

Method Details

copy

public Beam copy(Beam b,
 PotentialProvider pp)

Overrides:

copy in class Beam

Returns:

A Deep copy of of all particles in the beam, but the tracking state is freshly created. The vector potential of the copy will be the potential provider. The beam sampler is shallow copied. This method is tipically used to create a new beam with the same particles for new tracking with a different potential provider.

getBeamSampler

public EllipseBeamSampler getBeamSampler()

Returns:

The beam sampler used to generate the particles in the beam. It might be null if the beam was created from a list of particles and nor using the constructor with the beam sampler.