ThePEG/Helicity/HelicityDefinitions.h

0001 // -*- C++ -*-
0002 //
0003 // HelicityDefinitions.h is a part of ThePEG - Toolkit for HEP Event Generation
0004 // Copyright (C) 2003-2019 Peter Richardson, Leif Lonnblad
0005 //
0006 // ThePEG is licenced under version 3 of the GPL, see COPYING for details.
0007 // Please respect the MCnet academic guidelines, see GUIDELINES for details.
0008 //
0009 #ifndef THEPEG_HelicityDefinitions_H
0010 #define THEPEG_HelicityDefinitions_H
0011 // This is the declaration of the HelicityDefinitions class.
0012
0013 #include "ThePEG/Config/ThePEG.h"
0014 #include "ThePEG/Utilities/Exception.h"
0015
0016 /** \file HelicityDefinitions.h
0017  *
0018  * This file contains enumerations used by LorentzSpinor and
0019  * LorentzSpinorBar classes.
0020  *
0021  * @see LorentzSpinor
0022  *
0023  * @author Peter Richardson
0024  */
0025
0026 namespace ThePEG {
0027
0028 /**
0029  * The Helicity namespace contains classes for spin representation
0030  * classes in ThePEG.
0031  */
0032 namespace Helicity {
0033
0034 /**
0035  * Enumeration to specify spinor type.
0036  */
0037 enum class SpinorType {
0038   u, /**< u spinor. */
0039   v, /**< v spinor. */
0040   unknown /**< Undefined spinor type. */
0041 };
0042
0043 /** \ingroup Helicity
0044  * Definition of the enumerated values of the phase to include in the
0045  * calculation of the polarization vector.
0046  */
0047 enum VectorPhase {
0048   vector_phase, /**< Include the phase factor.*/
0049   vector_nophase, /**< No phase-factor. */
0050   default_vector_phase=vector_nophase /**< Default option.*/
0051 };
0052
0053 /** @cond EXCEPTIONCLASSES */
0054 /** Exception class used by Helicity classes to signal a logical error. */
0055 class HelicityLogicalError: public Exception {};
0056
0057 /** Exception class used by Helicity classes to signal a inconsistencies. */
0058 class HelicityConsistencyError: public Exception {};
0059 /** @endcond */
0060
0061 }
0062 }
0063
0064 #endif /* THEPEG_HelicityDefinitions_H */