#include <Magnet.h>

Inheritance diagram for FPTracker::Magnet:

Collaboration diagram for FPTracker::Magnet:

Public Types
enum	Type { hbDipole, hfQuadrupole, vfQuadrupole, vbDipole, notAMagnet }

typedef std::shared_ptr< Magnet >	Ptr_t

typedef std::vector< Ptr_t >	Container_t

typedef std::shared_ptr< const IBeamElement >	ConstPtr_t

typedef Container_t::iterator	Iter_t

typedef Container_t::const_iterator	ConstIter_t

typedef std::list< Ptr_t >	List_t

typedef List_t::iterator	ListIter_t

typedef List_t::const_iterator	ConstListIter_t

Public Member Functions
	Magnet (double x, double y, double center, double strength, double length, int apertype, double aper_A1, double aper_A2, double aper_A3, double aper_A4, double xb, Side side, IBender::ConstPtr_t bender, const std::string &label)

double	frontFace () const

double	rearFace () const

double	zabspos () const

double	zsignedpos () const

double	centerZ () const

Point	position () const

Side	side () const

bool	isEndElement () const

std::string	str () const

std::string	label () const

void	track (IParticle &) const

void	calibrate (IParticle &)

IBeamElement::ConstPtr_t	clone () const

Private Member Functions
bool	isOutOfAperture (IParticle &) const

double	frontface () const

void	swap (Magnet &)

Private Attributes
Point	m_center

double	m_frontFace

double	m_rearFace

double	m_strength

int	m_apertype

double	m_aper_A1

double	m_aper_A2

double	m_aper_A3

double	m_aper_A4

double	m_xb

Side	m_side

IBender::ConstPtr_t	m_bender

std::string	m_label

Detailed Description

Definition at line 20 of file FPTracker/FPTracker/Magnet.h.

Member Typedef Documentation

◆ ConstIter_t

typedef Container_t::const_iterator FPTracker::IBeamElement::ConstIter_t

inherited

Definition at line 45 of file FPTracker/FPTracker/IBeamElement.h.

◆ ConstListIter_t

typedef List_t::const_iterator FPTracker::IBeamElement::ConstListIter_t

inherited

Definition at line 49 of file FPTracker/FPTracker/IBeamElement.h.

◆ ConstPtr_t

typedef std::shared_ptr< const IBeamElement > FPTracker::IBeamElement::ConstPtr_t

inherited

Definition at line 40 of file FPTracker/FPTracker/IBeamElement.h.

◆ Container_t

typedef std::vector< Ptr_t > FPTracker::Magnet::Container_t

Definition at line 62 of file FPTracker/FPTracker/Magnet.h.

◆ Iter_t

typedef Container_t::iterator FPTracker::IBeamElement::Iter_t

inherited

Definition at line 44 of file FPTracker/FPTracker/IBeamElement.h.

◆ List_t

typedef std::list< Ptr_t > FPTracker::IBeamElement::List_t

inherited

Definition at line 47 of file FPTracker/FPTracker/IBeamElement.h.

◆ ListIter_t

typedef List_t::iterator FPTracker::IBeamElement::ListIter_t

inherited

Definition at line 48 of file FPTracker/FPTracker/IBeamElement.h.

◆ Ptr_t

typedef std::shared_ptr< Magnet > FPTracker::Magnet::Ptr_t

Definition at line 61 of file FPTracker/FPTracker/Magnet.h.

Member Enumeration Documentation

◆ Type

enum FPTracker::Magnet::Type

Enumerator
hbDipole
hfQuadrupole
vfQuadrupole
vbDipole
notAMagnet

Definition at line 64 of file FPTracker/FPTracker/Magnet.h.

64 {hbDipole, hfQuadrupole, vfQuadrupole, vbDipole, notAMagnet};

Constructor & Destructor Documentation

◆ Magnet()

