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: NCrystal_sample

[ Identification | Description | Input parameters | Links ]

The NCrystal_sample Component

McStas sample component for the NCrystal library for thermal neutron transport


  • Site:
  • Author: NCrystal developers
  • Origin: NCrystal Developers (European Spallation Source ERIC and DTU Nutech)
  • Date:


McStas sample component for the NCrystal scattering library.
Find more information at the NCrystal wiki.
In particular, browse the available datafiles at Data-library
and read about the format of the configuration string expected in
the "cfg" parameter at Using-NCrystal.

NCrystal is available under the Apache 2.0 license. Depending on the configuration choices, optional NCrystal modules under different licenses might be enabled, see here for more details. Note also that for more complicated geometries, it might be desirable to use NCrystal via the McStas Union components instead.

This NCrystal_sample component used to be shipped with NCrystal itself, but starting with McStas 3.2 it is shipped along with McStas itself (accordingly the components version number is reset to 1.0.0 to avoid confusion). As engine it will use whichever NCrystal installation is available and associated with the "ncrystal-config" command.

Input parameters

Parameters in boldface are required; the others are optional.
cfgstrNCrystal material configuration string (details on this page)."void"
absorptionmode0|1|20 : disable absorption. 1 : enable absorption via intensity reduction. 2 : enable absorption by terminating the tracking.1
multscat0|10 : disable multiple scattering. 1 : enable multiple scattering1
xwidthmx-dimension (width) of sample, if box shape is desired0
yheightmy-dimension (height) of sample, if box or cylinder shape is desired0
zdepthmz-dimension (depth) of sample, if box shape is desired0
radiusmradius of sample, if sphere or cylinder shape is desired0


[ Identification | Description | Input parameters | Links ]

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

Last Modified: Wednesday, 03-Jan-2024 19:59:10 CET
Search website mailinglist archive GitHub repos