SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Private Attributes
Transport Class Reference

Performs the linear transport of a beam through beam line elements. More...

#include <Transport.hh>

Public Member Functions

 Transport ()
 Default constructor, initilizes everything to 0. More...
 
 Transport (const size_t dim)
 Dimensional constructor, sets the dimension of the space. More...
 
 Transport (const Transport &transport)
 Copy constructor. More...
 
Transport & operator= (const Transport &transport)
 Equality operator. More...
 
 ~Transport ()
 Destructor. More...
 
void TransportParticle (Matrix< double > &particle)
 Performs the Transport on a particle. More...
 
void TransportBunch (std::map< std::string, std::vector< double >> &beam)
 Performs the transport on a beam of particles. More...
 
void AddDriftSpace (const double &L, const double &p)
 Adds a drift space to the chain of transport. More...
 
void AddSolenoid (const double &L, const double &K)
 Adds a constant solenoid to the chain of transport. More...
 
void AddSolenoidNL (const double &L, const double &K)
 Adds a constant non-linear solenoid to the chain of transport. More...
 
const Matrix< double > & TransferMatrix () const
 Gets the total transfer matrix resulting from the. More...
 

Private Attributes

size_t _dim
 Dimension of the space. More...
 
Matrix< double > _M
 Transfer matrix. More...
 
std::vector< Matrix< double > > _T
 Second order transfer 3-tensor. More...
 

Detailed Description

Performs the linear transport of a beam through beam line elements.

First build the object by providing it with the dimensionality of the space to transport, then add elements to the beam line*

The transport is operated by applying transfer matrices in succession:

Constructor & Destructor Documentation

Transport::Transport ( )

Default constructor, initilizes everything to 0.

Transport::Transport ( const size_t  dim)

Dimensional constructor, sets the dimension of the space.

Parameters
dimDimension of the space
Transport::Transport ( const Transport &  transport)

Copy constructor.

Transport::~Transport ( )

Destructor.

Member Function Documentation

void Transport::AddDriftSpace ( const double &  L,
const double &  p 
)

Adds a drift space to the chain of transport.

Parameters
LLength of the drift space
pNominal longitudinal momentum
void Transport::AddSolenoid ( const double &  L,
const double &  K 
)

Adds a constant solenoid to the chain of transport.

Parameters
LLength of the drift space
KRatio B_0/(2Brho_0) of the nominal field of the magnetic rigity of the ref.
void Transport::AddSolenoidNL ( const double &  L,
const double &  K 
)

Adds a constant non-linear solenoid to the chain of transport.

Parameters
LLength of the drift space
KRatio B_0/(2Brho_0) of the nominal field of the magnetic rigity of the ref.
Transport & Transport::operator= ( const Transport &  transport)

Equality operator.

const Matrix<double>& Transport::TransferMatrix ( ) const
inline

Gets the total transfer matrix resulting from the.

Returns
Transfer matrix M
void Transport::TransportBunch ( std::map< std::string, std::vector< double >> &  beam)

Performs the transport on a beam of particles.

Parameters
beamInput beam: x, (y), px, (py), pz [mm, MeV/c]
void Transport::TransportParticle ( Matrix< double > &  particle)

Performs the Transport on a particle.

Parameters
particleInput particle: x, (y), px, (py), pz [mm, MeV/c]

Field Documentation

size_t Transport::_dim
private

Dimension of the space.

Matrix<double> Transport::_M
private

Transfer matrix.

std::vector<Matrix<double> > Transport::_T
private

Second order transfer 3-tensor.


The documentation for this class was generated from the following files: