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

[ Identification | Description | Input parameters | Links ]

The Union_mesh Component

Component for including 3D mesh in Union geometry


  • Site:
  • Author: Martin Olsen
  • Origin: Niels Bohr Instituttet, Universitetsparken 5
  • Date: 17.09.18


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
2) These are gathered into material definitions using Union_make_material
3) Geometries are placed using Union_box/cylinder/sphere, 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 this master, but after the previous will be simulated here.

There is a dedicated manual available for the Union_components

The mesh component loads a 3D stl file as the geometry. The mesh geometry
can not yet be overlapped with the basic geometries (sphere, cylinder, box, cone),
but can be overlapped with other mesh geometries.

It is allowed to overlap components, but it is not allowed to have two
parallel planes that coincides. This will crash the code on run time.

Input parameters

Parameters in boldface are required; the others are optional.
filenamestrName of stl file that contains the 3D geometry0
material_stringmaterial name of this volume, defined using Union_make_material0
priority1priotiry of the volume (can not be the same as another volume) A high priority is on top of low.
visualize1set to 0 if you wish to hide this geometry in mcdisplay1
target_index1Relative index of component to focus at, e.g. next is +10
target_ymPosition of target to focus at0
focus_awdeghoriz. angular dimension of a rectangular area0
focus_ahdegvert. angular dimension of a rectangular area0
focus_xwmhoriz. dimension of a rectangular area0
focus_xhmvert. dimension of a rectangular area0
focus_rmfocusing on circle with this radius0
p_interact1probability to interact with this geometry [0-1]0
mask_stringComma seperated list of geometry names which this geometry should mask0
mask_setting"All" or "Any", should the masked volume be simulated when the ray is in just one mask, or all.0
number_of_activations1Number of subsequent Union_master components that will simulate this geometry1


[ Identification | Description | Input parameters | Links ]

Generated on 2024-01-03 11:47:43

Last Modified: Tuesday, 16-Apr-2024 20:05:22 CEST
Search website mailinglist archive GitHub repos