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
 Screenshots

Download
 Components
 Linux Install (deb/rpm)
 Mac OS X Install
 Unix Install (src code)
 Windows Install
 Other Downloads (share)

Mailing list

Search web/mailinglist

Documentation
 McStas manual
 FAQ
 Known problems
 Publications
 C Compilers
 Other
 Tools
 Tutorial

Workshops/conferences

Developments

Links

Report bugs

Git

McStas Ubuntu live-dvd


McStas: Guide_four_side Component

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

The Guide_four_side Component

Guide with four side walls

Identification

  • Author: Tobias Panzner
  • Origin: PSI
  • Date: 07/08/2010
  • Version: 1.1

Description


 This component models a guide with four side walls.
 As user you can controll the properties of every wall separatly. All togther you have up to 
 8 walls: 4 inner walls and 4 outer walls.

 Every single wall can have a elliptic, parabolic or straight shape.
 All four sides of the guide are independent from each other.
 In the elliptic case the side wall shape follows the equation x^2/b^2+(z+z0)^2/a^2=1
 (the center of the ellipse is located at (0,-z0)).
 In the parabolic case the side wall shape follows the equation z=b-ax^2;mc
 In the straight case the side wall shape follows the equation z=l/(w2-w1)*x-w1.

 The shape selection is done by the focal points. The focal points are located at the 
 z-axis and are defined by their distance to the entrance or exit window of the guide
 (in the following called 'focal length').

 If both focal lengths for one wall are zero it will be a straight wall (entrance and 
 exit width have to be given in the beginning).

 If one of the focal lengths is not zero the shape will be parabolic (only the entrance width 
 given in the beginning is recognized; exit width will be calculated). If the the entrance 
 focal length is zero the guide will be a focusing devise.
 If the exit focal length is zero it will be defocusing devise.

 If both focals are non zero the shape of the wall will be elliptic (only the entrance width 
 given in the beginning is recognized; exit width will be calculated). 

 Notice: 1.)The focal points are in general located outside the guide (positive focal lengths).
            Focal points inside the guide need to have negative focal lengths.
         2.)The exit width parameters (w2r, w2l, h2u,h2d) are only taken into account if the 
            walls have a linear shape. In the ellitic or parabolic case they will be ignored.

 For the inner channel: the outer side of each wall is calculated by the component in depentence 
 of the wallthickness and the shape of the inner side.

 Each of walls can have a own indepenting reflecting layer (defined by an input file) 
 or it can be a absorber or it can be transparent.

 The reflectivity properties can be given by an input file (Format [q(Angs-1) R(0-1)]) or by 
 parameters (Qc, alpha, m, W).

%BUGS
This component does not work with gravitation on.

This component does not work correctly in GROUP-modus.

WARNING: This is a contributed Component.

Input parameters

