The GeneralFFVVertex class is the base class for all helicity amplitude vertices which use a general form of the fermion-fermion-vector vertex. More...

#include <GeneralFFVVertex.h>

Inheritance diagram for ThePEG::Helicity::GeneralFFVVertex:

[legend]

Public Member Functions
Complex	evaluate (Energy2 q2, const SpinorWaveFunction &sp1, const SpinorBarWaveFunction &sbar2, const VectorWaveFunction &vec3)
	Members to calculate the helicity amplitude expressions for vertices and off-shell particles.

SpinorBarWaveFunction	evaluate (Energy2 q2, int iopt, tcPDPtr out, const SpinorBarWaveFunction &sbar2, const VectorWaveFunction &vec3, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)
	Evaluate the off-shell barred spinor coming from the vertex.

VectorWaveFunction	evaluate (Energy2 q2, int iopt, tcPDPtr out, const SpinorWaveFunction &sp1, const SpinorBarWaveFunction &sbar2, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)
	Evaluate the off-shell vector coming from the vertex.

SpinorWaveFunction	evaluate (Energy2 q2, int iopt, tcPDPtr out, const SpinorWaveFunction &sp1, const VectorWaveFunction &vec3, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)
	Evaluate the off-shell spinor coming from the vertex.

virtual void	setCoupling (Energy2 q2, tcPDPtr part1, tcPDPtr part2, tcPDPtr part3)=0
	Set coupling methods.

virtual void	setCoupling (Energy2, tcPDPtr, tcPDPtr, tcPDPtr, tcPDPtr)
	Dummy setCouplings for a four point interaction This method is virtual and must be implemented in classes inheriting from this.

const Complex &	getLeft ()
	Get the Couplings.

const Complex &	getRight ()
	Get the right coupling.

const complex< InvEnergy >	getLeftSigma ()
	Get the left coupling for the \(\sigma^{\mu\nu}\) term.

const complex< InvEnergy >	getRightSigma ()
	Get the right coupling for the \(\sigma^{\mu\nu}\) term.

Public Member Functions inherited from ThePEG::Helicity::AbstractFFVVertex
	AbstractFFVVertex ()
	Default constructor.

virtual Complex	evaluate (Energy2 q2, const SpinorWaveFunction &sp1, const SpinorBarWaveFunction &sbar2, const VectorWaveFunction &vec3)=0
	Members to calculate the helicity amplitude expressions for vertices and off-shell particles.

virtual SpinorBarWaveFunction	evaluate (Energy2 q2, int iopt, tcPDPtr out, const SpinorBarWaveFunction &sbar2, const VectorWaveFunction &vec3, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)=0
	Evaluate the off-shell barred spinor coming from the vertex.

virtual VectorWaveFunction	evaluate (Energy2 q2, int iopt, tcPDPtr out, const SpinorWaveFunction &sp1, const SpinorBarWaveFunction &sbar2, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)=0
	Evaluate the off-shell vector coming from the vertex.

virtual SpinorWaveFunction	evaluate (Energy2 q2, int iopt, tcPDPtr out, const SpinorWaveFunction &sp1, const VectorWaveFunction &vec3, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)=0
	Evaluate the off-shell spinor coming from the vertex.

virtual SpinorWaveFunction	evaluateSmall (Energy2 q2, int iopt, tcPDPtr out, const SpinorWaveFunction &sp1, const VectorWaveFunction &vec3, unsigned int fhel, unsigned int vhel, double ctheta, double phi, double stheta, bool includeEikonal=true, SmallAngleDirection direction=PostiveZDirection, Energy mass=-GeV, Energy width=-GeV)
	Special members for off-shell fermion wavefunctions with massless gauge bosons at small angles in the small angle limit for numerical accuracy.

virtual SpinorBarWaveFunction	evaluateSmall (Energy2 q2, int iopt, tcPDPtr out, const SpinorBarWaveFunction &sbar2, const VectorWaveFunction &vec3, unsigned int fhel, unsigned int vhel, double ctheta, double phi, double stheta, bool includeEikonal=true, SmallAngleDirection direction=PostiveZDirection, Energy mass=-GeV, Energy width=-GeV)
	Small angle approx for an off-shell spinor.

Public Member Functions inherited from ThePEG::Helicity::VertexBase
	VertexBase (VertexType::T name, bool kine=false)
	Constructor for \(n\)-point vertices.

