File: NOMENCLATURE.md

package info (click to toggle)
mccode 3.5.19%2Bds5-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,113,256 kB
  • sloc: ansic: 40,697; python: 25,137; yacc: 8,438; sh: 5,405; javascript: 4,596; lex: 1,632; cpp: 742; perl: 296; lisp: 273; makefile: 226; fortran: 132
file content (87 lines) | stat: -rw-r--r-- 3,825 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
    This file is part of the McStas neutron ray-trace simulation package
    Copyright (C) 1997-, All rights reserved
    Technical University of Denmark, plus collaboration including
    Institut Laue Langevin, Grenoble, France
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; version 3 of the License.
    
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

# McStas component nomenclature
This file describes 'standard' McStas parameter names for components.

## Geometry and Dimensions:
Use combinations of the below identifiers to realise simple
geometrical shapes, such as spheres, boxes and cylinders.

For hollow shapes, combine with ```thickness``` or ```radius_i/radius_o```

* Radial specifications (suffixes _i and _o indicate inner, outer respectively)
  ```radius, radius_i, radius_o```
* Dimensions along x
   ```xwidth, xmin, xmax```
 * Dimensions along y
   ```yheight, ymin, ymax```
* Dimensions along z
  ```zdepth, zlength, zmin, zmax, l, length```
* Material thickness, e.g. for hollow shapes
  ```thickness```
* Width, height and length specifications for guides and other optics
  ```w1, h1``` at guide entry,  ```w2, h2```at guide exit, ```l, length``` for z-length
* Reflectivity parameters for guides and other optics
  ```R0 Qc alpha m W```
* For multichannel optics and collimators, used to specify number of channels
  ```nslit```
* Components that support the OFF surface specification often use
  ```geometry``` to specify a file with vertices and faces

## Spectral definitions for source (often defines the MC sampling range
* Wavelength
  ```Lmin, Lmax``` or ```Lambda0, dLambda``` or ```lambda0, dlambda```
* Energy
  ```Emin, Emax``` or ```E0, dE```

## Physical parameters:
* Scalar cross-sections of absorption, incoherent and corherent
scattering
  ```sigma_abs, sigma_inc, sigma_coh```
* Frequencies
  ```nu, freq```
* Phase-definitions, e.g. for choppers
  ```phase, phi```

## Monte Carlo variance-reduction and tuning-parameters:
* Propability of "interaction", often meaning scattering "including
change of direction" (i.e. 1-p_interact is "transmitted" or "tunneled"
through object)
  ```p_interact```
* Propability of incoherent scattering, transmission
  ```p_incoherent, p_transmit```
* Defining a solid-angle of interest, often used in sources and samples
  ```focus_xw, focus_yh``` for rectangular, ```focus_aw, focus_ah``` for angular , ```focus_r``` for radial specficiation
* to be combined with either
  ```dist``` for distance along z, ```target_index``` for  specification via location of other component object, ```target_x, target_y, target_z``` for specification via free-form vector
* In some samples, the scattered output can be limitied to an angular range
around the scattering plane
  ```d_phi```
* or horizontal range 
  ```d_omega```

## Binning definitions in monitors
Typically done with combination of limits and number of bins, examples
* ```Emin, Emax, nE``` in energy-monitors
* ```Lmin, Lmax, nL``` in wavelength monitors
* ```xwidth, yheight, nx, ny``` in position-monitors
* Also consult ```Monitor_nD``` documentation for the advanced ```options``` string

## Other:
```filename``` specifies a needed file, be it for input (physical parameters, geometry, ...) or output (in monitors and samples)