#include <Magnet.h>

Inheritance diagram for ForwardTracker::Magnet:

Collaboration diagram for ForwardTracker::Magnet:

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

typedef std::shared_ptr< const Magnet >	ConstPtr_t

typedef std::vector< ConstPtr_t >	Container_t

typedef Container_t::iterator	Iter_t

typedef Container_t::const_iterator	ConstIter_t

typedef std::list< ConstPtr_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 z, double length, const std::string &aperType, double A1, double A2, double A3, double A4, Side side, IBender::ConstPtr_t bender, const std::string &label)

std::string	label () const

Side	side () const

double	frontFace () const

double	rearFace () const

Point	position () const

bool	isEndElement () const

IBeamElement::ConstPtr_t	clone () const

void	track (IParticle &) const

std::string	str () const

Private Member Functions
bool	isOutOfAperture (IParticle &) const

Private Attributes
std::string	m_label

Side	m_side

double	m_frontFace

double	m_rearFace

Point	m_position

std::string	m_aperType

double	m_A1

double	m_A2

double	m_A3

double	m_A4

IBender::ConstPtr_t	m_bender

Detailed Description

Definition at line 19 of file ForwardTracker/ForwardTracker/Magnet.h.

Member Typedef Documentation

◆ ConstIter_t

typedef Container_t::const_iterator ForwardTracker::IBeamElement::ConstIter_t

inherited

Definition at line 42 of file ForwardTracker/ForwardTracker/IBeamElement.h.

◆ ConstListIter_t

typedef List_t::const_iterator ForwardTracker::IBeamElement::ConstListIter_t

inherited

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

◆ ConstPtr_t

typedef std::shared_ptr<const Magnet> ForwardTracker::Magnet::ConstPtr_t

Definition at line 38 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ Container_t

typedef std::vector<ConstPtr_t> ForwardTracker::Magnet::Container_t

Definition at line 39 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ Iter_t

typedef Container_t::iterator ForwardTracker::IBeamElement::Iter_t

inherited

Definition at line 41 of file ForwardTracker/ForwardTracker/IBeamElement.h.

◆ List_t

typedef std::list<ConstPtr_t> ForwardTracker::IBeamElement::List_t

inherited

Definition at line 43 of file ForwardTracker/ForwardTracker/IBeamElement.h.

◆ ListIter_t

typedef List_t::iterator ForwardTracker::IBeamElement::ListIter_t

inherited

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

Member Enumeration Documentation

◆ Type

enum ForwardTracker::Magnet::Type

Enumerator
hbDipole
hfQuadrupole
vfQuadrupole
vbDipole
notAMagnet

Definition at line 36 of file ForwardTracker/ForwardTracker/Magnet.h.

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

Constructor & Destructor Documentation

◆ Magnet()

ForwardTracker::Magnet::Magnet	(	double	x,
		double	y,
		double	z,
		double	length,
		const std::string &	aperType,
		double	A1,
		double	A2,
		double	A3,
		double	A4,
		Side	side,
		IBender::ConstPtr_t	bender,
		const std::string &	label
	)

Definition at line 12 of file ForwardTracker/src/Magnet.cxx.

                                  :
     m_label    (label),
     m_side     (side),
     m_frontFace(z>0 ? z - 0.5*length : z + 0.5*length),
     m_rearFace (z>0 ? z + 0.5*length : z - 0.5*length),
     m_position (x, y, z),
     m_aperType (aperType),
     m_A1       (aper1),
     m_A2       (aper2),
     m_A3       (aper3),
     m_A4       (aper4),
     m_bender   (bender) 
   {}

Member Function Documentation

◆ clone()

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

inlinevirtual

Implements ForwardTracker::IBeamElement.

Definition at line 48 of file ForwardTracker/ForwardTracker/Magnet.h.

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

◆ frontFace()

double ForwardTracker::Magnet::frontFace ( ) const

inlinevirtual

Implements ForwardTracker::IBeamElement.

Definition at line 43 of file ForwardTracker/ForwardTracker/Magnet.h.