FPTracker::Magnet::Magnet	(	double	x,
		double	y,
		double	center,
		double	strength,
		double	length,
		int	apertype,
		double	aper_A1,
		double	aper_A2,
		double	aper_A3,
		double	aper_A4,
		double	xb,
		Side	side,
		IBender::ConstPtr_t	bender,
		const std::string &	label
	)

Definition at line 20 of file FPTracker/src/Magnet.cxx.

                                 :
     m_center(x, y, center),
     m_frontFace(center>0 ? center-0.5*length:center+0.5*length),
     m_rearFace(center>0 ? center+0.5*length:center-0.5*length),
     m_strength(strength),
     m_apertype(apertype),
     m_aper_A1(aper_A1),
     m_aper_A2(aper_A2),
     m_aper_A3(aper_A3),
     m_aper_A4(aper_A4),
     m_xb(xb),
     m_side(side),
     m_bender(bender),
     m_label(label){
     if (m_apertype == 1){ assert(m_aper_A1 != 0.);}
     if (m_apertype == 2 || m_apertype == 3){ assert(m_aper_A3 != 0. and  m_aper_A4 != 0.);}
   }

Member Function Documentation

◆ calibrate()

void FPTracker::Magnet::calibrate ( IParticle & particle )

virtual

Implements FPTracker::IBeamElement.

Definition at line 99 of file FPTracker/src/Magnet.cxx.

   {
     return this->track(particle);
   }

◆ centerZ()

double FPTracker::Magnet::centerZ ( ) const

◆ clone()

IBeamElement::ConstPtr_t FPTracker::Magnet::clone ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 51 of file FPTracker/src/Magnet.cxx.

                                             {
     IBeamElement::ConstPtr_t pm(new Magnet(*this));
     return pm;
   }

◆ frontFace()

double FPTracker::Magnet::frontFace ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 56 of file FPTracker/src/Magnet.cxx.

56 {return m_frontFace;}

◆ frontface()

double FPTracker::Magnet::frontface ( ) const

private

◆ isEndElement()

bool FPTracker::Magnet::isEndElement ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 63 of file FPTracker/src/Magnet.cxx.

63 {return false;}

◆ isOutOfAperture()

bool FPTracker::Magnet::isOutOfAperture ( IParticle & particle ) const

private

