OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TrimCoilMirrored Class Reference

#include <TrimCoilMirrored.h>

Inheritance diagram for TrimCoilMirrored:
Inheritance graph
[legend]
Collaboration diagram for TrimCoilMirrored:
Collaboration graph
[legend]

Public Member Functions

 TrimCoilMirrored (double bmax, double rmin, double rmax, double slope)
 
virtual ~TrimCoilMirrored ()
 
- Public Member Functions inherited from TrimCoil
 TrimCoil (double bmax, double rmin, double rmax)
 
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. More...
 
virtual ~TrimCoil ()
 

Private Member Functions

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

Private Attributes

double bslope_m
 Slope in (1 / mm) More...
 

Additional Inherited Members

- Protected Attributes inherited from TrimCoil
double bmax_m
 Maximum B field (kG) More...
 
double rmin_m
 Minimum radius (m) More...
 
double rmax_m
 Maximum radius (m) More...
 
double phimin_m = 0.0
 Minimal azimuth (rad) More...
 
double phimax_m = Physics::two_pi
 Maximal azimuth (rad) More...
 

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 Units::mm2m.

◆ ~TrimCoilMirrored()

virtual TrimCoilMirrored::~TrimCoilMirrored ( )
inlinevirtual

Definition at line 32 of file TrimCoilMirrored.h.

◆ TrimCoilMirrored() [2/2]

TrimCoilMirrored::TrimCoilMirrored ( )
privatedelete

Member Function Documentation

◆ 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 bslope_m, log(), log10(), TrimCoil::rmax_m, and TrimCoil::rmin_m.

Here is the call graph for this function:

Member Data Documentation

◆ bslope_m

double TrimCoilMirrored::bslope_m
private

Slope in (1 / mm)

Definition at line 36 of file TrimCoilMirrored.h.

Referenced by doApplyField(), and TrimCoilMirrored().


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