org.lcsim.geometry.field

Class FieldOverlay

java.lang.Object

org.lcsim.geometry.field.FieldOverlay

All Implemented Interfaces:

FieldMap

public class FieldOverlay
extends Object
implements FieldMap

FieldOverlay is a FieldMap that itself contains a list of references to other FieldMaps. This setup supports the overlay of multiple magnetic fields, such as the detector solenoid and the DiD.

Author:

Jeremy McCormick

See Also:

Detector

Field Summary

Fields

Modifier and Type	Field and Description
private List<FieldMap>	fields

Constructor Summary

Constructors

Constructor and Description
FieldOverlay()

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(FieldMap field)
double[]	getField(double[] pos) Get the field magnitude and direction at a particular point.
void	getField(double[] pos, double[] b) Get the field magnitude and direction at a particular point.
Hep3Vector	getField(Hep3Vector position) Get the field magnitude and direction at a particular point.
Hep3Vector	getField(Hep3Vector position, BasicHep3Vector field) Get the field magnitude and direction at a particular point.

Methods inherited from class java.lang.Object

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

Field Detail

fields

private List<FieldMap> fields

Constructor Detail

FieldOverlay

public FieldOverlay()

Method Detail

addField

public void addField(FieldMap field)

getField

public void getField(double[] pos,
            double[] b)

Description copied from interface: FieldMap

Get the field magnitude and direction at a particular point.

Specified by:

getField in interface FieldMap

Parameters:

pos - The position at which the field is requested

b - The field (the object is passed by reference and set to the correct field)

getField

public double[] getField(double[] pos)

Description copied from interface: FieldMap

Get the field magnitude and direction at a particular point. This method requires allocation of a new object on each call, and should therefore not be used if it may be called many times.

Specified by:

getField in interface FieldMap

Parameters:

pos - The position at which the field is requested

Returns:

The field.

getField

public Hep3Vector getField(Hep3Vector position,
                  BasicHep3Vector field)

Description copied from interface: FieldMap

Get the field magnitude and direction at a particular point.

Specified by:

getField in interface FieldMap

Parameters:

position - The position at which the field is requested.

field - The field. If not null this is passed by reference and set to the correct field

Returns:

The field. This will be the same object passed as field, unless field was null

getField

public Hep3Vector getField(Hep3Vector position)

Description copied from interface: FieldMap

Get the field magnitude and direction at a particular point. Equivalent to getField(position,null).

Specified by:

getField in interface FieldMap