Definition at line 104 of file FPTracker/src/Magnet.cxx.

                                                        {
  
     TransversePoint offCenter = particle.displacement();
     if(m_apertype == 1)
       { 
     
     double radius  = m_aper_A1;
     bool out =  offCenter.mag2() > radius*radius; 
     
     if(out)
       {
         std::ostringstream ost;
         ost<<"pos "<<offCenter.mag2()<<" radiusSq "<<radius*radius<<'\n';
         particle.addMsg( ost.str() );
         return true;
       }
     
     return false;
       }
  
     if(m_apertype == 2) 
       {
     double part_x = offCenter.x(); 
     double part_y = offCenter.y(); 
     
     double xx = part_x/m_aper_A3;
     double yy = part_y/m_aper_A4;
     
     bool out  =  xx*xx + yy*yy >1.;
     if(out)
       {
         std::ostringstream ost;
         ost<<"outside for aperture type 2 x xx, xaper "<<part_x<<" "<<xx<<" "<<m_aper_A3<<" y yy yaper "<<part_y<<" "<<yy<<" "<<m_aper_A4<<'\n';
         particle.addMsg( ost.str() );
         return true;
       }
     
     
     if ( m_aper_A1>0.)
       {
         if( std::fabs(part_x)>m_aper_A1 )
           {
         std::ostringstream ost;
         ost<<"outside for aperture type 2 x test: particle x  "<<part_x<<" m_aper_A1 "<<m_aper_A1<<"\n";
         particle.addMsg( ost.str() );
         return true;
           }
       }
     if ( m_aper_A2>0.)
       {
         if( std::fabs(part_y)>m_aper_A2)
           {
         std::ostringstream ost;
         ost<<"outside for aperture type 2 y test: particle y  "<<part_y<<" m_aper_A2 "<<m_aper_A2<<"\n";
         particle.addMsg( ost.str() );
         return true;
           }
       }
      
     return false;
       }
     if(m_apertype == 3) 
       {
     double part_x = offCenter.x(); 
     double part_y = offCenter.y(); 
     
     if ( m_aper_A1 > 0. )
       {
         if( std::fabs(part_x)>m_aper_A1 )
           {
         std::ostringstream ost;
         ost<<"outside for aperture type 3 x test: particle x  "<<part_x<<" m_aper_A1 "<<m_aper_A1<<"\n";
         particle.addMsg( ost.str() );
         return true;
           }
       }
     if ( m_aper_A2 > 0. )
       {
         if( std::fabs(part_y)>m_aper_A2)
           {
         std::ostringstream ost;
         ost<<"outside for aperture type 3 y test: particle y  "<<part_y<<" m_aper_A2 "<<m_aper_A2<<"\n";
         particle.addMsg( ost.str() );
         return true;
           }
       }
     if ( m_aper_A3 > 0. && m_aper_A4 > 0. )
       {
         float B3=std::tan(m_aper_A3)*m_aper_A1;
         float B4=m_aper_A2/std::tan(m_aper_A4);
         float d=(m_aper_A1-std::fabs(part_x))/(m_aper_A1-B4)+(m_aper_A2-std::fabs(part_y))/(m_aper_A2-B3);
         
         if(d<1.)
         {
           std::ostringstream ost;
           ost<<"outside for aperture type 3 test: particle x  "<<part_x<<" particle y  "<<part_y<<"; m_aper_A1 "<<m_aper_A1<<"  m_aper_A2 "<<m_aper_A2<<"  m_aper_A3 "<<m_aper_A3<<"  m_aper_A4 "<<m_aper_A4<<"\n";
           particle.addMsg( ost.str() );
           return true;
         }
       }
      
     return false;
       }
     
     // aperture is checked anly if aperture type i s 1, 2, or 3
     return false;
   }

◆ label()

std::string FPTracker::Magnet::label ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 16 of file FPTracker/src/Magnet.cxx.

                                {
     return m_label+":"+m_bender->label();
   }

◆ position()

Point FPTracker::Magnet::position ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 60 of file FPTracker/src/Magnet.cxx.

60 {return m_center;}

◆ rearFace()

double FPTracker::Magnet::rearFace ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 57 of file FPTracker/src/Magnet.cxx.

57 {return m_rearFace;}

◆ side()

Side FPTracker::Magnet::side ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 61 of file FPTracker/src/Magnet.cxx.

61 {return m_side;}

◆ str()

std::string FPTracker::Magnet::str ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 213 of file FPTracker/src/Magnet.cxx.

                               {
     std::ostringstream ost;
     ost <<" \n\n-- Magnet  --\n"
     << "label      "  << m_label     <<'\n'
     << "center     "  << m_center    <<'\n'
     << "frontFace  "  << m_frontFace <<'\n'
     << "rearFace   "  << m_rearFace  <<'\n'
     << "m_strength "  << m_strength  <<'\n'
     << "m_apertyp  "  << m_apertype  <<'\n'
     << "m_aper_A1  "  << m_aper_A1   <<'\n'
     << "m_aper_A2  "  << m_aper_A2   <<'\n'
     << "m_aper_A3  "  << m_aper_A3   <<'\n'
     << "m_aper_A4  "  << m_aper_A4   <<'\n'
     << "m_xb       "  << m_xb        <<'\n'
     << "m_side     "  << m_side      <<'\n';
     return ost.str();
   }

◆ swap()

void FPTracker::Magnet::swap ( Magnet & )

private

◆ track()

