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)


McStas: NCrystal_process

[ Identification | Description | Input parameters | Links ]

The NCrystal_process Component

NCrystal_process component for the Union framework.

Identification

  • Site:
  • Author: NCrystal developers, converted to a Union component by Mads Bertelsen
  • Origin: NCrystal Developers (European Spallation Source ERIC and DTU Nutech)
  • Date: 20.08.15

Description

This process uses the NCrystal library as a Union process, see user documentation
for the NCrystal_sample.comp component for more information. The process only
uses the physics, as the Union components has a separate geometry system.
Absorption is also handled by Union, so any absorption output from NCrystal
is ignored.

Part of the Union components, a set of components that work together and thus
sperates geometry and physics within McStas.
The use of this component requires other components to be used.

1) One specifies a number of processes using process components like this one
2) These are gathered into material definitions using Union_make_material
3) Geometries are placed using Union_box / Union_cylinder, assigned a material
4) A Union_master component placed after all of the above

Only in step 4 will any simulation happen, and per default all geometries
defined before the master, but after the previous will be simulated here.

There is a dedicated manual available for the Union_components


Original header text for NCrystal_sample.comp:
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 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 About for more details. Algorithm: Described elsewhere

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
cfgstrNCrystal material configuration string (details on this page).""
packing_factor1Material packing factor1
interact_fraction1How large a part of the scattering events should use this process 0-1 (sum of all processes in material = 1)-1
initstringName of Union_init component (typically "init", default)"init"
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links


[ Identification | Description | Input parameters | Links ]

Generated on mcstas 3.6.1


Last Modified: Friday, 12-Dec-2025 12:58:06 CET
Search website mailinglist archive GitHub repos