TrimCoil Class Reference

Abstract TrimCoil class. More...

#include <TrimCoil.h>

Inheritance diagram for TrimCoil:

Public Member Functions
	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 ()

Protected Attributes
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...

Private Member Functions
virtual void	doApplyField (const double r, const double z, const double phi_rad, double *br, double *bz)=0
	virtual implementation of applyField More...

Detailed Description

Abstract TrimCoil class.

Definition at line 8 of file TrimCoil.h.

Constructor & Destructor Documentation

TrimCoil::TrimCoil	(	double	bmax,
		double	rmin,
		double	rmax
	)

Definition at line 7 of file TrimCoil.cpp.

References bmax_m, rmax_m, and rmin_m.

virtual TrimCoil::~TrimCoil ( )

inlinevirtual

Definition at line 18 of file TrimCoil.h.

Member Function Documentation

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

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

Definition at line 19 of file TrimCoil.cpp.

References abs(), bmax_m, doApplyField(), Physics::e, phimax_m, and phimin_m.

Here is the call graph for this function:

virtual void TrimCoil::doApplyField ( const double  r, const double  z, const double  phi_rad, double *  br, double *  bz  )

privatepure virtual

virtual implementation of applyField

Implemented in TrimCoilBFit, TrimCoilPhaseFit, and TrimCoilMirrored.

Referenced by applyField().

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

Set azimuthal range.

Definition at line 28 of file TrimCoil.cpp.

References Physics::deg2rad, phimax_m, and phimin_m.

Member Data Documentation

double TrimCoil::bmax_m

protected

Maximum B field (kG)

Definition at line 18 of file TrimCoil.h.

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

double TrimCoil::phimax_m = Physics::two_pi

protected

Maximal azimuth (rad)

Definition at line 31 of file TrimCoil.h.

Referenced by applyField(), and setAzimuth().

double TrimCoil::phimin_m = 0.0

protected

Minimal azimuth (rad)

Definition at line 29 of file TrimCoil.h.

Referenced by applyField(), and setAzimuth().

double TrimCoil::rmax_m

protected

Maximum radius (m)

Definition at line 27 of file TrimCoil.h.

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

double TrimCoil::rmin_m

protected

Minimum radius (m)

Definition at line 25 of file TrimCoil.h.

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

---

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

• src/Classic/TrimCoils/TrimCoil.h
• src/Classic/TrimCoils/TrimCoil.cpp