McXtrace logo

McXtrace - An X-ray ray-trace simulation package

Synchrotron SOLEIL Niels Bohr Institute DTU Physics

McXtrace

About McXtrace
 Publications
 Project Partners
 Project People
 Goal

Download
 Components

Documentation
 Wiki (GitHub)
 Commands
 Manual
 Tutorial

Mailing list

Links

Code-repository (GitHub)

Search


McXtrace: Union_box

[ Identification | Description | Input parameters | Output parameters | Links ]

The Union_box Component

A sample component to separate geometry and physics

Identification

  • Site:
  • Author: Mads Bertelsen and Erik B Knudsen
  • Origin: ESS DMSC & DTU Physics
  • Date: 20.08.15

Description

Part of the Union components, a set of components that work together and thus
separates geometry and physics within McXtrace.
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 coincide. This will crash the code on run time.


Algorithm:
Described elsewhere

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
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.
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
visualize1
target_index0
target_x0
target_y0
target_z0
focus_aw0
focus_ah0
focus_xw0
focus_xh0
focus_r0
p_interact0
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_activations1

Output parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
loop_index
this_box_volume
global_geometry_element
this_box_storage

Links


[ Identification | Description | Input parameters | Output parameters | Links ]

Generated on 2022-01-12 12:31:07


Last Modified: Wednesday, 12-Jan-2022 12:31:07 CET
Search website mailinglist archive GitHub repos