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: Virtual_input

[ Identification | Description | Input parameters | Links ]

The Virtual_input Component

Source-like component that generates neutron events from an ascii 'virtual source' filename.

Identification

  • Site:
  • Author: E. Farhi
  • Origin: ILL
  • Date: Sep 28th, 2001

Description

This component reads neutron events stored from a file, and sends them into
the instrument. It thus replaces a Source component, using a previously
computed neutron set. The 'source' file type is an ascii text file with the
format listed below. The number of neutron events for the
simulation is set to the length of the 'source' file times the
repetition parameter 'repeat_count' (1 by default).
It is particularly useful to generate a virtual source at a point that few
neutron reach. A long simulation will then only be performed once, to create
the 'source' filename. Further simulations are much faster if they start from
this low flux position with the 'source' filename.

The input file format is:
text column formatted with lines containing 11 values in the order:
p x y z vx vy vz t sx sy sz stored into about 83 bytes/n.

%BUGS
We recommend NOT to use parallel execution (MPI) with this component. If you
need to, set parameter 'smooth=1'.

EXAMPLE:
To create a 'source' file collecting all neutron states, use:
COMPONENT MySourceCreator = Virtual_output(filename = "MySource.list")
at the position where will be the Virtual_input.
Then unactivate the part of the simulation description before (and including)
the component MySourceCreator. Put the new instrument source:
COMPONENT Source = Virtual_input(filename="MySource.list")
at the same position as 'MySourceCreator'.
A Vitess filename may be obtained from the 'Vitess_output' component or from a
Vitess simulation (104 bytes per neutron) and read with Vitess_input.

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
filenamestrName of the neutron input file. Empty string "" unactivates component0
verbose0/1Display additional information about source, recommended0
repeat_count1Number of times the source must be generated/repeated1
smooth0/1Smooth sparsed event files for filename repetitions. Use this option with MPI. This will apply gaussian distributions around initial events from the file1
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