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
 Screenshots

Download
 Components
 Linux Install (deb/rpm)
 Mac OS X Install
 Unix Install (src code)
 Windows Install
 Other Downloads (share)

Mailing list

Search web/mailinglist

Documentation
 McStas manual
 FAQ
 Known problems
 Publications
 C Compilers
 Other
 Tools
 Tutorial

Workshops/conferences

Developments

Links

Report bugs

Git

McStas Ubuntu live-dvd


McStas: Set_pol Component

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

The Set_pol Component

(Unphysical) way of setting the polarization.

Identification

  • Author: Peter Christiansen
  • Origin: Risoe
  • Date: August 2006
  • Version: $Revision$

Description


This component has no physical size (like Arm - also drawn that
way), but is used to set the polarisation in one of two ways:
1) (randomOn=0) Hardcode the polarisation to the vector (px, py, pz)
2) (randomOn!=0) Set the polarisation to a random vector on the unit sphere

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

Links


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

Generated automatically by McDoc, Peter Willendrup <peter.willendrup@risoe.dk> / Fri Mar 17 20:40:06 2017


Last Modified: Friday, 17-Mar-2017 21:40:06 CET
Search website mailinglist archive GitHub repos