void FPTracker::Magnet::track ( IParticle & particle ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 65 of file FPTracker/src/Magnet.cxx.

                                              {
   
     particle.setBeamCoordinateShift(this);
     if ( particle.isOutOfAperture() ){return;}
     
     
     // check if particle x,y coordinates wrt to the magnet are in the aperture. 
     if( this->isOutOfAperture( particle ) ){
       //std::cout<<"lost at front face "<<std::endl;
       particle.setOutOfAperture(true);
       return;
     }
     
     // update the particle position and direction affected by the bending of the magnet.
     m_bender->bend(particle);
     particle.z() = m_rearFace;
  
     /*
     std::cout<<"Magnet::track after bend   "<<this->m_frontFace<<" "<<this->label()<<'\n'
          <<"\n position    "<<particle.position()
          <<"\n p dir       "<<particle.direction()
          <<"\n m pos       "<<this->position()<<'\n'<<std::endl;
     
  
     std::cout<<particle<<'\n';
     */
  
     if ( this->isOutOfAperture( particle ) )
       {
     particle.setOutOfAperture(true);
       } 
  
   }

◆ zabspos()

double FPTracker::Magnet::zabspos ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 59 of file FPTracker/src/Magnet.cxx.

59 {return std::fabs(m_center.z());}

◆ zsignedpos()

double FPTracker::Magnet::zsignedpos ( ) const

virtual

Implements FPTracker::IBeamElement.

Definition at line 58 of file FPTracker/src/Magnet.cxx.

58 {return m_center.z();}

Member Data Documentation

◆ m_aper_A1

double FPTracker::Magnet::m_aper_A1

private

Definition at line 76 of file FPTracker/FPTracker/Magnet.h.

◆ m_aper_A2

double FPTracker::Magnet::m_aper_A2

private

Definition at line 77 of file FPTracker/FPTracker/Magnet.h.

◆ m_aper_A3

double FPTracker::Magnet::m_aper_A3

private

Definition at line 78 of file FPTracker/FPTracker/Magnet.h.

◆ m_aper_A4

double FPTracker::Magnet::m_aper_A4

private

Definition at line 79 of file FPTracker/FPTracker/Magnet.h.

◆ m_apertype

int FPTracker::Magnet::m_apertype

private

Definition at line 75 of file FPTracker/FPTracker/Magnet.h.

◆ m_bender

IBender::ConstPtr_t FPTracker::Magnet::m_bender

private

Definition at line 82 of file FPTracker/FPTracker/Magnet.h.

◆ m_center

Point FPTracker::Magnet::m_center

private

Definition at line 71 of file FPTracker/FPTracker/Magnet.h.

◆ m_frontFace

double FPTracker::Magnet::m_frontFace

private

Definition at line 72 of file FPTracker/FPTracker/Magnet.h.

◆ m_label

std::string FPTracker::Magnet::m_label

private

Definition at line 83 of file FPTracker/FPTracker/Magnet.h.

◆ m_rearFace

double FPTracker::Magnet::m_rearFace

private

Definition at line 73 of file FPTracker/FPTracker/Magnet.h.

◆ m_side

Side FPTracker::Magnet::m_side

private

Definition at line 81 of file FPTracker/FPTracker/Magnet.h.

◆ m_strength

double FPTracker::Magnet::m_strength

private

Definition at line 74 of file FPTracker/FPTracker/Magnet.h.

◆ m_xb

double FPTracker::Magnet::m_xb

private

Definition at line 80 of file FPTracker/FPTracker/Magnet.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConstIter_t

◆ ConstListIter_t

◆ ConstPtr_t

◆ Container_t

◆ Iter_t

◆ List_t

◆ ListIter_t

◆ Ptr_t

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Magnet()

Member Function Documentation

◆ calibrate()

◆ centerZ()

◆ clone()

◆ frontFace()

◆ frontface()

◆ isEndElement()

◆ isOutOfAperture()

◆ label()

◆ position()

◆ rearFace()

◆ side()

◆ str()

◆ swap()

◆ track()

◆ zabspos()

◆ zsignedpos()

Member Data Documentation

◆ m_aper_A1

◆ m_aper_A2

◆ m_aper_A3

◆ m_aper_A4

◆ m_apertype

◆ m_bender

◆ m_center

◆ m_frontFace

◆ m_label

◆ m_rearFace

◆ m_side

◆ m_strength

◆ m_xb