[ Identification | Description | Input parameters | Links ]

# The `NCrystal_sample` Component

McStas sample component for the NCrystal library for thermal neutron transport

## Identification

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

## Description

    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.

Name | Unit | Description | Default |
cfg | str | NCrystal material configuration string (details on this page). | "void" |
absorptionmode | 0|1|2 | 0 : disable absorption. 1 : enable absorption via intensity reduction. 2 : enable absorption by terminating the tracking. | 1 |
multscat | 0|1 | 0 : disable multiple scattering. 1 : enable multiple scattering | 1 |
xwidth | m | x-dimension (width) of sample, if box shape is desired | 0 |
yheight | m | y-dimension (height) of sample, if box or cylinder shape is desired | 0 |
zdepth | m | z-dimension (depth) of sample, if box shape is desired | 0 |
radius | m | radius of sample, if sphere or cylinder shape is desired | 0 |

AT ( | , | , |  | ) RELATIVE |  |
ROTATED ( | , | , |  | ) RELATIVE |

## Links

- Source code for `NCrystal_sample.comp`.
- The NCrystal wiki at https://github.com/mctools/ncrystal/wiki.

[ Identification | Description | Input parameters | Links ]