double	strongCoupling (Energy2 q2) const
	Strong coupling.

double	electroMagneticCoupling (Energy2 q2) const
	Electromagnetic coupling.

double	weakCoupling (Energy2 q2) const
	Weak coupling.

double	sin2ThetaW () const

bool	kinematics () const
	Whether or not to calculate the kinematics invariants.

void	kinematics (bool kine)
	Set whether or not to calculate the kinematics invariants.

void	calculateKinematics (const Lorentz5Momentum &p0, const Lorentz5Momentum &p1, const Lorentz5Momentum &p2)
	Calculate the kinematics for a 3-point vertex.

void	calculateKinematics (const Lorentz5Momentum &p0, const Lorentz5Momentum &p1, const Lorentz5Momentum &p2, const Lorentz5Momentum &p3)
	Calculate the kinematics for a 4-point vertex.

void	calculateKinematics (const vector< Lorentz5Momentum > &p)
	Calculate the kinematics for a n-point vertex.

Energy2	invariant (unsigned int ix, unsigned int iy) const
	Get one of the kinematic invariants.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

unsigned int	size () const
	Access to the particle information.

bool	isIncoming (tPDPtr p) const
	Is a particle allowed as an incoming particle?

bool	isOutgoing (tPDPtr p) const
	Is a particle allowed as an outgoing particle?

const set< tPDPtr > &	incoming () const
	Get the list of incoming particles.

const set< tPDPtr > &	outgoing () const
	Get the list of outgoing particles.

Complex	norm () const
	Get the coupling.

vector< long >	search (unsigned int ilist, long id) const
	Function to search the list.

vector< tPDPtr >	search (unsigned int ilist, tcPDPtr id) const
	Function to search the list.

bool	allowed (long id1, long id2, long id3, long id4=0) const
	Is a given combination allowed.

VertexType::T	getName () const
	Get name of Vertex.

unsigned int	getNpoint () const
	Get number of lines on Vertex.

int	orderInGem () const
	Get the order in \(g_EM\).

int	orderInGs () const
	Get the order in \(g_s\).

int	orderInCoupling (CouplingType::T cType) const
	Get the order in a specific coupling.

int	orderInAllCouplings () const
	Get the total order of the vertex.

ColourStructure::T	colourStructure () const
	Get the colour structure.

Public Member Functions inherited from ThePEG::Interfaced
virtual	~Interfaced ()
	Empty virtual destructor.

virtual bool	defaultInit ()
	Functions which are to be used during the actual event generation, after the setup is complete.

PPtr	getParticle (PID) const
	Create a new Particle instance given a id number.

PDPtr	getParticleData (PID) const
	Return a pointer to the ParticleData object corresponding to the given id number.

bool	used () const
	Returns true if this object has actally been used.

void	useMe () const
	Should be called to indicate that this object has actually been used.

tEGPtr	generator () const
	Return a pointer to the EventGenerator controlling the run.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

Public Member Functions inherited from ThePEG::InterfacedBase
virtual	~InterfacedBase ()
	The virtual (empty) destructor;.

string	fullName () const
	Returns the full name of this object including its path, e.g.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

void	update ()
	Calls the doupdate() function with recursion prevention.

void	init ()
	Calls the doinit() function with recursion prevention.

virtual bool	preInitialize () const
	Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).

void	initrun ()
	Calls the doinitrun() function with recursion prevention.

void	finish ()
	Calls the dofinish() function with recursion prevention.

void	touch ()
	This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.

void	reset ()
	Set the state of this object to uninitialized.

void	clear ()
	Calls reset() and unTouch().

InitState	state () const
	Return the state of initialization of this object.

bool	locked () const
	Return true if the BaseRepository is not allowed to change the state of this object.

bool	touched () const
	Return true if the state of this object has been changed since the last call to update().

virtual IBPtr	fullclone () const
	Return a full clone of this object possibly doing things to the clone to make it sane.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Base
virtual	~Base ()
	The virtual destructor.

void	debug () const
	Print out debugging information for this object on std::cerr.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType	referenceCount () const
	Return the reference count.

Public Member Functions inherited from ThePEG::Named
	Named (const string &newName=string())
	Constructor with name.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Static Public Member Functions
static void	Init ()
	Standard Init function used to initialize the interfaces.

