Component Manual for the Neutron Ray-Tracing Package McStas, version 3.8.6

Index

%include (McStas keyword), 1384

ABSORB (C macro, mcstas-r.h), 1385
adapt_tree-lib (library), 1398
Adaptive sampling, 76
ALLOW_BACKPROP (C macro, mcstas-r.h), 1386
Arm, 1404

box_intersect (C function, mccode-r.c), 1391
Bugs, 60, 196, 197, 408

C functions, 1384
Coherent and incoherent isotropic scatterer, 433
Component, 1404
    instance, 1404
Concentric components, 372, 433
Constants, 1400
Contrib, 984
Conversion
    of units, 1400
Coordinate
    retrieval functions, 1386
    system, 44
coords_add (C function, mccode-r.c), 1389
coords_get (C function, mccode-r.c), 1389
coords_set (C function, mccode-r.c), 1389
cylinder_intersect (C function, mccode-r.c), 1392

Data files, 45
Definition parameter, 1404
DEG2RAD (constant), 1400
DETECTOR_OUT_0D (C macro, mccode-r.h), 1390
DETECTOR_OUT_1D (C macro, mccode-r.h), 1391
DETECTOR_OUT_2D (C macro, mccode-r.h), 1391
DETECTOR_OUT_3D (C macro, mccode-r.h), 1391
Diffraction, 372, 389, 406
Direction focusing, 71

Environment variable
    BROWSER, 58
    MCSTAS, 57
Environment variables
    MCSTAS, 1384, 1396
Error estimate, 69
EXTEND (McStas keyword), 1386

FLT_MAX (constant), 1400
Focusing
    importance sampling, 71
FWHM2RMS (constant), 1400

GROUP (McStas keyword), 1386

HBAR (constant), 1400

Importance sampling
    direction focusing, 71
Incoherent elastic scattering, 347, 389
Incoherent inelastic scattering, 355
INDEX_CURRENT_COMP (C macro, mccode-r.h), 1387
Inelastic scattering, 413, 433
Input parameter, 1404
inside_rectangle (C function, mcstas-r.c), 1391
Instrument, 1404

K2V (constant), 1400
Kernel, 1404
Keyword
    EXTEND, 57, 86, 517
    OUTPUT PARAMETERS, 518

Library, 1384
    adapt_tree-lib, 1398
    Components
        contrib, 984
        data, 47, 50, 55
        misc, 536
        monitors, 464
        obsolete, 1308
        optics, 146, 202, 256
        samples, 330
        sasmodels, 687
        sources, 86
        union, 552
    components
        data, 1396
        share, 1384
    mccode-r, 1384
    mcstas-r, 1384
    monitor_nd-lib, 1397
    pol-lib, 1368
    read_table-lib, 1394
    read_table-lib (Read_Table), 45
    Run-time
        MC_GETPAR, 518
    run-time, 1385
    vitess-lib, 1399

MC_GETPAR (C macro, mccode-r.h), 1386
mccode-r (library), 1384
MCDISPLAY (McStas keyword), 1386
MCNP, 140
MCSTAS (environment variable), 1384, 1396
McStas
    name, 1405
    pronunciation, 1405
mcstas-r (library), 1384
mcstas2vitess (McStas tool), 1399
MIN2RAD (constant), 1400
MNEUTRON (constant), 1400
monitor_nd-lib (library), 1397
Monitors, 464
    Adaptive importance sampling monitor, 126
    Banana shape, 515
    Beam analyzer, 546
    Capture flux, 510
    Custom monitoring (user variables, Monitor_nD), 516
    Divergence monitor, 484
    Divergence/position monitor, 488
    Energy monitor, 475
    Neutron parameter correlations, PreMonitor_nD, 518
    Number of neutron bounces in a guide, 518
    Position sensitive detector (PSD), 481
    Position sensitive monitor recording mean energy, 516
    The All-in-One monitor (Monitor_nD), 508
    Time-of-flight monitor, 468
    TOF2E monitor, 472
    Wavelength monitor, 478
Monte Carlo method, 66
    accuracy, 77
    adaptive sampling, 76
    direction focusing, 71
    stratified sampling, 76
Multiple scattering, 389, 433

NAME_CURRENT_COMP (C macro, mccode-r.h), 1386
Neutron polarisation, see Polarisation
NORM (C macro, mccode-r.h), 1390
normal_vec (C function, mccode-r.c), 1390

Obsolete, 1308
Optics, 146, 177, 181, 202, 256
    Beam stop, 155
    Bender (non polarizing), 198
    Curved guides (polygonal model), 198
    Disc chopper, 205
    Fermi Chopper, 197, 217, 236
    Guide with channels (straight, non focusing), 195
    Guide with channels and gravitation handling (straight), 197
    Linear collimator, 163
    Mirror plane, 181
    Monochromator, 299
    Monochromator, curved, 312
    Monochromator, polarizing, 316
    Monochromator, thick, 323
    phase space transformer, 324
    Point in space (Arm, Optical bench), 148
    Radial collimator, 170
    Slit, 152
    Straight guide, 187
    Velocity selector, 246, 252
