Nucleon electromagnetic form factors parameterisation. More...

#include <CepGen/FormFactors/Parameterisation.h>

Inheritance diagram for Parameterisation:

Collaboration diagram for Parameterisation:

Public Member Functions
	Parameterisation (const ParametersList &)

double	tau (double q2) const
	\(\tau={Q^2}\over{4m_p^2}\) variable definition

virtual const FormFactors &	operator() (double)
	Compute all form factors for a given \(Q^2\) value.

virtual bool	fragmenting () const
	Is the nucleon surviving the exchange?

const std::string &	name () const
	Module unique indexing name.

bool	operator== (const SteeredObject &oth) const
	Equality operator.

bool	operator!= (const SteeredObject &oth) const
	Inequality operator.

const ParametersList &	parameters () const override
	Module user-defined parameters.

virtual void	setParameters (const ParametersList &params) override
	Set module parameters.

void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()

Protected Member Functions
virtual void	eval ()=0
	Local form factors evaluation method.

void	setFEFM (double fe, double fm)
	Set the electromagnetic form factors.

void	setGEGM (double ge, double gm)
	Set the Sachs form factors.

template<typename T >
T	steer (const std::string &key) const
	Retrieve a parameters as previously steered.

template<typename T , typename U >
U	steerAs (const std::string &key) const
	Retrieve a recasted parameters as previously steered.

std::string	steerName () const
	Retrieve module name from parameters.

std::string	steerPath (const std::string &key) const
	Retrieve a path from common search paths.

Protected Attributes
const pdgid_t	pdg_id_
	Incoming beam.

const double	mass2_
	Incoming beam squared mass.

const double	mp_
	Proton mass, in GeV/c \(^2\).

const double	mp2_
	Squared proton mass, in GeV \(^2\)/c \(^4\).

double	q2_ {-1.}
	Virtuality at which the form factors are evaluated.

FormFactors	ff_ {}
	Last form factors computed.

const std::string	name_
	Module unique indexing name.

ParametersList	params_
	Module parameters.

Static Protected Attributes
static constexpr double	MU = 2.792847337
	Proton magnetic moment.

Friends
std::ostream &	operator<< (std::ostream &, const Parameterisation &)
	Friendly printout operator.

Detailed Description

Definition at line 29 of file Parameterisation.h.

Constructor & Destructor Documentation

◆ Parameterisation()

Parameterisation ( const ParametersList & params )

explicit

Definition at line 26 of file Parameterisation.cpp.

Member Function Documentation

◆ description()

ParametersDescription description ( )

static

Definition at line 45 of file Parameterisation.cpp.

◆ eval()

virtual void eval ( )

protectedpure virtual

Implemented in InelasticNucleon, and StandardDipole.

◆ fragmenting()

virtual bool fragmenting ( ) const

virtual

Reimplemented in InelasticNucleon.

Definition at line 40 of file Parameterisation.h.

◆ name()

const std::string & name ( ) const

inherited

Definition at line 42 of file NamedModule.h.

◆ operator!=()

template<typename T >

bool operator!= ( const SteeredObject< T > & oth ) const

inherited

Definition at line 51 of file SteeredObject.h.

◆ operator()()

const FormFactors & operator() ( double q2 )

virtual

Definition at line 35 of file Parameterisation.cpp.

◆ operator==()

template<typename T >

bool operator== ( const SteeredObject< T > & oth ) const

inherited

Definition at line 49 of file SteeredObject.h.

◆ parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

◆ setDescribedParameters()

template<typename T >

void setDescribedParameters ( const ParametersList & params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

◆ setFEFM()

void setFEFM	(	double	fe,
		double	fm
	)

protected

Definition at line 52 of file Parameterisation.cpp.

◆ setGEGM()

void setGEGM	(	double	ge,
		double	gm
	)

protected

Definition at line 60 of file Parameterisation.cpp.

◆ setParameters()

template<typename T >

virtual void setParameters ( const ParametersList & params )

overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

Definition at line 62 of file SteeredObject.h.

◆ steer()

template<typename T >

T steer ( const std::string & key ) const

protectedinherited

Definition at line 39 of file Steerable.h.

◆ steerAs()

template<typename T , typename U >

U steerAs ( const std::string & key ) const

protectedinherited

Definition at line 44 of file Steerable.h.

◆ steerName()

std::string steerName ( ) const

protectedinherited

Definition at line 48 of file Steerable.h.

◆ steerPath()

std::string steerPath ( const std::string & key ) const

protectedinherited

Definition at line 30 of file Steerable.cpp.

◆ tau()

double tau ( double q2 ) const

Definition at line 33 of file Parameterisation.cpp.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Parameterisation &	ff
	)

friend

Definition at line 70 of file Parameterisation.cpp.

Member Data Documentation

◆ ff_

FormFactors ff_ {}

protected

Definition at line 56 of file Parameterisation.h.

◆ mass2_

const double mass2_

protected

Definition at line 51 of file Parameterisation.h.

◆ mp2_

const double mp2_

protected

Definition at line 53 of file Parameterisation.h.

◆ mp_

const double mp_

protected

Definition at line 52 of file Parameterisation.h.

◆ MU

constexpr double MU = 2.792847337

staticconstexprprotected

Definition at line 43 of file Parameterisation.h.

◆ name_

const std::string name_

protectedinherited

Definition at line 45 of file NamedModule.h.

◆ params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.

◆ pdg_id_

const pdgid_t pdg_id_

protected

Definition at line 50 of file Parameterisation.h.

◆ q2_

double q2_ {-1.}

protected

Definition at line 55 of file Parameterisation.h.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Parameterisation()

Member Function Documentation

◆ description()

◆ eval()

◆ fragmenting()

◆ name()

◆ operator!=()

◆ operator()()

◆ operator==()

◆ parameters()

◆ setDescribedParameters()

◆ setFEFM()

◆ setGEGM()

◆ setParameters()

◆ steer()

◆ steerAs()

◆ steerName()

◆ steerPath()

◆ tau()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ ff_

◆ mass2_

◆ mp2_

◆ mp_

◆ MU

◆ name_

◆ params_

◆ pdg_id_

◆ q2_