43 { return m_frontFace; }

◆ isEndElement()

bool ForwardTracker::Magnet::isEndElement ( ) const

inlinevirtual

Implements ForwardTracker::IBeamElement.

Definition at line 46 of file ForwardTracker/ForwardTracker/Magnet.h.

46 { return false; }

◆ isOutOfAperture()

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

private

Definition at line 50 of file ForwardTracker/src/Magnet.cxx.

                                                         {
  
     TransversePoint offCenter = particle.displacement();
     
     if      (m_aperType == "\"NONE\"") return false;
     else if (m_aperType == "\"CIRCLE\"") { 
       
       if (m_A1 == 0) return false;
       
       if (offCenter.mag2() > m_A1*m_A1) {
     
     std::ostringstream ost; ost << m_label << " isOutOfAperture ";
     
     ost << "radius: " << offCenter.mag2() << " > A1*A1: " << m_A1*m_A1;
     particle.addMsg(ost.str());
     
     return true;
       }
      
       return false;
     }
     else if (m_aperType == "\"RECTELLIPSE\"") {
       
       double xx = (m_A3) ? offCenter.x()/m_A3 : throw std::runtime_error("ERROR: m_A3 == 0");
       double yy = (m_A4) ? offCenter.y()/m_A4 : throw std::runtime_error("ERROR: m_A4 == 0");
       double rr = xx*xx + yy*yy;
  
       if (rr > 1) {
     
     std::ostringstream ost; ost << m_label << " isOutOfAperture ";
     
     ost << " x/A3: " << xx << " y/A4: " << yy << " (Squared sum: " << rr << " > 1)";
     particle.addMsg(ost.str());
  
     return true;
       }
       
       if (m_A1 > 0) {
     
     if (std::fabs(offCenter.x()) > m_A1) {
  
       std::ostringstream ost; ost << m_label << " isOutOfAperture ";
  
       ost << " |x|: " << std::fabs(offCenter.x()) << " > A1: " << m_A1;
       particle.addMsg(ost.str());
       
       return true;
     }
       }
     
       if (m_A2 > 0) {
  
     if (std::fabs(offCenter.y()) > m_A2) {
  
       std::ostringstream ost; ost << m_label << " isOutOfAperture ";
  
       ost << " |y|: " << std::fabs(offCenter.y()) << " > A2: " << m_A2;
       particle.addMsg(ost.str());
  
       return true;
     }
       }
       
       return false;
     }
     else if (m_aperType == "\"OCTAGON\"") {
     
       if ( m_A1 > 0. ) {
     if( std::fabs(offCenter.x())>m_A1 ) {
     
       std::ostringstream ost; ost << m_label << " isOutOfAperture ";
  
       ost << " |x|: " << std::fabs(offCenter.x()) << " > A1: " << m_A1;
       particle.addMsg(ost.str());
       return true;
     }
       }
       if ( m_A2 > 0. ) {
     if( std::fabs(offCenter.y())>m_A2) {
     
       std::ostringstream ost; ost << m_label << " isOutOfAperture ";
  
       ost << " |y|: " << std::fabs(offCenter.y()) << " > A2: " << m_A2;
       particle.addMsg(ost.str());
       return true;
     }
       }
       if ( m_A3 > 0. && m_A4 > 0. ) {
     
     float B3=std::tan(m_A3)*m_A1;
     float B4=m_A2/std::tan(m_A4);
     float d=(m_A1-std::fabs(offCenter.x()))/(m_A1-B4)+(m_A2-std::fabs(offCenter.y()))/(m_A2-B3);
         
     if(d<1.) {
       std::ostringstream ost; ost << m_label << " isOutOfAperture ";
     
       ost<<" x: "<<offCenter.x()<<" y: "<<offCenter.y()<<"  m_A1 "<<m_A1<<"  m_A2 "<<m_A2<<"  m_A3 "<<m_A3<<"  m_A4 "<<m_A4<<"  d: "<<d;
       particle.addMsg( ost.str() );
       return true;
     }
       }
      
       return false; 
     }
     else {
  
       std::stringstream sstr; sstr << " Unknown magnet aperture type " << m_aperType << "\n";
       throw std::runtime_error(sstr.str().c_str());
     }
  
     return false;
   }

