McStas logo McStas - A neutron ray-trace simulation package ILL; PSI; ESS Niels Bohr Institute DTU Physics NEXMAP

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

[ Identification | Description | Input parameters | Links ]

The Union_box Component

A box geometry component for the Union components

Identification

  • Site:
  • Author: Mads Bertelsen
  • Origin: University of Copenhagen
  • Date: 20.08.15

Description

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 position of this component is the center of the box, zdepth/2 in each direction.

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.


Algorithm:
Described elsewhere

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
material_stringstringMaterial 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.
xwidthmWidth of the box volume
yheightmHeight of the box volume
zdepthmDepth of the box volume
xwidth2mOptional different width at the +z box face-1
yheight2mOptional different height at the +z box face-1
visualize1Set to 0 if you wish to hide this geometry in mcdisplay1
target_indexstringFocuses on component a component this many steps further in the component sequence0
target_xmX position of target to focus at0
target_ymY position of target to focus at0
target_zmZ position 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_stringstringComma seperated list of geometry names which this geometry should mask0
mask_settingstring"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
initstringname of Union_init component (typically "init", default)"init"
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links


[ Identification | Description | Input parameters | Links ]

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


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