[ Identification | Description | Input parameters | Output parameters | Links ]

# The `Pol_simpleBfield` Component

Magnetic field component.

## Identification

- Author: Peter Christiansen and Peter Willendrup
- Origin: RISOE
- Date: August 2006
- Version: 1.1

## Description

    Rectangular box with a definable B field.

    The component is concentric. It means that it requires a

    // START MAGNETIC FIELD
    COMPONENT msf =
    Pol_simpleBfield(xw=0.08, yh=0.08, length=0.2, Bx=0, By=-0.678332e-4, Bz=0)
         AT (0, 0, 0) RELATIVE armMSF

    // HERE CAN BE OTHER COMPONENTS INSIDE THE MAGNETIC FIELD

    // STOP MAGNETIC FIELD
    COMPONENT msfCp = COPY(msf)
         AT (0, 0, 0) RELATIVE armMSF

    In between the two component instances the propagation routine
    PROP_DT also handles the spin propagation.
    The current algorithm used for spin propagation is:
    SimpleNumMagnetPrecession
    in pol-lib.
    and does not handle gravity.

    GRAVITY: NO
    POLARISATION: YES

    Example: Pol_simpleBfield(xw=0.1, yh=0.1, length=0.2, Bx=0, By=1, Bz=0)

## Input parameters

Parameters in boldface are required; the others are optional.

Name | Unit | Description | Default
--- | --- | --- | ---
xw | m | Width of opening. |
yh | m | Height of opening. |
length | m | Length of field. |
Bx | T | Parameter used for x composant of field. |
By | T | Parameter used for y composant of field. |
Bz | T | Parameter used for z composant of field. |
nx | 1 | Number of field points to draw along x axis. | 5
ny | 1 | Number of field points to draw along y axis. | 5
nz | 1 | Number of field points to draw along z axis. | 5
fieldFunction | pointer | Function describing the magnetic field. | const_magnetic_field

## Output parameters

Name | Unit | Description | Default
--- | --- | --- | ---
gz | m/s/s | z-component of gravity |
parPtr | pointer | Pointer to component magnet parameters |

## Links

- Source code for `Pol_simpleBfield.comp`.

[ Identification | Description | Input parameters | Output parameters | Links ]