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

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)


The Set_pol McStas Component

7.2  The Set_pol McStas Component

(Unphysical) way of setting the polarization.

Identification

  • Author: Peter Christiansen

  • Origin: Risoe

  • Date: August 2006

Description

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

1

X-component of polarisation vector (can be negative)

0

py

1

Y-component of polarisation vector (can be negative)

0

pz

1

Z-component of polarisation vector (can be negative)

0

randomOn

1

Generate random values if randomOn!=0.

0

normalize

1

Normalize the polarization vector to unity length.

0

Links

  • Component source code found in file Set_pol.comp.


Last Modified: Tuesday, 06-Oct-2026 21:19:10 CEST
Search website mailinglist archive GitHub repos