Static Public Member Functions inherited from ThePEG::Helicity::AbstractFFVVertex
static void	Init ()
	The standard Init function used to initialize the interfaces.

Static Public Member Functions inherited from ThePEG::Helicity::VertexBase
static void	Init ()
	Standard Init function used to initialize the interfaces.

Static Public Member Functions inherited from ThePEG::Interfaced
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::InterfacedBase
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::Base
static void	Init ()
	The standard Init function used to initialize the interfaces.

Protected Member Functions
void	setLeft (const Complex &in)
	Set the couplings.

void	setRight (const Complex &in)
	Set the right coupling.

void	setLeftSigma (const complex< InvEnergy > &in)
	Set the left coupling for the \(\sigma^{\mu\nu}\) term.

void	setRightSigma (const complex< InvEnergy > &in)
	Set the right coupling for the \(\sigma^{\mu\nu}\) term.

Protected Member Functions inherited from ThePEG::Helicity::VertexBase
virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	rebind (const TranslationMap &trans)
	Rebind pointer to other Interfaced objects.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

void	addToList (const vector< long > &ids)
	Members to set-up the particles.

void	addToList (long ida, long idb, long idc, long idd=0)
	Set up the lists of outer particles for the three-/four-point vertex.

void	norm (const Complex &coup)
	Members for the amplitude calculations.

virtual Complex	propagator (int iopt, Energy2 q2, tcPDPtr part, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)
	Calculate the propagator for a diagram.

Complex	normPropagator (int iopt, Energy2 q2, tcPDPtr part, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)
	Calculate propagator multiplied by coupling.

void	orderInGem (int order)
	Set the order in \(g_EM\).

void	orderInGs (int order)
	Set the order in \(g_s\).

void	orderInCoupling (CouplingType::T cType, int order)
	Set the order in a specifc type of coupling.

void	colourStructure (ColourStructure::T structure)
	Set the colour structure.

Protected Member Functions inherited from ThePEG::Interfaced
void	reporeg (IBPtr object, string name) const
	Register the given object in the Repository with the given name in a subdirectory with the same name as this object.

template<typename PtrT >
bool	setDefaultReference (PtrT &ptr, string classname, string objectname)
	If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.

	Interfaced ()
	Protected default constructor.

	Interfaced (const string &newName)
	Protected constructor taking a name as argument.

	Interfaced (const Interfaced &i)
	Protected copy-constructor.

void	setGenerator (tEGPtr generator)
	Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.

Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	doinitrun ()
	Initialize this object.

virtual void	dofinish ()
	Finalize this object.

virtual IBPtr	clone () const =0
	Return a simple clone of this object.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Private Member Functions
GeneralFFVVertex &	operator= (const GeneralFFVVertex &)=delete
	Private and non-existent assignment operator.

Private Attributes
Complex	_left
	Left \(\gamma^\mu\) coupling.

Complex	_right
	Right \(\gamma^\mu\) coupling.

complex< InvEnergy >	_leftSigma
	Left \(\sigma^{\mu\nu}\) coupling.

complex< InvEnergy >	_rightSigma
	Right \(\sigma^{\mu\nu}\) coupling.

Additional Inherited Members
Public Types inherited from ThePEG::Helicity::AbstractFFVVertex
enum	SmallAngleDirection { NegativeZDirection = -1 , PostiveZDirection = 1 }
	Enum for the direction in the small angle limit. More...

Public Types inherited from ThePEG::InterfacedBase
enum	InitState { initializing = -1 , uninitialized = 0 , initialized = 1 , runready = 2 }
	Enumeration reflecting the state of an InterfacedBase object. More...

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType
	The integer type used for counting.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

Static Protected Member Functions inherited from ThePEG::Interfaced
static void	registerRepository (IBPtr)
	Register an Interfaced object with the Repository.

static void	registerRepository (IBPtr, string newName)
	Register an Interfaced object with the Repository, giving it a name.

Detailed Description

The GeneralFFVVertex class is the base class for all helicity amplitude vertices which use a general form of the fermion-fermion-vector vertex.

Any such vertices should inherit from this class and implement the virtual setcoupling member function. The base AbstractFFVVertex class is used to store the particles allowed to interact at the vertex.

The form of the vertex is

\[ic\bar{f_2}\gamma^\mu a^\lambda P_\lambda f_1\epsilon_{3\mu}\]

See also: AbstractFFVVertex