Optimization, 121, 126, 132, 138
Output parameter, 1405

PI (constant), 1400
Polarisation, 256, 1358
    field functions, 1370
    monitors, 524
    Monochromator_pol, 316
    precession algorithm, 1368
    SimpleNumMagnetPrecession, 1369
POS_A_COMP (C macro, mccode-r.h), 1387
POS_A_COMP_INDEX (C macro, mccode-r.h), 1387
POS_A_CURRENT_COMP (C macro, mccode-r.h), 1386
POS_R_COMP_INDEX (C macro, mccode-r.h), 1387
Preprocessor macros, 1384
PROP_DT (C macro, mcstas-r.h), 1385
PROP_GRAV_DT (C macro, mcstas-r.h), 1386
PROP_Z0 (C macro, mcstas-r.h), 1385

RAD2DEG (constant), 1400
RAD2MIN (constant), 1400
rand01 (C function, mccode-r.c), 1392
randnorm (C function, mccode-r.c), 1392
randpm1 (C function, mccode-r.c), 1392
randtriangle (C function, mccode-r.c), 1392
randvec_target_circle (C function, mccode-r.c), 1392
randvec_target_rect (C function, mccode-r.c), 1393
randvec_target_rect_angular (C function, mccode-r.c), 1393
read_table-lib (library), 1394
Removed neutron events, 44, 446, 1386
RESTORE_NEUTRON (C macro, mcstas-r.h), 1388
RMS2FWHM (constant), 1400
ROT_A_COMP (C macro, mccode-r.h), 1387
ROT_A_CURRENT_COMP (C macro, mccode-r.h), 1387
rot_apply (C function, mccode-r.c), 1389
rot_copy (C function, mccode-r.c), 1389
rot_mul (C function, mccode-r.c), 1389
ROT_R_COMP (C macro, mccode-r.h), 1387
ROT_R_CURRENT_COMP (C macro, mccode-r.h), 1387
rot_set_rotation (C function, mccode-r.c), 1389
rot_transpose (C function, mccode-r.c), 1389
rotate (C macro, mccode-r.h), 1390
Run-time, 1405

Sample environments, 372, 433, 453
Samples, 330
    Coherent and incoherent isotropic scatterer, 433
    Dilute colloid medium, 406
    Incoherent inelastic scatterer, 355
    Incoherent isotropic scatterer (Vanadium), 347
    Phonon scattering, 413
    Powder, multiple diffraction line, 372
    Single crystal diffraction, 389
Sampling, 76
SANS, 338
SasView, 687
scalar_prod (C function, mccode-r.c), 1390
SCATTER (C macro, mcstas-r.h), 1386, 1388
SCATTERED (C macro, mccode-r.h), 1388
SE2V (constant), 1400
Setting parameter, 1405
SHARE (McStas keyword), 1384
Simulation progress bar, 545
Small angle scattering, 406
solve_2nd_order (C function, mccode-r.c), 1390
Sources, 86
    Adaptive importance sampling monitor, 126
    Adaptive source, 121
    Continuous source with a Maxwellian spectrum, 100
    Continuous source with specified divergence, 97
    General continuous source, 107
    ISIS pulsed moderators, 999
    Optimization location, see Sources/Optimizer
    Optimizer, 132
    Simple continuous source, 94
    Time of flight pulsed moderator, 115
sphere_intersect (C function, mccode-r.c), 1392
Spin-echo, 1377
Statistics
    uncertainty, 69
STORE_NEUTRON (C macro, mcstas-r.h), 1387
Stratified sampling, 76
Symbols, 44

Table_Free (C function, read_table-lib.c), 1395
Table_Free_Array (C function, read_table-lib.c), 1395
Table_Index (C function, read_table-lib.c), 1395
Table_Info (C function, read_table-lib.c), 1395
Table_Info_Array (C function, read_table-lib.c), 1395
Table_Init (C function, read_table-lib.c), 1394
Table_Read (C function, read_table-lib.c), 1394
Table_Read_Array (C function, read_table-lib.c), 1395
Table_Read_Offset (C function, read_table-lib.c), 1394
Table_Read_Offset_Binary (C function, read_table-lib.c), 1394
Table_Rebin (C function, read_table-lib.c), 1395
Table_Value (C function, read_table-lib.c), 1395
Table_Value2d (C function, read_table-lib.c), 1395
Tools
    mcdoc, 58
Tripoli, 140

Union, 552
Units
    constants and conversions, 1400

V2K (constant), 1400
Variance, 69
Variance reduction, 76
vec_prod (C function, mccode-r.c), 1390
Virtual sources, 76
Vitess, 140
vitess-lib (library), 1399
VS2E (constant), 1400

Weight, 68
    statistical uncertainty, 69
    transformation, 71