Parameters in boldface are required; the others are optional.
Name Unit Description Default
RIreflect str Name of relfectivity file for the right inner wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
LIreflect str Name of relfectivity file for the left inner wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
UIreflect str Name of relfectivity file for the top inner wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
DIreflect str Name of relfectivity file for the bottom inner wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
ROreflect str Name of relfectivity file for the right outer wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
LOreflect str Name of relfectivity file for the left outer wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
UOreflect str Name of relfectivity file for the top outer wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
DOreflect str Name of relfectivity file for the bottom outer wall. Format [q(Angs-1) R(0-1)] (DEFAULT : no file) 0
w1l DEFAULT = 0 [m] Width at the left guide entry (positive x-axis) 0.002
w2l DEFAULT = 0 [m] Width at the left guide exit (positive x-axis) 0.002
linwl DEFAULT = 0 [m] left horizontal wall: distance of 1st focal point and guide entry 0
loutwl DEFAULT = 0 [m] left horizontal wall: distance of 2nd focal point and guide exit 0
w1r DEFAULT = 0 [m] Width at the right guide entry (negative x-axis) 0.002
w2r DEFAULT = 0 [m] Width at the right guide exit (negative x-axis) 0.002
linwr DEFAULT = 0 [m] right horizontal wall: distance of 1st focal point and guide entry 0.0
loutwr DEFAULT = 0 [m] right horizontal wall: distance of 2nd focal point and guide exit 0
h1u DEFAULT = 0 [m] Height at the top guide entry (positive y-axis) 0.002
h2u DEFAULT = 0 [m] Height at the top guide entry (positive y-axis) 0.002
linhu DEFAULT = 0 [m] upper vertical wall: distance of 1st focal point and guide entry 0.0
louthu DEFAULT = 0 [m] upper vertical wall: distance of 2nd focal point and guide exit 0
h1d DEFAULT = 0 [m] Height at the bottom guide entry (negative y-axis) 0.002
h2d DEFAULT = 0 [m] Height at the bottom guide entry (negative y-axis) 0.002
linhd DEFAULT = 0 [m] lower vertical wall: distance of 1st focal point and guide entry 0.0
louthd DEFAULT = 0 [m] lower vertical wall: distance of 2nd focal point and guide exit 0
l DEFAULT = 0 [m] length of guide 0
R0 DEFAULT = 0.99 [1] Low-angle reflectivity 0.99
Qcxl DEFAULT = 0.0217 [AA-1] Critical scattering vector for left vertical inner wall 0.0217
Qcxr DEFAULT = 0.0217 [AA-1] Critical scattering vector for right vertical inner wall 0.0217
Qcyu DEFAULT = 0.0217 [AA-1] Critical scattering vector for top inner wall 0.0217
Qcyd DEFAULT = 0.0217 [AA-1] Critical scattering vector for bottom inner wall 0.0217
alphaxl DEFAULT = 6.07 [AA] Slope of reflectivity for left vertical inner wall 6.07
alphaxr DEFAULT = 6.07 [AA] Slope of reflectivity for right vertical inner wall 6.07
alphayu DEFAULT = 6.07 [AA] Slope of reflectivity for top inner wall 6.07
alphayd DEFAULT = 6.07 [AA] Slope of reflectivity for bottom inner wall 6.07
Wxr DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for right inner wall 0.003
Wxl DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for left inner wall 0.003
Wyu DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for top inner wall 0.003
Wyd DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for bottom inner wall 0.003
mxr DEFAULT = 3.6 [1] m-value of material for right vertical inner wall. 0 means the wall is absorbing. -1 means the wall is transparent. 3.6
mxl DEFAULT = 3.6 [1] m-value of material for left vertical inner wall. 0 means the wall is absorbing. -1 means the wall is transparent. 3.6
myu DEFAULT = 3.6 [1] m-value of material for top inner wall 0 means the wall is absorbing. -1 means the wall is transparent. 3.6
myd DEFAULT = 3.6 [1] m-value of material for bottom inner wall 0 means the wall is absorbing. -1 means the wall is transparent. 3.6
QcxrOW DEFAULT = 0.0217 [AA-1] Critical scattering vector for right vertical outer wall 0.0217
QcxlOW DEFAULT = 0.0217 [AA-1] Critical scattering vector for left vertical outer wall 0.0217
QcyuOW DEFAULT = 0.0217 [AA-1] Critical scattering vector for top outer wall 0.0217
QcydOW DEFAULT = 0.0217 [AA-1] Critical scattering vector for bottom outer wall 0.0217
alphaxlOW DEFAULT = 6.07 [AA] Slope of reflectivity for left vertical outer wall 6.07
alphaxrOW DEFAULT = 6.07 [AA] Slope of reflectivity for right vertical outer wall 6.07
alphayuOW DEFAULT = 6.07 [AA] Slope of reflectivity for top outer wall 6.07
alphaydOW DEFAULT = 6.07 [AA] Slope of reflectivity for bottom outer wall 6.07
WxrOW DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for right outer wall 0.003
WxlOW DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for left outer wall 0.003
WyuOW DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for top outer wall 0.003
WydOW DEFAULT = 0.003 [AA-1] Width of supermirror cut-off for bottom outer wall 0.003
mxrOW DEFAULT = 0 [1] m-value of material for right vertical outer wall 0 means the wall is absorbing. (DEFAULT) -1 means the wall is transparent. 0
mxlOW DEFAULT = 0 [1] m-value of material for left vertical outer wall 0 means the wall is absorbing.(DEFAULT) -1 means the wall is transparent. 0
myuOW DEFAULT = 0 [1] m-value of material for top outer wall 0 means the wall is absorbing. (DEFAULT) -1 means the wall is transparent. 0
mydOW DEFAULT = 0 [1] m-value of material for bottom outer wall 0 means the wall is absorbing. (DEFAULT) -1 means the wall is transparent. 0
rwallthick DEFAULT = 0.001 m [m] thickness of the right wall 0.001
lwallthick DEFAULT = 0.001 m [m] thickness of the left wall 0.001
uwallthick DEFAULT = 0.001 m [m] thickness of the top wall 0.001
dwallthick DEFAULT = 0.001 m [m] thickness of the bottom wall 0.001

