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

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

The Guide_anyshape_r Component

Reflecting surface (guide and mirror) with any shape, defined from an OFF file and a patch to allow reflectivites added per polygon face. Derived from Guide_anyshape.


  • Author: Emmanuel Farhi, adapted by Peter Link
  • Origin: ILL/MLZ
  • Date: August 4th 2010
  • Version:(Unknown)


This is a reflecting object component, derived from Guide_anyshape.
Its shape (and optionally m-value pr. surface) is defined from an OFF file,
given with its file name. The object size is set as given from the file, where
dimensions should be in meters. The bounding box may be re-scaled by specifying
xwidth,yheight,zdepth parameters. The object may optionally be centered when
using 'center=1'.

The reflectivity is specified either from the usual parametric description
R0,Qc,alpha,W,m, or by defning an m-value for each face present in the OFF file.

The complex OFF/PLY geometry option handles any closed non-convex polyhedra.
  It supports the OFF and NOFF file format but not COFF (colored faces).
  Such files may be generated from XYZ data using:
    qhull < Qx Qv Tv o >
  and viewed with geomview or java -jar jroff.jar (see below).
  The default size of the object depends of the OFF file data, but its
  bounding box may be resized using xwidth,yheight and zdepth.
  PLY geometry files are also supported.

This component does take into account gravitation accurately.

Example values: m=4 Qc=0.0219 W=1/300 alpha=6.49 R0=1

WARNING: This is a contributed Component.

Input parameters

Parameters in boldface are required; the others are optional.
Name Unit Description Default
geometry str Name of the OFF/PLY file describing the guide geometry 0
xwidth m Redimension the object bounding box on X axis is non-zero 0
yheight m Redimension the object bounding box on Y axis is non-zero 0
zdepth m Redimension the object bounding box on Z axis is non-zero 0
center 1 When set to 1, the object will be centered w.r.t. the local coordinate frame 0
transmit 1 When true, non reflected neutrons are transmitted through the surfaces, instead of being absorbed. No material absorption is taken into account though 0
R0 1 Low-angle reflectivity 0.99
Qc AA-1 Critical scattering vector 0.0219
alpha AA Slope of reflectivity 0
m 1 m-value of material. Zero means completely absorbing. 0
W AA-1 Width of supermirror cut-off 0

Output parameters

Name Unit Description Default


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

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

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