OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
TrimCoilMirrored Class Reference

#include <TrimCoilMirrored.h>

Inheritance diagram for TrimCoilMirrored:
Collaboration diagram for TrimCoilMirrored:

Public Member Functions

 TrimCoilMirrored (double bmax, double rmin, double rmax, double slope)
virtual ~TrimCoilMirrored ()
void applyField (const double r, const double z, const double phi_rad, double *br, double *bz)
void setAzimuth (const double phimin, const double phimax)
 Set azimuthal range where trim coil acts: [phimin, phimax] (also when phimin > phimax).

Protected Attributes

double bmax_m
 Maximum B field (kG).
double rmin_m
 Minimum radius (m).
double rmax_m
 Maximum radius (m).
double phimin_m = 0.0
 Minimal azimuth (rad).
double phimax_m = Physics::two_pi
 Maximal azimuth (rad).

Private Member Functions

virtual void doApplyField (const double r, const double z, const double phi_rad, double *br, double *bz)
 virtual implementation of applyField
 TrimCoilMirrored ()=delete

Private Attributes

double bslope_m
 Slope in (1 / mm).

Detailed Description

Definition at line 24 of file TrimCoilMirrored.h.

Constructor & Destructor Documentation

◆ TrimCoilMirrored() [1/2]

TrimCoilMirrored::TrimCoilMirrored ( double bmax,
double rmin,
double rmax,
double slope )

Definition at line 26 of file TrimCoilMirrored.cpp.

References bslope_m, and TrimCoil::TrimCoil().

Here is the call graph for this function:

◆ ~TrimCoilMirrored()

virtual TrimCoilMirrored::~TrimCoilMirrored ( )
inlinevirtual

Definition at line 32 of file TrimCoilMirrored.h.

◆ TrimCoilMirrored() [2/2]

TrimCoilMirrored::TrimCoilMirrored ( )
privatedelete

Member Function Documentation

◆ applyField()

void TrimCoil::applyField ( const double r,
const double z,
const double phi_rad,
double * br,
double * bz )
inherited

Apply the trim coil at position r and z to Bfields br and bz Calls virtual doApplyField

Definition at line 43 of file TrimCoil.cpp.

References Util::angle_0to2pi(), Util::angleBetweenAngles(), bmax_m, doApplyField(), phimax_m, and phimin_m.

Here is the call graph for this function:

◆ doApplyField()

void TrimCoilMirrored::doApplyField ( const double r,
const double z,
const double phi_rad,
double * br,
double * bz )
privatevirtual

virtual implementation of applyField

update bz and br with trim coil contributions

Implements TrimCoil.

Definition at line 37 of file TrimCoilMirrored.cpp.

References TrimCoil::bmax_m, bslope_m, endl(), ERRORMSG, log10(), TrimCoil::rmax_m, and TrimCoil::rmin_m.

Here is the call graph for this function:

◆ setAzimuth()

void TrimCoil::setAzimuth ( const double phimin,
const double phimax )
inherited

Set azimuthal range where trim coil acts: [phimin, phimax] (also when phimin > phimax).

Definition at line 53 of file TrimCoil.cpp.

References Util::angle_0to2pi(), Units::deg2rad, phimax_m, and phimin_m.

Here is the call graph for this function:

Member Data Documentation

◆ bmax_m

double TrimCoil::bmax_m
protectedinherited

Maximum B field (kG).

Definition at line 45 of file TrimCoil.h.

Referenced by applyField(), TrimCoilBFit::doApplyField(), TrimCoilMirrored::doApplyField(), TrimCoilPhaseFit::doApplyField(), and TrimCoil().

◆ bslope_m

double TrimCoilMirrored::bslope_m
private

Slope in (1 / mm).

Definition at line 36 of file TrimCoilMirrored.h.

Referenced by doApplyField(), and TrimCoilMirrored().

◆ phimax_m

double TrimCoil::phimax_m = Physics::two_pi
protectedinherited

Maximal azimuth (rad).

Definition at line 53 of file TrimCoil.h.

Referenced by applyField(), and setAzimuth().

◆ phimin_m

double TrimCoil::phimin_m = 0.0
protectedinherited

Minimal azimuth (rad).

Definition at line 51 of file TrimCoil.h.

Referenced by applyField(), and setAzimuth().

◆ rmax_m

double TrimCoil::rmax_m
protectedinherited

Maximum radius (m).

Definition at line 49 of file TrimCoil.h.

Referenced by TrimCoilBFit::doApplyField(), TrimCoilMirrored::doApplyField(), TrimCoilPhaseFit::doApplyField(), and TrimCoil().

◆ rmin_m

double TrimCoil::rmin_m
protectedinherited

Minimum radius (m).

Definition at line 47 of file TrimCoil.h.

Referenced by TrimCoilMirrored::doApplyField(), and TrimCoil().

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