StandardDipole Class Reference

Inheritance diagram for StandardDipole:

Collaboration diagram for StandardDipole:

Public Member Functions
	StandardDipole (const ParametersList &params)
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
void	eval () override
	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.

Detailed Description

Definition at line 28 of file StandardDipole.cpp.

Constructor & Destructor Documentation

StandardDipole()

StandardDipole ( const ParametersList &  params )

explicit

Definition at line 30 of file StandardDipole.cpp.

Member Function Documentation

description()

static ParametersDescription description ( )

static

Definition at line 33 of file StandardDipole.cpp.

eval()

void eval ( )

overrideprotectedvirtual

Implements Parameterisation.

Definition at line 43 of file StandardDipole.cpp.

fragmenting()

virtual bool fragmenting ( ) const

virtualinherited

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 )

virtualinherited

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  )

protectedinherited

Definition at line 52 of file Parameterisation.cpp.

setGEGM()

void setGEGM ( double  ge, double  gm  )

protectedinherited

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

inherited

Definition at line 33 of file Parameterisation.cpp.

Member Data Documentation

ff_

FormFactors ff_ {}

protectedinherited

Definition at line 56 of file Parameterisation.h.

mass2_

const double mass2_

protectedinherited

Definition at line 51 of file Parameterisation.h.

mp2_

const double mp2_

protectedinherited

Definition at line 53 of file Parameterisation.h.

mp_

const double mp_

protectedinherited

Definition at line 52 of file Parameterisation.h.

MU

constexpr double MU = 2.792847337

staticconstexprprotectedinherited

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_

protectedinherited

Definition at line 50 of file Parameterisation.h.

q2_

double q2_ {-1.}

protectedinherited

Definition at line 55 of file Parameterisation.h.