Parameterisation Class Reference

Nucleon electromagnetic form factors parameterisation. More...

#include <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
	Will the nucleon survive the exchange?
pdgid_t	pdgId () const
	Incoming particle's PDG identifier.
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.
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 recast 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 28 of file Parameterisation.h.

Constructor & Destructor Documentation

Parameterisation()

Parameterisation ( const ParametersList & )

explicit

Member Function Documentation

description()

static ParametersDescription description ( )

static

eval()

virtual void eval ( )

protectedpure virtual

fragmenting()

virtual bool fragmenting ( ) const

virtual

Definition at line 39 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 50 of file SteeredObject.h.

operator()()

virtual const FormFactors & operator() ( double )

virtual

operator==()

template<typename T >

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

inherited

Definition at line 48 of file SteeredObject.h.

parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 53 of file SteeredObject.h.

pdgId()

pdgid_t pdgId

(

)

const

Definition at line 40 of file Parameterisation.h.

setDescribedParameters()

template<typename T >

void setDescribedParameters ( const ParametersList & params_orig )

inherited

Definition at line 72 of file SteeredObject.h.

setFEFM()

void setFEFM ( double fe, double fm )

protected

setGEGM()

void setGEGM ( double ge, double gm )

protected

setParameters()

template<typename T >

void setParameters ( const ParametersList & )

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 61 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

tau()

double tau

(

double

q2

)

const

Friends And Related Symbol Documentation

operator<<

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

friend

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.