Output parameters

Name Unit Description Default
w1rwt  
w1lwt  
h1uwt  
h1dwt  
w2rwt  
w2lwt  
h2uwt  
h2dwt  
pawr  
pawl  
pbwr  
pbwl  
pahu  
pahd  
pbhu  
pbhd  
awl  
bwl  
awr  
bwr  
ahu  
bhu  
ahd  
bhd  
awlwt  
bwlwt  
awrwt  
bwrwt  
ahuwt  
bhuwt  
ahdwt  
bhdwt  
pawrwt  
pawlwt  
pbwrwt  
pbwlwt  
pahuwt  
pahdwt  
pbhuwt  
pbhdwt  
t1  
t2w1r  
t2w1l  
t2h1u  
t2h1d  
t2w1rwt  
t2w1lwt  
t2h1uwt  
t2h1dwt  
a2wlwt  
b2wlwt  
a2wrwt  
b2wrwt  
a2huwt  
b2huwt  
a2hdwt  
b2hdwt  
a2wl  
b2wl  
a2wr  
b2wr  
a2hu  
b2hu  
a2hd  
b2hd  
mru1  
mru2  
nru1  
nru2  
mrd1  
mrd2  
nrd1  
nrd2  
mlu1  
mlu2  
nlu1  
nlu2  
mld1  
mld2  
nld1  
nld2  
z0wr  
z0wl  
z0hu  
z0hd  
p2parawr  
p2parawl  
p2parahu  
p2parahd  
p2parawrwt  
p2parawlwt  
p2parahuwt  
p2parahdwt  
m  
n  
nz  
nx  
ny  
n2  
pf  
vxin  
vyin  
vzin  
q  
xtest  
ytest  
riTable  
liTable  
uiTable  
diTable  
roTable  
loTable  
uoTable  
doTable  
TEST_INPUT  
TEST_INPUT_1  
TEST_INPUT_2  
TEST_INPUT_3  
TEST_INPUT_4  
ELLIPSE  
PARABEL_FOCUS  
PARABEL_DEFOCUS  
LINEAR  
TIME_LINEAR  
TIME_LINEAR_1  
TIME_PARABEL  
TIME_PARABEL_1  
TIME_ELLIPSE  
TIME_ELLIPSE_1  
TEST_UP_DOWN  
TEST_LEFT_RIGHT  

Links


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

Generated automatically by McDoc, Peter Willendrup <peter.willendrup@risoe.dk> / Fri Mar 17 20:40:06 2017


Last Modified: Friday, 17-Mar-2017 21:40:06 CET
Search website mailinglist archive GitHub repos