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

Download
 Components
 Other Downloads (share)

Mailing list

Search web/mailinglist

Documentation
 Wiki (GitHub)
 McStas manual
 Publications

Links

Report bugs (GitHub)

Code-repository (GitHub)


McStas: Elliptic_guide_gravity

[ Identification | Description | Input parameters | Links ]

The Elliptic_guide_gravity Component

Perfect elliptic guide which allow for simulations with gravity. The guide mirrors can be divided into segments with individual m-values. Parabolic guide components can also be simulated.

Identification

  • Site:
  • Author: Henrik Bo Hoffmann Carlsen and Mads Bertelsen
  • Origin: NBI
  • Date: 27 Aug 2012

Description

The perfect elliptic guide is centered along the z-axis with the entrance
and exit in the xy-plane. The horizontal and vertical ellipses defining
the guide geometry is by default set by two focal points.
These are placed a distance away from the guide openings along the z-axis;
if distance given is positive, when the focal point is outside the guide.

Multiple options for defining these ellipse exist including approximation of
parabolas and half ellipses (mid point of the ellipse or one of the guide openings)

The guide coating parameters can be set for each side of the guide.
Furthermore the m-value can be specified for user defined segments
of the guide.

Example 1, Elliptical definition using focal points:

Elliptic_guide_gravity(
    l=50,
    linxw=5,linyh=5,loutxw=10,loutyh=10,
    xwidth=0.05,yheight=0.05,
    R0=0.99,Qc=0.0219,alpha=6.07,m=1.0,W=0.003
)

Example 2: Half elliptical definition:

Elliptic_guide_gravity(
    l=50,
    linxw=5,linyh=5,loutxw=10,loutyh=10,
    xwidth=0.1,yheight=0.1,
    R0=0.99,Qc=0.0219,alpha=6.07,m=1.0,W=0.003,
    option = "halfEllipse",
    dimensionsAt = "entrance"
)

Example 3: Parabolic approximation:

Elliptic_guide_gravity(
    l=50,
    linxw=5,linyh=5,loutxw=1e6,loutyh=1e6, // values larger than 1e8 may cause erroneous results
    xwidth=0.1,yheight=0.1,
    R0 = 0.99,Qc=0.0219,alpha=6.07,m=1.0,W=0.003,
    dimensionsAt = "exit"
)

Example 4: Elliptical definition with varying m-values:

Elliptic_guide_gravity(
    l=50,
    linxw=5,linyh=5,loutxw=10,loutyh=10,
    xwidth=0.1,yheight=0.1,
    R0 = 0.99,Qc=0.0219,alpha=6.07,m=1.0,W=0.003,
    mvaluesright=marray,mvaluesleft=marray,mvaluestop=marray,mvaluesbottom=marray
)

where marray is initialized as
for(iter=0; iter < 50; iter++){ marray[iter] = 2; }
And Declared as
double mValues[50];
If you are using the array-based coating-specification, you **must** give nSegments a compatible value.

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
xwidthmwidth at the guide entry, mid or exit (see dimensionsAt)0
yheightmheight at the guide entry, mid or exit (see dimensionsAt)0
lmlength of the guide
linxwmdistance from 1st focal point to guide entrance - left and right horizontal mirrors0
loutxwmdistance from 2nd focal point to guide exit - left and right horizontal mirrors0
linyhmdistance from 1st focal point to guide entrance - top and bottom vertical mirrors0
loutyhmdistance from 2nd focal point to guide exit - top and bottom vertical mirrors0
majorAxisxwmdirect defination of the guide geometry, will ignore w,h lin and lout parameters if this is nonzero. Length of the axis parallel to the z for the horizontal ellipse0
minorAxisxwmdirect defination of the guide geometry, will ignore w,h lin and lout parameters if this is nonzero. Length of the axis Perpendicular to the z for the horizontal ellipse0
majorAxisyhmdirect defination of the guide geometry, will ignore w,h lin and lout parameters if this is nonzero. Length of the axis parallel to the z for the vertical ellipse0
minorAxisyhmdirect defination of the guide geometry, will ignore w,h lin and lout parameters if this is nonzero. Length of the axis Perpendicular to the z for the vertical ellipse0
majorAxisoffsetxwmdirect defination of the guide geometry, distance between the center of the horizontal ellipse and the guide entrance0
majorAxisoffsetyhmdirect defination of the guide geometry, distance between the center of the vertical ellipse and the guide entrance0
dimensionsAtstringdefine whether xwidth and yheight sets the size of the opening, minor axis or the end of the guide."entrance"
optionstringoptions are 'ellipse' and 'halfEllipse'. Ellipse is defined by both the focal points, while halfEllipse locked the center of the ellipse either the entrance or exit of the guide, and use the focal point of the other end to define the ellipse"ellipse"
R01Low-angle reflectivity0.99
QcAA-1Critical scattering vector0.0218
alphaAASlope of reflectivity6.07
m1m-value of material for all mirrors, zero means complete absorption.2
WAA-1Width of supermirror cut-off0.003
alpharightAASlope of reflectivity for right vertical mirror-1
mright1m-value of material for right vertical mirror-1
alphaleftAASlope of reflectivity for left vertical mirror-1
mleft1m-value of material for left vertical mirror-1
alphatopAASlope of reflectivity for top horizontal mirror, overwrites alpha-1
mtop1m-value of material for top horizontal mirror, overwrites m-1
alphabottomAASlope of reflectivity for bottom horizontal mirror-1
mbottom1m-value of material for bottom horizontal mirror-1
verboseboolGive extra information about calculations"on"
enableGravitymFlag to select propagation with gravity.1.0
curvaturemSimulate horizontal radius of curvature by centripetal force added to the gravity. Note: Does not curve the guide in mcdisplay but "curves the neutron". Has opposite sign definition of Guide_curved.0
nSegmentsmMust be used to specify number of guide segments, i.e. when giving inputs mvaluesright ... etc.-1
mvaluesrightpointerPointer to array of m-values, right mirrorNULL
mvaluesleftpointer- same, left mirrorNULL
mvaluestoppointer- same, top mirrorNULL
mvaluesbottompointer- same, bottom mirrorNULL
seglengthpointerPointer to array of segment lengths for discrete mirror descriptionNULL
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links


[ Identification | Description | Input parameters | Links ]

Generated on 2023-09-19 20:01:36


Last Modified: Wednesday, 03-Jan-2024 19:59:10 CET
Search website mailinglist archive GitHub repos