source: HiSusy/trunk/Pythia8/pythia8170/xmldoc/BeamShape.xml @ 1

<chapter name="Beam Shape">

<h2>Beam Shape</h2>

The <aloc href="BeamParameters">Beam Parameters</aloc>
page explains how you can set a momentum spread of the two incoming
beams, and a spread and offset for the location of the interaction
vertex. The spread is based on a simple parametrization in terms of
independent Gaussians, however, which is likely to be too primitive
for realistic applications. 

<p/>
It is therefore possible to define your own class, derived from the 
<code>BeamShape</code> base class, and hand it in to Pythia with the
<code><aloc href="ProgramFlow">
pythia.setBeamShapePtr( BeamShape*)</aloc></code> method. 
Below we describe what such a class has to do. An explicit toy example 
is shown in <code>main23.cc</code>.

<p/>
The <code>BeamShape</code> base class has a very simple structure.
It only has two main virtual methods. The first, <code>init()</code>, is 
used for initialization. The second, <code>pick()</code>, selects
beam momentum and production vertex in the current event.

<method name="BeamShape::BeamShape()"> 
</method>
<methodmore name="virtual BeamShape::~BeamShape()"> 
the constructor and destructor do not need to do anything.
</methodmore>

<method name="virtual void BeamShape::init( Settings& settings, 
Rndm* rndmPtrIn)"> 
the base-class method simply reads in the relevant values stored 
in the <code>Settings</code> data base, and saves a pointer to the 
random-number generator. You are free to write your own 
derived initialization routine, or use the existing one. In the 
latter case you can then give your own modified interpretation 
to the beam spread parameters defined there.
<br/>The two flags <code>Beams:allowMomentumSpread</code> and 
<code>Beams:allowVertexSpread</code> should not be tampered with,
however. These are checked elsewhere to determine whether the beam 
shape should be set or not, whereas the other momentum-spread
and vertex-spread parameters are local to this class.
</method>

<method name="virtual void BeamShape::pick()"> 
this method is the key one to supply in the derived class. Here you 
are free to pick whatever parametrization you desire for beam momenta 
and vertex position, including correlations between the two. 
At the end of the day, you should set a few protected 
<code>double</code> numbers:
<br/><code>deltaPxA, deltaPyA, deltaPzA</code> for the three-momentum 
shift of the first incoming beam, relative to the nominal values;
<br/><code>deltaPxB, deltaPyB, deltaPzB</code> for the three-momentum 
shift of the second incoming beam, relative to the nominal values;
<br/><code>vertexX, vertexY, vertexZ, vertexT</code> for the 
production-vertex position and time.
<br/>As usual, momentum is given in GeV, and space and time in mm,
with <ei>c = 1</ei>. 
</method>

<method name="Vec4 BeamShape::deltaPA()"> 
</method>
<methodmore name="Vec4 BeamShape::deltaPB()"> 
read out the three-momentum shifts for beams A and B that were set by
<code>pick()</code>. The energy components are put to zero at this stage, 
since they are most conveniently calculated after the original and the 
shift three-momenta have been added.
</methodmore>

<method name="Vec4 BeamShape::vertex()">
read out the production-vertex position and time that were set by
<code>pick()</code>. 
</method>

</chapter>

<!-- Copyright (C) 2012 Torbjorn Sjostrand -->