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: Set_pol Component

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

The Set_pol Component

(Unphysical) way of setting the polarization.


  • Author: Peter Christiansen
  • Origin: Risoe
  • Date: August 2006
  • Version:(Unknown)


This component has no physical size (like Arm - also drawn that
way), but is used to set the polarisation in one of four ways:
1) (randomOn=0, normalize=0) Hardcode the polarisation to the vector (px, py, pz)
2) (randomOn!=0, normalize!=0) Set the polarisation to a random vector on the unit sphere
3) (randomOn!=0, normalize=0) Set the polarisation to a radnom vector within the unit sphere
4) (randomOn=0, normalize!=0) Hardcode the polarisation to point in the direction of (px,py,pz) but with polarization=1. 
Example: Set_pol(px=0, py=-1, pz=0)

Input parameters

Parameters in boldface are required; the others are optional.
Name Unit Description Default
px can be negative [1] X-component of polarisation vector 0
py can be negative [1] Y-component of polarisation vector 0
pz can be negative [1] Z-component of polarisation vector 0
randomOn 1 Generate random values if randomOn!=0. 0
normalize 1 Normalize the polarization vector. If used with randomOn will generate random vectors with length 1. 0


[ 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