Package cnuphys.magfield

Class TransverseSolenoidProbe

java.lang.Object

cnuphys.magfield.FieldProbe

cnuphys.magfield.SolenoidProbe

cnuphys.magfield.TransverseSolenoidProbe

All Implemented Interfaces:

IField

public class TransverseSolenoidProbe
extends SolenoidProbe

Field Summary

Fields inherited from class cnuphys.magfield.FieldProbe

_field, _name, cosSect, q1Coordinate, q2Coordinate, q3Coordinate, ROOT3OVER2, sinSect, X, Y, Z

Constructor Summary

Constructors

Constructor	Description
TransverseSolenoidProbe(TransverseSolenoid field)	Create a probe for use with the transverse solenoid field

Method Summary

Modifier and Type	Method	Description
void	field(float x, float y, float z, float[] result)	Obtain the magnetic field at a given location expressed in Cartesian coordinates.

Methods inherited from class cnuphys.magfield.FieldProbe

contains, factory, factory, field, fieldMagnitude, getB1, getB2, getB3, getCompositeIndex, getField, getMaxFieldMagnitude, getName, getPhiCoordinate, getPhiMax, getPhiMin, getRCoordinate, getRhoMax, getRhoMin, getSector, getZCoordinate, getZMax, getZMin, gradient, isZeroField

Methods inherited from class java.lang.Object

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

Constructor Details

TransverseSolenoidProbe

public TransverseSolenoidProbe(TransverseSolenoid field)

Create a probe for use with the transverse solenoid field

Parameters:

field - the transverse solenoid field

Method Details

field

public void field(float x,
 float y,
 float z,
 float[] result)

Description copied from interface: IField

Obtain the magnetic field at a given location expressed in Cartesian coordinates. The field is returned as a Cartesian vector in kiloGauss.

Specified by:

field in interface IField

Overrides:

field in class SolenoidProbe

Parameters:

x - the x coordinate in cm

y - the y coordinate in cm

z - the z coordinate in cm

result - a float array holding the retrieved field in kiloGauss. The 0,1 and 2 indices correspond to x, y, and z components.