◆ label()

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

inlinevirtual

Implements ForwardTracker::IBeamElement.

Definition at line 41 of file ForwardTracker/ForwardTracker/Magnet.h.

41 { return m_label; }

◆ position()

Point ForwardTracker::Magnet::position ( ) const

inlinevirtual

Implements ForwardTracker::IBeamElement.

Definition at line 45 of file ForwardTracker/ForwardTracker/Magnet.h.

45 { return m_position; }

◆ rearFace()

double ForwardTracker::Magnet::rearFace ( ) const

inlinevirtual

Implements ForwardTracker::IBeamElement.

Definition at line 44 of file ForwardTracker/ForwardTracker/Magnet.h.

44 { return m_rearFace; }

◆ side()

Side ForwardTracker::Magnet::side ( ) const

inlinevirtual

Implements ForwardTracker::IBeamElement.

Definition at line 42 of file ForwardTracker/ForwardTracker/Magnet.h.

42 { return m_side; }

◆ str()

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

virtual

Implements ForwardTracker::IBeamElement.

Definition at line 163 of file ForwardTracker/src/Magnet.cxx.

                               {
  
     std::ostringstream ost;
  
     ost << "m_label     " << m_label     << "\n"
     << "m_side      " << m_side      << "\n"
     << "m_frontFace " << m_frontFace << "\n"
     << "m_rearFace  " << m_rearFace  << "\n"
     << "m_position  " << m_position  << "\n"
     << "m_aperType  " << m_aperType  << "\n"
     << "m_A1        " << m_A1        << "\n"
     << "m_A2        " << m_A2        << "\n"
     << "m_A3        " << m_A3        << "\n"
     << "m_A4        " << m_A4        << "\n";
     
     return ost.str();
   }

◆ track()

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

virtual

Implements ForwardTracker::IBeamElement.

Definition at line 37 of file ForwardTracker/src/Magnet.cxx.

                                               {
  
     particle.setBeamCoordinateShift(this);
     
     if (particle.isOutOfAperture()) return;
     
     m_bender->bend(particle);
  
     particle.z() = m_rearFace;
     
     if (this->isOutOfAperture(particle)) particle.setOutOfAperture(true);
   }

Member Data Documentation

◆ m_A1

double ForwardTracker::Magnet::m_A1

private

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

◆ m_A2

double ForwardTracker::Magnet::m_A2

private

Definition at line 63 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ m_A3

double ForwardTracker::Magnet::m_A3

private

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

◆ m_A4

double ForwardTracker::Magnet::m_A4

private

Definition at line 65 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ m_aperType

std::string ForwardTracker::Magnet::m_aperType

private

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

◆ m_bender

IBender::ConstPtr_t ForwardTracker::Magnet::m_bender

private

Definition at line 66 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ m_frontFace

double ForwardTracker::Magnet::m_frontFace

private

Definition at line 58 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ m_label

std::string ForwardTracker::Magnet::m_label

private

Definition at line 56 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ m_position

Point ForwardTracker::Magnet::m_position

private

Definition at line 60 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ m_rearFace

double ForwardTracker::Magnet::m_rearFace

private

Definition at line 59 of file ForwardTracker/ForwardTracker/Magnet.h.

◆ m_side

Side ForwardTracker::Magnet::m_side

private

Definition at line 57 of file ForwardTracker/ForwardTracker/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

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Magnet()

Member Function Documentation

◆ clone()

◆ frontFace()

◆ isEndElement()

◆ isOutOfAperture()

◆ label()

◆ position()

◆ rearFace()

◆ side()

◆ str()

◆ track()

Member Data Documentation

◆ m_A1

◆ m_A2

◆ m_A3

◆ m_A4

◆ m_aperType

◆ m_bender

◆ m_frontFace

◆ m_label

◆ m_position

◆ m_rearFace

◆ m_side