GModelSpectralConst.hpp
5.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/***************************************************************************
* GModelSpectralConst.hpp - Spectral constant model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2014 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GModelSpectralConst.hpp
* @brief Constant spectral model class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPECTRALCONST_HPP
#define GMODELSPECTRALCONST_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelPar.hpp"
#include "GModelSpectral.hpp"
#include "GEnergy.hpp"
#include "GXmlElement.hpp"
/***********************************************************************//**
* @class GModelSpectralConst
*
* @brief Constant spectral model class
*
* This class implements a constant spectrum. The model is defined by
*
* \f[
* S_{\rm E}(E | t) = {\tt m\_norm}
* \f]
*
* where
* \f${\tt m\_norm}\f$ is the normalization constant in units of
* ph/cm2/s/MeV.
***************************************************************************/
class GModelSpectralConst : public GModelSpectral {
public:
// Constructors and destructors
GModelSpectralConst(void);
explicit GModelSpectralConst(const GXmlElement& xml);
explicit GModelSpectralConst(const double& value);
GModelSpectralConst(const GModelSpectralConst& model);
virtual ~GModelSpectralConst(void);
// Operators
virtual GModelSpectralConst& operator=(const GModelSpectralConst& model);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GModelSpectralConst* clone(void) const;
virtual std::string classname(void) const;
virtual std::string type(void) const;
virtual double eval(const GEnergy& srcEng,
const GTime& srcTime) const;
virtual double eval_gradients(const GEnergy& srcEng,
const GTime& srcTime);
virtual double flux(const GEnergy& emin,
const GEnergy& emax) const;
virtual double eflux(const GEnergy& emin,
const GEnergy& emax) const;
virtual GEnergy mc(const GEnergy& emin,
const GEnergy& emax,
const GTime& time,
GRan& ran) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
double value(void) const;
void value(const double& value);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpectralConst& model);
void free_members(void);
// Protected members
GModelPar m_norm; //!< Normalization factor
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpectralConst").
***************************************************************************/
inline
std::string GModelSpectralConst::classname(void) const
{
return ("GModelSpectralConst");
}
/***********************************************************************//**
* @brief Return model type
*
* @return "ConstantValue".
*
* Returns the type of the constant spectral model.
***************************************************************************/
inline
std::string GModelSpectralConst::type(void) const
{
return "ConstantValue";
}
/***********************************************************************//**
* @brief Return model value
*
* @return Model value (ph/cm2/s/MeV).
*
* Returns the model value.
***************************************************************************/
inline
double GModelSpectralConst::value(void) const
{
return (m_norm.value());
}
/***********************************************************************//**
* @brief Set model value
*
* @param[in] value Model value (ph/cm2/s/MeV).
*
* Sets the model value.
***************************************************************************/
inline
void GModelSpectralConst::value(const double& value)
{
m_norm.value(value);
return;
}
#endif /* GMODELSPECTRALCONST_HPP */