Class Torus

java.lang.Object

cnuphys.magfield.MagneticField

cnuphys.magfield.Torus

All Implemented Interfaces:

IMagField

public class Torus
extends MagneticField

The Class Torus.

Author:

David Heddle, Nicole Schumacher

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_addedSolenoid
static Logger	LOGGER

Fields inherited from class MagneticField

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

Method Summary

Modifier and Type	Method	Description
void	addToField(int compositeIndex, float[] result)	Used to add the solenoid into the torus.
static Torus	fromBinaryFile(File file)	Obtain a torus object from a binary file, probably "clas12-fieldmap-torus.dat"
String	getName()	Get the name of the field
double	getPhiMax()	Get the maximum phi coordinate of the field boundary (deg)
double	getPhiMin()	Get the minimum phi coordinate of the field boundary (deg)
boolean	isActive()	Checks this field active.
boolean	isFullMap()	Check whether there is an assume 12-fold symmetry
boolean	isSolenoidAdded()	Has part of the solenoid been added in to remove the overlap?
final boolean	isZeroField()	Checks whether the field has been set to always return zero.
void	printConfiguration(PrintStream ps)	Print the current configuration
final String	toString()	Get some data as a string.

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, vectorField, vectorToString

Methods inherited from class Object

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

Field Details

LOGGER

public static Logger LOGGER

_addedSolenoid

protected boolean _addedSolenoid

Method Details

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.

isActive

public boolean isActive()

Checks this field active.

Specified by:

isActive in class MagneticField

Returns:

true if this field is active;

isSolenoidAdded

public boolean isSolenoidAdded()

Has part of the solenoid been added in to remove the overlap?

Returns:

true if the solenoid was added in.

fromBinaryFile

public static Torus fromBinaryFile(File file)
                            throws FileNotFoundException

Obtain a torus object from a binary file, probably "clas12-fieldmap-torus.dat"

Parameters:

file - the file to read

Returns:

the torus object

Throws:

FileNotFoundException - the file not found exception

getPhiMax

public double getPhiMax()

Get the maximum phi coordinate of the field boundary (deg)

Returns:

the maximum phi coordinate of the field boundary

getPhiMin

public double getPhiMin()

Get the minimum phi coordinate of the field boundary (deg)

Returns:

the minimum phi coordinate of the field boundary

getName

public String getName()

Get the name of the field

Returns:

the name

isFullMap

public boolean isFullMap()

Check whether there is an assume 12-fold symmetry

Returns:

true if this is a full map

toString

public final String toString()

Get some data as a string.

Overrides:

toString in class MagneticField

Returns:

a string representation.

addToField

public void addToField(int compositeIndex,
 float[] result)

Used to add the solenoid into the torus. Experimental!!

Parameters:

compositeIndex - the composite index

result - the solenoid field added in

printConfiguration

public void printConfiguration(PrintStream ps)

Print the current configuration

Parameters:

ps - the print stream