McStas logo McStas - A neutron ray-trace simulation package ILL; PSI; ESS Niels Bohr Institute DTU Physics NEXMAP

McStas

About McStas
 Conditions of use
 Authors/Contacts
 Project funding

Download
 Components
 Other Downloads (share)

Mailing list

Search web/mailinglist

Documentation
 Wiki (GitHub)
 McStas manual
 Publications

Links

Report bugs (GitHub)

Code-repository (GitHub)


McStas: Pol_Bfield

[ Identification | Description | Input parameters | Links ]

The Pol_Bfield Component

Magnetic field component.

Identification

  • Site:
  • Author: Erik B Knudsen, Peter Christiansen and Peter Willendrup
  • Origin: RISOE
  • Date: July 2011

Description

Region with a definable magnetic field.

The component is nestable if the concentric flag is set (the default). This means that it may have a
construction like the following:
// START MAGNETIC FIELD
COMPONENT msf =
Pol_Bfield(xwidth=0.08, yheight=0.08, zdepth=0.2, Bx=0, By=-0.678332e-4, Bz=0)
AT (0, 0, 0) RELATIVE armMSF

// OTHER COMPONENTS INSIDE THE MAGNETIC FIELD CAN BE PLACED HERE

// STOP MAGNETIC FIELD
COMPONENT msf_stop = Pol_simpleBfield_stop(magnet_comp_stop=msf)
AT (0, 0, 0) RELATIVE armMSF

Note that if you have objects within the magnetic field that extend outside it you may get
wrong results, because propagation within the field will then possibly extend outside, e.g.
when using a tabled field. The evaluated field will then use the nearest defined field point
_also_ outside the defintion area. If these outside-points have a non-zero field precession will
continue - even after the neutron has left the field region.

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

Example: Pol_Bfield(xwidth=0.1, yheight=0.1, zdepth=0.2, Bx=0, By=1, Bz=0)
Pol_Bfield(xwidth=0.1, yheight=0.1, zdepth=0.2, field_type=1)

Functions supplied by the system are (the number is the ID of the function to be given as the field_type parameter:
1. Constant magnetic field: Constant field (Bx,By,Bz) within the region
2. Rotating magnetic_field: Field is initially (0,By,0) but after a length of zdepth
has rotated to (By,0,0)
3. Majorana magnetic_field: Field is initially (Bx,By,0) with By<

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
field_typeID of function describing the magnetic field. 1:constant field, 2: rotating fiel, 3: majorana type field, 4: MSF, 5: RF-field, 6: gradient field.0
xwidthmWidth of opening.0
yheightmHeight of opening.0
zdepthmLength of field.0
radiusmRadius of field if it is cylindrical or spherical.0
BxTParameter used for x composant of field.0
ByTParameter used for y composant of field.0
BzTParameter used for z composant of field.0
concentric Allow components and/or other fields inside field. Requires a subsequent Pol_simpleBfield_stop component.1
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links


[ Identification | Description | Input parameters | Links ]

Generated on 2023-09-19 20:01:36


Last Modified: Wednesday, 03-Jan-2024 19:59:10 CET
Search website mailinglist archive GitHub repos