class Gambit::SubSpectrumContents
Base class for defining the required contents of a SubSpectrum object.
#include <subspectrum_contents.hpp>
Inherited by Gambit::SpectrumContents::DMEFT, Gambit::SpectrumContents::DMsimpVectorMedDiracDM, Gambit::SpectrumContents::DMsimpVectorMedMajoranaDM, Gambit::SpectrumContents::DMsimpVectorMedScalarDM, Gambit::SpectrumContents::DMsimpVectorMedVectorDM, Gambit::SpectrumContents::DiracSingletDM_Z2, Gambit::SpectrumContents::MDM, Gambit::SpectrumContents::MSSM, Gambit::SpectrumContents::MajoranaSingletDM_Z2, Gambit::SpectrumContents::SM, Gambit::SpectrumContents::SMHiggs, Gambit::SpectrumContents::SM_slha, Gambit::SpectrumContents::ScalarSingletDM_Z2, Gambit::SpectrumContents::ScalarSingletDM_Z3, Gambit::SpectrumContents::SubGeVDM, Gambit::SpectrumContents::VectorSingletDM_Z2
Public Functions
Name | |
---|---|
std::string | getName() const |
std::vector< SpectrumParameter > | all_parameters() const Function to retreive all parameters. |
std::vector< SpectrumParameter > | all_parameters_with_tag(Par::Tags tag) const Function to retreive all parameters matching a certain tag. |
std::vector< SpectrumParameter > | all_parameters_with_tag_and_shape(Par::Tags tag, std::vector< int > & shape) const Function to retrieve all parameters matching a certain tag and shape. |
std::vector< SpectrumParameter > | all_BSM_parameters() const Function to retrieve all parameters whose blockName is not SMINPUTS, YUKAWA, CKMBLOCK, or empty. |
void | verify_contents(const SubSpectrum & spec) const Function to verify that a SubSpectrum wrapper contains everything that this class says it should. |
Protected Functions
Name | |
---|---|
void | addParameter(const Par::Tags tag, const std::string & name, const std::vector< int > & shape =initVector(1), const std::string & blockname ="", const int index =0) Add a parameter to the Contents object. |
void | setName(const std::string & name) Set the name of this Contents object (i.e. the name of the model to which this spectrum data applies) |
Public Functions Documentation
function getName
inline std::string getName() const
function all_parameters
std::vector< SpectrumParameter > all_parameters() const
Function to retreive all parameters.
function all_parameters_with_tag
std::vector< SpectrumParameter > all_parameters_with_tag(
Par::Tags tag
) const
Function to retreive all parameters matching a certain tag.
function all_parameters_with_tag_and_shape
std::vector< SpectrumParameter > all_parameters_with_tag_and_shape(
Par::Tags tag,
std::vector< int > & shape
) const
Function to retrieve all parameters matching a certain tag and shape.
function all_BSM_parameters
std::vector< SpectrumParameter > all_BSM_parameters() const
Function to retrieve all parameters whose blockName is not SMINPUTS, YUKAWA, CKMBLOCK, or empty.
Function to retrieve all parameters whose blockname is not SMINPUTS, YUKAWA, CKMBLOCK, or empty.
function verify_contents
void verify_contents(
const SubSpectrum & spec
) const
Function to verify that a SubSpectrum wrapper contains everything that this class says it should.
Verify that the supplied SubSpectrum object conforms to the requirements specified by the Contents class.
Protected Functions Documentation
function addParameter
void addParameter(
const Par::Tags tag,
const std::string & name,
const std::vector< int > & shape =initVector(1),
const std::string & blockname ="",
const int index =0
)
Add a parameter to the Contents object.
function setName
void setName(
const std::string & name
)
Set the name of this Contents object (i.e. the name of the model to which this spectrum data applies)
Updated on 2024-07-18 at 13:53:30 +0000