Fixing headers to render with mcdoc.

mads-bertelsen · mads-bertelsen · commit cfa51c98c9e4 · 2025-10-27T15:29:06.000+01:00
diff --git a/mcstas-comps/union/IncoherentPhonon_process.comp b/mcstas-comps/union/IncoherentPhonon_process.comp
@@ -43,6 +43,7 @@
 * kabsmin:           [A^-1]   Lower cut-off for the neutron wave-vector k
 * kabsmax:           [A^-1]   Higher cut-off for the neutron wave-vector k
 * interact_fraction: [1]      How large a part of the scattering events should use this process 0-1 (sum of all processes in material = 1)
+* init:              [string] Name of Union_init component (typically "init", default)
 *
 * CALCULATED PARAMETERS:
 *
diff --git a/mcstas-comps/union/NCrystal_process.comp b/mcstas-comps/union/NCrystal_process.comp
@@ -1,33 +1,24 @@
-
-/*******************************************************************************
-* Used NCrystal_sample as basis for creating a Union process that can use the  *
-* NCrystal library.                                                            *
-* Changes by Mads Bertelsen, 13/8 2020.                                        *
-*******************************************************************************/
-
-/******************************************************************************/
-/* The original code contained the following license/copyright statement:     */
-/******************************************************************************/
-/*                                                                            */
-/*  This file is part of NCrystal (see https://mctools.github.io/ncrystal/)   */
-/*                                                                            */
-/*  Copyright 2015-2019 NCrystal developers                                   */
-/*                                                                            */
-/*  Licensed under the Apache License, Version 2.0 (the "License");           */
-/*  you may not use this file except in compliance with the License.          */
-/*  You may obtain a copy of the License at                                   */
-/*                                                                            */
-/*      http://www.apache.org/licenses/LICENSE-2.0                            */
-/*                                                                            */
-/*  Unless required by applicable law or agreed to in writing, software       */
-/*  distributed under the License is distributed on an "AS IS" BASIS,         */
-/*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  */
-/*  See the License for the specific language governing permissions and       */
-/*  limitations under the License.                                            */
-/*                                                                            */
-/******************************************************************************/
 /*******************************************************************************
 *
+* Used NCrystal_sample as basis for creating a Union process that can use the  
+* NCrystal library.                                                            
+* Changes by Mads Bertelsen, 13/8 2020.                                        
+*
+*  This file is part of NCrystal (see https://mctools.github.io/ncrystal/)
+*
+*  Copyright 2015-2022 NCrystal developers
+*
+*  Licensed under the Apache License, Version 2.0 (the "License");
+*  you may not use this file except in compliance with the License.
+*  You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+*  Unless required by applicable law or agreed to in writing, software
+*  distributed under the License is distributed on an "AS IS" BASIS,
+*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+*  See the License for the specific language governing permissions and
+*  limitations under the License.
 *  McStas, neutron ray-tracing package
 *  Copyright(C) 2007 Risoe National Laboratory.
 *
@@ -83,6 +74,7 @@
 * cfg:               [str]    NCrystal material configuration string (details <a href="https://github.com/mctools/ncrystal/wiki/Using-NCrystal">on this page</a>).
 * packing_factor:    [1]      Material packing factor
 * interact_fraction: [1]      How large a part of the scattering events should use this process 0-1 (sum of all processes in material = 1)
+* init:              [string] Name of Union_init component (typically "init", default)
 *
 * CALCULATED PARAMETERS:
 * NCrystal_storage          // Storage used to communicate with the probability and scattering function
diff --git a/mcstas-comps/union/Non_process.comp b/mcstas-comps/union/Non_process.comp
@@ -37,9 +37,11 @@
 * INPUT PARAMETERS:
 * sigma:            [barns]  Scattering cross section
 * unit_cell_volume: [AA^3]   Unit cell volume
+* interact_fraction: [1]      How large a part of the scattering events should use this process 0-1 (sum of all processes in material = 1)
+* init:              [string] Name of Union_init component (typically "init", default)
 *
 * CALCULATED PARAMETERS:
-* Non_storage          // Important to update this output paramter
+* Non_storage          
 * effective_my_scattering   // Variable used in initialize
 *
 * %L
diff --git a/mcstas-comps/union/Union_abs_logger_1D_time.comp b/mcstas-comps/union/Union_abs_logger_1D_time.comp
@@ -60,6 +60,8 @@
 * %P
 * INPUT PARAMETERS:
 * yheight:         [m] height of absorption logger
+* time_min:               [s] time at start of recording
+* time_min:               [s] time at end of recording
 * n:               [1] number of bins along y
 * target_geometry: [string] Comma separated list of geometry names that will be logged, leave empty for all volumes (even not defined yet)
 * filename:        [string] Filename of produced data file
diff --git a/mcstas-comps/union/Union_abs_logger_event.comp b/mcstas-comps/union/Union_abs_logger_event.comp
@@ -58,6 +58,12 @@
 * target_geometry: [string] Comma separated list of geometry names that will be logged, leave empty for all volumes (even not defined yet)
 * filename:        [string] Filename of produced data file
 * order_total:     [1]      Only log rays that have scattered n times, -1 for all orders
+* xwidth:          [m]      Width in x direction
+* yheight:         [m]      Height in y direction
+* zdepth:          [m]      Depth in z direction
+* xbins:           [1]      Number of bins in x direction
+* ybins:           [1]      Number of bins in y direction
+* zbins:           [1]      Number of bins in z direction
 * order_volume:    [1]      Only log rays that have scattered n times in the same geometry, -1 for all orders
 * logger_conditional_extend_index: [1] If a conditional is used with this logger, the result of each conditional calculation can be made available in extend as a array called "logger_conditional_extend", and one would then access logger_conditional_extend[n] if logger_conditional_extend_index is set to n
 * init:            [string] Name of Union_init component (typically "init", default)
diff --git a/mcstas-comps/union/Union_abs_logger_nD.comp b/mcstas-comps/union/Union_abs_logger_nD.comp
@@ -60,11 +60,35 @@
 * %P
 * INPUT PARAMETERS:
 * target_geometry: [string] Comma separated list of geometry names that will be logged, leave empty for all volumes (even not defined yet)
-* filename:        [string] Filename of produced data file
 * order_total:     [1]      Only log rays that have scattered n times, -1 for all orders
 * order_volume:    [1]      Only log rays that have scattered n times in the same geometry, -1 for all orders
 * logger_conditional_extend_index: [1] If a conditional is used with this logger, the result of each conditional calculation can be made available in extend as a array called "logger_conditional_extend", and one would then access logger_conditional_extend[n] if logger_conditional_extend_index is set to n
 * init:            [string] Name of Union_init component (typically "init", default)
+* xwidth: [m]            Width of detector.
+* yheight: [m]           Height of detector.
+* zdepth: [m]            Thickness of detector (z).
+* radius: [m]            Radius of sphere/banana shape monitor
+* options: [str]         String that specifies the configuration of the monitor. The general syntax is "[x] options..." (see <b>Descr.</b>).
+* xmin: [m]              Lower x bound of opening
+* xmax: [m]              Upper x bound of opening
+* ymin: [m]              Lower y bound of opening
+* ymax: [m]              Upper y bound of opening
+* zmin: [m]              Lower z bound of opening
+* zmax: [m]              Upper z bound of opening
+* filename: [str]        Output file name (overrides file=XX option).
+* bins: [1]              Number of bins to force for all variables. Use 'bins' keyword in 'options' for heterogeneous bins
+* min: [u]               Minimum range value to force for all variables. Use 'min' or 'limits' keyword in 'options' for other limits
+* max: [u]               Maximum range value to force for all variables. Use 'max' or 'limits' keyword in 'options' for other limits
+* user1: [str]           Variable name of USERVAR to be monitored by user1.
+* user2: [str]           Variable name of USERVAR to be monitored by user2.
+* user3: [str]           Variable name of USERVAR to be monitored by user3.
+* username1: [str]       Name assigned to User1
+* username2: [str]       Name assigned to User2
+* username3: [str]       Name assigned to User3
+* restore_neutron: [0|1] Not functional for Union version
+* geometry: [str]        Name of an OFF file to specify a complex geometry detector
+* nowritefile: [1]       Not functional for Union version
+
 *
 * OUTPUT PARAMETERS:
 *
diff --git a/mcstas-comps/union/Union_box.comp b/mcstas-comps/union/Union_box.comp
@@ -57,14 +57,14 @@
 * focus_xw:              [m]      Horiz. dimension of a rectangular area
 * focus_xh:              [m]      Vert. dimension of a rectangular area
 * focus_r:               [m]      Focusing on circle with this radius
-* plus_x_surface         [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +x face of box
-* minus_x_surface        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -x face of box
-* plus_y_surface         [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +y face of box
-* minus_y_surface        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -z face of box
-* plus_z_surface         [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +z face of box
-* minus_z_surface        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -z face of box
-* all_face_surface       [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all faces above
-* cut_surface            [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all internal cuts
+* plus_x_surface:        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +x face of box
+* minus_x_surface:       [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -x face of box
+* plus_y_surface:        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +y face of box
+* minus_y_surface:       [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -z face of box
+* plus_z_surface:        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +z face of box
+* minus_z_surface:       [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -z face of box
+* all_face_surface:      [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all faces above
+* cut_surface:           [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all internal cuts
 * init:                  [string] name of Union_init component (typically "init", default)
 * CALCULATED PARAMETERS:
 *
@@ -78,13 +78,12 @@ DEFINE COMPONENT Union_box
 SETTING PARAMETERS(string material_string=0, priority,
                    xwidth, yheight, zdepth, xwidth2=-1, yheight2=-1, 
 				   visualize=1, int target_index=0, target_x=0, target_y=0, target_z=0, focus_aw=0, focus_ah=0, focus_xw=0, focus_xh=0, focus_r=0,
-				   string all_face_surface=0, string cut_surface=0, string plus_z_surface=0, string minus_z_surface=0,
-				   string plus_x_surface=0, string minus_x_surface=0, string plus_y_surface=0, string minus_y_surface=0,
+				   string plus_z_surface=0, string minus_z_surface=0,
+				   string plus_x_surface=0, string minus_x_surface=0,
+				   string plus_y_surface=0, string minus_y_surface=0,
+				   string all_face_surface=0, string cut_surface=0, 
 				   p_interact = 0, string mask_string=0, string mask_setting=0, number_of_activations=1, string init="init")
 
-
-/* Neutron parameters: (x,y,z,vx,vy,vz,t,sx,sy,sz,p) */
-
 SHARE
 %{
 
diff --git a/mcstas-comps/union/Union_cone.comp b/mcstas-comps/union/Union_cone.comp
@@ -55,11 +55,11 @@
 * focus_xw:              [m]      Horiz. dimension of a rectangular area
 * focus_xh:              [m]      Vert. dimension of a rectangular area
 * focus_r:               [m]      Focusing on circle with this radius
-* curved_surface         [string] Comma seperated string of Union surface definitions defined prior to this component, applied to curved wall of cone
-* top_surface            [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +y top face of cone
-* bottom_surface         [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -y bottom face of cone
-* all_face_surface       [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all faces above
-* cut_surface            [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all internal cuts
+* curved_surface:        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to curved wall of cone
+* top_surface:           [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +y top face of cone
+* bottom_surface:        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -y bottom face of cone
+* all_face_surface:      [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all faces above
+* cut_surface:           [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all internal cuts
 * init:                  [string] Name of Union_init component (typically "init", default)
 *
 * CALCULATED PARAMETERS:
@@ -74,7 +74,7 @@ DEFINE COMPONENT Union_cone
 SETTING PARAMETERS(string material_string=0, priority, radius=0,radius_top=0,radius_bottom=0, yheight, visualize=1,
                    int target_index=0, target_x=0, target_y=0, target_z=0, focus_aw=0, focus_ah=0, focus_xw=0, focus_xh=0, focus_r=0, 
 				   p_interact=0, string mask_string=0, string mask_setting=0,number_of_activations=1, 
-				   string all_face_surface=0, string cut_surface=0, string curved_surface=0, string top_surface=0, string bottom_surface=0,
+				   string curved_surface=0, string top_surface=0, string bottom_surface=0, string all_face_surface=0, string cut_surface=0, 
 				   string init="init")
 
 
diff --git a/mcstas-comps/union/Union_cylinder.comp b/mcstas-comps/union/Union_cylinder.comp
@@ -52,11 +52,11 @@
 * focus_xw:              [m]      Horiz. dimension of a rectangular area
 * focus_xh:              [m]      Vert. dimension of a rectangular area
 * focus_r:               [m]      Focusing on circle with this radius
-* curved_surface         [string] Comma seperated string of Union surface definitions defined prior to this component, applied to curved wall of cylinder
-* top_surface            [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +y top face of cylinder
-* bottom_surface         [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -y bottom face of cylinder
-* all_face_surface       [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all faces above
-* cut_surface            [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all internal cuts
+* curved_surface:        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to curved wall of cylinder
+* top_surface:           [string] Comma seperated string of Union surface definitions defined prior to this component, applied to +y top face of cylinder
+* bottom_surface:        [string] Comma seperated string of Union surface definitions defined prior to this component, applied to -y bottom face of cylinder
+* all_face_surface:      [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all faces above
+* cut_surface:           [string] Comma seperated string of Union surface definitions defined prior to this component, applied to all internal cuts
 * init:                  [string] Name of Union_init component (typically "init", default)
 *
 * CALCULATED PARAMETERS:
@@ -71,7 +71,7 @@ DEFINE COMPONENT Union_cylinder
 SETTING PARAMETERS(string material_string=0, priority, radius, yheight, visualize=1, 
                    int target_index=0, target_x=0, target_y=0, target_z=0, focus_aw=0, focus_ah=0, focus_xw=0, focus_xh=0, focus_r=0, 
 				   p_interact=0, string mask_string=0, string mask_setting=0, number_of_activations=1,
-				   string all_face_surface=0, string cut_surface=0, string curved_surface=0, string top_surface=0, string bottom_surface=0,
+				   string curved_surface=0, string top_surface=0, string bottom_surface=0, string all_face_surface=0, string cut_surface=0, 
 				   string init="init")
 
 
diff --git a/mcstas-comps/union/Union_master.comp b/mcstas-comps/union/Union_master.comp
@@ -33,14 +33,16 @@
 * INPUT PARAMETERS:
 *   enable_refraction:                   [0/1] Toggles refraction effects, simulated for all materials that have refraction parameters set
 *   enable_reflection:                   [0/1] Toggles reflection effects, simulated for all materials that have refraction parameters set
+*   verbal:                              [0/1] Toogles printing information loaded during initialize
 *   list_verbal:                         [0/1] Toogles information of all internal lists in intersection network
 *   allow_inside_start:                  [0/1] Set to 1 if rays are expected to start inside a volume in this master
-*   finally_verbal:                      [0/1]Toogles information about cleanup performed in finally section
-*   enable_tagging:                      [0/1]  Enable tagging of ray history (geometry, scattering process)
-*   history_limit:                       [1] Limit the number of unique histories that are saved
+*   finally_verbal:                      [0/1] Toogles information about cleanup performed in finally section
+*   enable_tagging:                      [0/1] Enable tagging of ray history (geometry, scattering process)
+*   history_limit:                       [1]   Limit the number of unique histories that are saved
 *   enable_conditionals:                 [0/1] Use conditionals with this master
 *   inherit_number_of_scattering_events: [0/1] Inherit the number of scattering events from last master
- *  init:                                [string] Name of Union_init component (typically "init", default)
+*   weight_ratio_limit:                  [1]   Limit on the ratio between initial weight and current, ray absorbed if ratio becomes lower than limit
+*   init:                                [string] Name of Union_init component (typically "init", default)
 *
 * CALCULATED PARAMETERS:
 *
diff --git a/mcstas-comps/union/Union_sphere.comp b/mcstas-comps/union/Union_sphere.comp

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@`
`43`	`43`	`* kabsmin: [A^-1] Lower cut-off for the neutron wave-vector k`
`44`	`44`	`* kabsmax: [A^-1] Higher cut-off for the neutron wave-vector k`
`45`	`45`	`* interact_fraction: [1] How large a part of the scattering events should use this process 0-1 (sum of all processes in material = 1)`
	`46`	`+* init: [string] Name of Union_init component (typically "init", default)`
`46`	`47`	`*`
`47`	`48`	`* CALCULATED PARAMETERS:`
`48`	`49`	`*`
Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,11 @@`
`37`	`37`	`* INPUT PARAMETERS:`
`38`	`38`	`* sigma: [barns] Scattering cross section`
`39`	`39`	`* unit_cell_volume: [AA^3] Unit cell volume`
	`40`	`+* interact_fraction: [1] How large a part of the scattering events should use this process 0-1 (sum of all processes in material = 1)`
	`41`	`+* init: [string] Name of Union_init component (typically "init", default)`
`40`	`42`	`*`
`41`	`43`	`* CALCULATED PARAMETERS:`
`42`		`-* Non_storage // Important to update this output paramter`
	`44`	`+* Non_storage`
`43`	`45`	`* effective_my_scattering // Variable used in initialize`
`44`	`46`	`*`
`45`	`47`	`* %L`