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

# The `Pol_guide_vmirror` Component

Polarising guide with two supermirros sitting in a v-shape inside.

## Identification

- Author: Peter Christiansen
- Origin: RISOE
- Date: July 2006
- Version: 1.1

## Description

    Models a rectangular guide with entrance centered on the Z axis and
    with two supermirros sitting in a v-shape inside.
    The entrance lies in the X-Y plane.  Draws a true depiction
    of the guide with mirrors, and trajectories.
    The polarisation is handled similar to in Monochromator_pol.
    The reflec functions are handled similar to Pol_mirror.
    The up direction is hardcoded to be along the y-axis (0, 1, 0)

    GRAVITY: YES
    POLARISATION: YES

    %BUGS
    No absorption by mirror.

## Input parameters

Parameters in boldface are required; the others are optional.

Name | Unit | Description | Default
--- | --- | --- | ---
xw | m | Width at the guide entry |
yh | m | Height at the guide entry |
length | m | length of guide |
rFunc | 1 | Guide Reflection function | StdReflecFunc
rUpFunc | 1 | Mirror Reflection function for spin up | StdReflecFunc
rDownFunc | 1 | Mirror Reflection function for spin down | StdReflecFunc
rPar | 1 | Guide Parameters for rFunc |
rUpPar | 1 | Mirror Parameters for rUpFunc |
rDownPar | 1 | Mirror Parameters for rDownFunc |
useTables | 1 | Parameters are 0: Values, 1: Table names | 0
debug | 1 | if debug > 0 print out some internal runtime parameters | 0

## Output parameters

Name | Unit | Description | Default
--- | --- | --- | ---
localG | m/s/s | Gravity vector in guide reference system |
normalTop | 1 | One of several normal vectors used for defining the geometry |
normalBot |  |  |
normalLeft |  |  |
normalRight |  |  |
normalInOut |  |  |
pointTop | 1 | One of several points used for defining the geometry |
pointBot |  |  |
pointLeft |  |  |
pointRight |  |  |
pointIn |  |  |
pointOut |  |  |
rParPtr | * | One of several pointers to reflection parameters used with the ref. functions. |
rUpParPtr |  |  |
rDownParPtr |  |  |

## Links

- Source code for `Pol_guide_vmirror.comp`.

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