Class Solenoid

java.lang.Object

cnuphys.magfield.MagneticField

cnuphys.magfield.Solenoid

All Implemented Interfaces:

IMagField

Direct Known Subclasses:

StandardSolenoid, TransverseSolenoid

public abstract class Solenoid
extends MagneticField

Field Summary

Fields inherited from class MagneticField

_interpolate, _scaleFactor, _shiftX, _shiftY, _shiftZ, angularUnit, avgField, field, fieldCoordinateSystem, fieldUnit, gridCoordinateSystem, highTime, lengthUnit, LOGGER, lowTime, MAGICNUMBER, maxField, maxFieldIndex, maxFieldLocation, maxVectorField, MISALIGNTOL, numFieldPoints, q1Coordinate, q2Coordinate, q3Coordinate, reserved3, reserved4, reserved5

Constructor Summary

Constructors

Constructor	Description
Solenoid()

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name of the field
boolean	isActive()	Checks this field active.
final boolean	isZeroField()	Checks whether the field has been set to always return zero.
void	printConfiguration(PrintStream ps)	Print the current configuration

Methods inherited from class MagneticField

computeMaxField, contains, fieldMagnitude, getB1, getB2, getB3, getBaseFileName, getBComponent, getCompositeIndex, getCoordinateIndices, getCreationDate, getFakeZMax, getLocation, getMaxFieldMagnitude, getPhiCoordinate, getQ1Coordinate, getQ2Coordinate, getQ3Coordinate, getRCoordinate, getRhoMax, getRhoMin, getScaleFactor, getShiftX, getShiftY, getShiftZ, getXCoordinate, getYCoordinate, getZCoordinate, getZMax, getZMin, isInterpolate, isMisaligned, isMisalignedX, isMisalignedY, isMisalignedZ, maxFieldMagnitude, readBinaryMagneticField, setCoordinateNames, setFakeZMax, setInterpolate, setScaleFactor, setShiftX, setShiftY, setShiftZ, setZeroField, squareMagnitude, toString, vectorField, vectorToString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Solenoid

public Solenoid()

Method Details

getName

public String getName()

Description copied from interface: IMagField

Get the name of the field

Returns:

the name, e.e. "Torus"

printConfiguration

public void printConfiguration(PrintStream ps)

Description copied from interface: IMagField

Print the current configuration

Parameters:

ps - the print stream

isActive

public boolean isActive()

Description copied from class: MagneticField

Checks this field active.

Specified by:

isActive in class MagneticField

Returns:

true if this field is active;

isZeroField

public final boolean isZeroField()

Checks whether the field has been set to always return zero.

Specified by:

isZeroField in interface IMagField

Overrides:

isZeroField in class MagneticField

Returns:

true if the field is set to return zero.