Definition at line 38 of file GeneralFFVVertex.h.

Member Function Documentation

◆ evaluate() [1/4]

Complex ThePEG::Helicity::GeneralFFVVertex::evaluate	(	Energy2	q2,
		const SpinorWaveFunction &	sp1,
		const SpinorBarWaveFunction &	sbar2,
		const VectorWaveFunction &	vec3
	)

virtual

Members to calculate the helicity amplitude expressions for vertices and off-shell particles.

Evalulate the vertex.

Parameters

q2	The scale \(q^2\) for the coupling at the vertex.
sp1	The wavefunction for the ferimon.
sbar2	The wavefunction for the antifermion.
vec3	The wavefunction for the vector.

Implements ThePEG::Helicity::AbstractFFVVertex.

◆ evaluate() [2/4]

SpinorBarWaveFunction ThePEG::Helicity::GeneralFFVVertex::evaluate	(	Energy2	q2,
		int	iopt,
		tcPDPtr	out,
		const SpinorBarWaveFunction &	sbar2,
		const VectorWaveFunction &	vec3,
		complex< Energy >	mass = `-GeV`,
		complex< Energy >	width = `-GeV`
	)

virtual

Evaluate the off-shell barred spinor coming from the vertex.

Parameters

q2	The scale \(q^2\) for the coupling at the vertex.
iopt	Option of the shape of the Breit-Wigner for the off-shell barred spinor.
out	The ParticleData pointer for the off-shell barred spinor.
sbar2	The wavefunction for the antifermion.
vec3	The wavefunction for the vector.
mass	The mass of the off-shell particle if not taken from the ParticleData object
width	The width of the off-shell particle if not taken from the ParticleData object

Implements ThePEG::Helicity::AbstractFFVVertex.

◆ evaluate() [3/4]

VectorWaveFunction ThePEG::Helicity::GeneralFFVVertex::evaluate	(	Energy2	q2,
		int	iopt,
		tcPDPtr	out,
		const SpinorWaveFunction &	sp1,
		const SpinorBarWaveFunction &	sbar2,
		complex< Energy >	mass = `-GeV`,
		complex< Energy >	width = `-GeV`
	)

virtual

Evaluate the off-shell vector coming from the vertex.

Parameters

q2	The scale \(q^2\) for the coupling at the vertex.
iopt	Option of the shape of the Breit-Wigner for the off-shell vector.
out	The ParticleData pointer for the off-shell vector.
sp1	The wavefunction for the ferimon.
sbar2	The wavefunction for the antifermion.
mass	The mass of the off-shell particle if not taken from the ParticleData object
width	The width of the off-shell particle if not taken from the ParticleData object

Implements ThePEG::Helicity::AbstractFFVVertex.

◆ evaluate() [4/4]

SpinorWaveFunction ThePEG::Helicity::GeneralFFVVertex::evaluate	(	Energy2	q2,
		int	iopt,
		tcPDPtr	out,
		const SpinorWaveFunction &	sp1,
		const VectorWaveFunction &	vec3,
		complex< Energy >	mass = `-GeV`,
		complex< Energy >	width = `-GeV`
	)

virtual

Evaluate the off-shell spinor coming from the vertex.

Parameters

q2	The scale \(q^2\) for the coupling at the vertex.
iopt	Option of the shape of the Breit-Wigner for the off-shell spinor.
out	The ParticleData pointer for the off-shell spinor.
sp1	The wavefunction for the ferimon.
vec3	The wavefunction for the vector.
mass	The mass of the off-shell particle if not taken from the ParticleData object
width	The width of the off-shell particle if not taken from the ParticleData object

Implements ThePEG::Helicity::AbstractFFVVertex.

◆ getLeft()

const Complex & ThePEG::Helicity::GeneralFFVVertex::getLeft ( )

inline

Get the Couplings.

Get the left coupling.

Definition at line 147 of file GeneralFFVVertex.h.

References _left.

◆ getLeftSigma()

const complex< InvEnergy > ThePEG::Helicity::GeneralFFVVertex::getLeftSigma ( )

inline

Get the left coupling for the \(\sigma^{\mu\nu}\) term.

Definition at line 157 of file GeneralFFVVertex.h.

References _leftSigma.

◆ getRight()

const Complex & ThePEG::Helicity::GeneralFFVVertex::getRight ( )

inline

