Pure abstract base class. Defines the ChannelCalculatorI interface to be implemented by BRCalculator Algorithm for calculating HNL production and decay rates. More...

#include <HNLChannelCalculatorI.h>

Inheritance diagram for genie::hnl::ChannelCalculatorI:

[legend]

Collaboration diagram for genie::hnl::ChannelCalculatorI:

[legend]

Public Member Functions
virtual void	Configure (const Registry &config)=0

virtual void	Configure (string config)=0

virtual double	KinematicScaling (HNLProd_t hnlprod) const =0

virtual double	DecayWidth (HNLDecayMode_t hnldm) const =0

Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()

virtual void	FindConfig (void)

virtual const Registry &	GetConfig (void) const

Registry *	GetOwnedConfig (void)

virtual const AlgId &	Id (void) const
	Get algorithm ID. More...

virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status. More...

virtual bool	AllowReconfig (void) const

virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm. More...

virtual void	SetId (const AlgId &id)
	Set algorithm ID. More...

virtual void	SetId (string name, string config)

const Algorithm *	SubAlg (const RgKey &registry_key) const

void	AdoptConfig (void)

void	AdoptSubstructure (void)

virtual void	Print (ostream &stream) const
	Print algorithm info. More...

Protected Member Functions
	ChannelCalculatorI ()

	ChannelCalculatorI (string name)

	ChannelCalculatorI (string name, string config)

Protected Member Functions inherited from genie::Algorithm
	Algorithm ()

	Algorithm (string name)

	Algorithm (string name, string config)

void	Initialize (void)

void	DeleteConfig (void)

void	DeleteSubstructure (void)

Registry *	ExtractLocalConfig (const Registry &in) const

Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key. More...

template<class T >
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const

template<class T >
bool	GetParamDef (const RgKey &name, T &p, const T &def) const

template<class T >
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters. More...

int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const

template<class T >
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters. More...

template<class T >
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const

int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const

int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership More...

int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership More...

int	MergeTopRegistry (const Registry &r)

int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships. More...

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)

static string	BuildParamVectSizeKey (const std::string &comm_name)

static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)

static string	BuildParamMatRowSizeKey (const std::string &comm_name)

static string	BuildParamMatColSizeKey (const std::string &comm_name)

Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig

bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...) More...

AlgId	fID
	algorithm name and configuration set More...

vector< Registry * >	fConfVect

vector< bool >	fOwnerships
	ownership for every registry in fConfVect More...

AlgStatus_t	fStatus
	algorithm execution status More...

AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool) More...

Detailed Description

Pure abstract base class. Defines the ChannelCalculatorI interface to be implemented by BRCalculator Algorithm for calculating HNL production and decay rates.

Author: John Plows <komninos-john.plows physics.ox.ac.uk> University of Oxford

based off AxialFormFactorModelI by Aarom Meyer <asmeyer2012 uchicago.edu>

Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool

Created:: November 17, 2022

License:: Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 39 of file HNLChannelCalculatorI.h.

Constructor & Destructor Documentation

ChannelCalculatorI::ChannelCalculatorI ( )

protected

Definition at line 17 of file HNLChannelCalculatorI.cxx.

                                        : Algorithm()
 {
 
 }

ChannelCalculatorI::ChannelCalculatorI ( string name )

protected

Definition at line 22 of file HNLChannelCalculatorI.cxx.

                                                   : Algorithm(name)
 {
 
 }

ChannelCalculatorI::ChannelCalculatorI	(	string	name,
		string	config
	)

protected

Definition at line 27 of file HNLChannelCalculatorI.cxx.

                                                                  : 
   Algorithm(name, config)
 {
 
 }

Member Function Documentation

virtual void genie::hnl::ChannelCalculatorI::Configure ( const Registry & config )

pure virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Implemented in genie::hnl::BRCalculator.

virtual void genie::hnl::ChannelCalculatorI::Configure ( string config )

pure virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Reimplemented from genie::Algorithm.

Implemented in genie::hnl::BRCalculator.

virtual double genie::hnl::ChannelCalculatorI::DecayWidth ( HNLDecayMode_t hnldm ) const

pure virtual

Implemented in genie::hnl::BRCalculator.

virtual double genie::hnl::ChannelCalculatorI::KinematicScaling ( HNLProd_t hnlprod ) const

pure virtual

Implemented in genie::hnl::BRCalculator.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation