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


About McStas
 Conditions of use
 Project funding

 Other Downloads (share)

Mailing list

Search web/mailinglist

 Wiki (GitHub)
 McStas manual


Report bugs (GitHub)

Code-repository (GitHub)

McStas: Pol_tabled_field Component

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

The Pol_tabled_field Component

Magnetic field component.


  • Author: Erik B Knudsen, Peter Christiansen and Peter Willendrup
  • Origin: RISOE
  • Date: July 2011
  • Version:(Unknown)


Region with a tabled magnetic field read from file.
The magnetic field is read from a text file where it is
     specified as a point cloud with N rows of 6 columns:
     x y z Bx By Bz
   the B field map is resampled with Stepx*Stepy*Stepz points.
   Use Stepx=Stepy=Stepz=0 to skip resampling and use the table as is.
The regions itself may be either a 3D rectangular block, a cylinder with axis along y,
or spherical. Interpolation is done between data-points.

Input parameters

Parameters in boldface are required; the others are optional.
Name Unit Description Default
xwidth m Width of opening. 0
yheight m Height of opening. 0
zdepth m Length of field. 0
radius m Radius of field if it is cylindrical or spherical. 0
filename File where the magnetic field is tabulated. "bfield.dat"
geometry NULL
interpol_method default on GPU [ ] Choice of interpolation method "kdtree" (default on CPU) / "regular" "default"


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

Generated automatically by McDoc, Peter Willendrup <> / Wed Jan 12 15:13:20 2022

Last Modified: Wednesday, 12-Jan-2022 16:13:20 CET
Search website mailinglist archive GitHub repos