Get the right coupling.

Definition at line 152 of file GeneralFFVVertex.h.

References _right.

◆ getRightSigma()

const complex< InvEnergy > ThePEG::Helicity::GeneralFFVVertex::getRightSigma ( )

inline

Get the right coupling for the \(\sigma^{\mu\nu}\) term.

Definition at line 162 of file GeneralFFVVertex.h.

References _rightSigma.

◆ setCoupling() [1/2]

virtual void ThePEG::Helicity::GeneralFFVVertex::setCoupling	(	Energy2	q2,
		tcPDPtr	part1,
		tcPDPtr	part2,
		tcPDPtr	part3
	)

pure virtual

Set coupling methods.

Calculate the couplings for a three point interaction. This method is virtual and must be implemented in classes inheriting from this.

Parameters

q2	The scale \(q^2\) for the coupling at the vertex.
part1	The ParticleData pointer for the first particle.
part2	The ParticleData pointer for the second particle.
part3	The ParticleData pointer for the third particle.

Implements ThePEG::Helicity::VertexBase.

◆ setCoupling() [2/2]

virtual void ThePEG::Helicity::GeneralFFVVertex::setCoupling	(	Energy2	,
		tcPDPtr	,
		tcPDPtr	,
		tcPDPtr	,
		tcPDPtr
	)

inlinevirtual

Dummy setCouplings for a four point interaction This method is virtual and must be implemented in classes inheriting from this.

Implements ThePEG::Helicity::VertexBase.

Definition at line 135 of file GeneralFFVVertex.h.

◆ setLeft()

void ThePEG::Helicity::GeneralFFVVertex::setLeft ( const Complex & in )

inlineprotected

Set the couplings.

Set the left coupling.

Definition at line 174 of file GeneralFFVVertex.h.

References _left.

◆ setLeftSigma()

void ThePEG::Helicity::GeneralFFVVertex::setLeftSigma ( const complex< InvEnergy > & in )

inlineprotected

Set the left coupling for the \(\sigma^{\mu\nu}\) term.

Definition at line 184 of file GeneralFFVVertex.h.

References _leftSigma.

◆ setRight()

void ThePEG::Helicity::GeneralFFVVertex::setRight ( const Complex & in )

inlineprotected

Set the right coupling.

Definition at line 179 of file GeneralFFVVertex.h.

References _right.

◆ setRightSigma()

void ThePEG::Helicity::GeneralFFVVertex::setRightSigma ( const complex< InvEnergy > & in )

inlineprotected

Set the right coupling for the \(\sigma^{\mu\nu}\) term.

Definition at line 189 of file GeneralFFVVertex.h.

References _rightSigma.

Member Data Documentation

◆ _left

Complex ThePEG::Helicity::GeneralFFVVertex::_left

private

Left \(\gamma^\mu\) coupling.

Definition at line 204 of file GeneralFFVVertex.h.

Referenced by getLeft(), and setLeft().

◆ _leftSigma

complex<InvEnergy> ThePEG::Helicity::GeneralFFVVertex::_leftSigma

private

Left \(\sigma^{\mu\nu}\) coupling.

Definition at line 214 of file GeneralFFVVertex.h.

Referenced by getLeftSigma(), and setLeftSigma().

◆ _right

Complex ThePEG::Helicity::GeneralFFVVertex::_right

private

Right \(\gamma^\mu\) coupling.

Definition at line 209 of file GeneralFFVVertex.h.

Referenced by getRight(), and setRight().

◆ _rightSigma

complex<InvEnergy> ThePEG::Helicity::GeneralFFVVertex::_rightSigma

private

Right \(\sigma^{\mu\nu}\) coupling.

Definition at line 219 of file GeneralFFVVertex.h.

Referenced by getRightSigma(), and setRightSigma().

The documentation for this class was generated from the following file:

GeneralFFVVertex.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ evaluate() [1/4]

◆ evaluate() [2/4]

◆ evaluate() [3/4]

◆ evaluate() [4/4]

◆ getLeft()

◆ getLeftSigma()

◆ getRight()

◆ getRightSigma()

◆ setCoupling() [1/2]

◆ setCoupling() [2/2]

◆ setLeft()

◆ setLeftSigma()

◆ setRight()

◆ setRightSigma()

Member Data Documentation

◆ _left

◆ _leftSigma

◆ _right

◆ _rightSigma