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

McStas
site 2

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_tabled_field

[ Identification | Description | Input parameters | Links ]

The Pol_tabled_field Component

Magnetic field component.

Identification

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

Description

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.
NameUnitDescriptionDefault
xwidthmWidth of opening.0
yheightmHeight of opening.0
zdepthmLength of field.0
radiusmRadius of field if it is cylindrical or spherical.0
filenamestrFile where the magnetic field is tabulated."bfield.dat"
geometrystrName of an Object File Format (OFF) or PLY file for complex field-geometry.NULL
interpol_methodstrChoice of interpolation method "kdtree" (default on CPU) / "regular" (default on GPU)"default"
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links


[ Identification | Description | Input parameters | Links ]

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


Last Modified: Tuesday, 16-Apr-2024 20:05:20 CEST
Search website mailinglist archive GitHub repos