File: WidthGenerator.h

package info (click to toggle)
thepeg 1.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 9,312 kB
  • ctags: 11,509
  • sloc: cpp: 57,129; sh: 11,315; java: 3,212; lisp: 1,402; makefile: 830; ansic: 58; perl: 3
file content (121 lines) | stat: -rw-r--r-- 3,204 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// -*- C++ -*-
//
// WidthGenerator.h is a part of ThePEG - Toolkit for HEP Event Generation
// Copyright (C) 1999-2011 Leif Lonnblad
//
// ThePEG is licenced under version 2 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef ThePEG_WidthGenerator_H
#define ThePEG_WidthGenerator_H
// This is the declaration of the WidthGenerator class.

#include "ThePEG/Config/ThePEG.h"
#include "WidthGenerator.fh"
#include "ThePEG/Interface/Interfaced.h"
#include "ThePEG/Utilities/Selector.h"
#include "ThePEG/PDT/DecayMode.fh"

namespace ThePEG {

/**
 * WidthGenerator is an abstract base class to be used to encapsulate
 * models for giving the partial decay width of a ParticleData given
 * the specified DecayModes.
 *
 * @see \ref WidthGeneratorInterfaces "The interfaces"
 * defined for WidthGenerator.
 * @see ParticleData
 * @see DecayMode
 */
class WidthGenerator: public Interfaced {

public:

  /** A selector of <code>DecayModes</code>s weighted by their
   *  branching ratios. */
  typedef Selector<tDMPtr> DecayMap;

public:

  /** @name Virtual functions to be overridden by sub-classes. */
  //@{
  /**
   * Return true if this object can be used for the given particle
   * type with the given decay map.
   */
  virtual bool accept(const ParticleData &) const = 0;

  /**
   * Given a Particle, calculate a width.
   */
  Energy width(const Particle &) const;

  /**
   * Given a particle type and a mass of an instance of that particle
   * type, calculate a width.
   */
  virtual Energy width(const ParticleData &, Energy m) const = 0;

  /**
   * Given a particle type and a mass and a width of an instance of
   * that particle type, generate a life time.
   */
  virtual Length lifeTime(const ParticleData &, Energy m, Energy w) const;

  /**
   * Return decay map for the given particle type.
   */
  virtual DecayMap rate(const ParticleData &) const = 0;

  /**
   * Return a decay map for a given Particle instance.
   */
  virtual DecayMap rate(const Particle &);
  //@}

public:

  /**
   * Standard Init function used to initialize the interface.
   */
  static void Init();

private:

  /**
   * The static object used to initialize the description of this class.
   * Indicates that this is an abstract class without persistent data.
   */
  static AbstractNoPIOClassDescription<WidthGenerator> initWidthGenerator;

  /**
   *  Private and non-existent assignment operator.
   */
  WidthGenerator & operator=(const WidthGenerator &);

};

/** @cond TRAITSPECIALIZATIONS */

/** This template specialization informs ThePEG about the base classes
 *  of WidthGenerator. */
template <>
struct BaseClassTrait<WidthGenerator,1>: public ClassTraitsType {
  /** Typedef of the first base class of WidthGenerator. */
  typedef Interfaced NthBase;
};

/** This template specialization informs ThePEG about the name of the
 *  WidthGenerator class. */
template <>
struct ClassTraits<WidthGenerator>: public ClassTraitsBase<WidthGenerator> {
  /** Return a platform-independent class name */
  static string className() { return "ThePEG::WidthGenerator"; }
};

/** @endcond */

}

#endif /* ThePEG_WidthGenerator_H */