GModelSpectralPlaw.hpp
8.8 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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/***************************************************************************
* GModelSpectralPlaw.hpp - Spectral power law model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2016 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 GModelSpectralPlaw.hpp
* @brief Power law spectral model class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPECTRALPLAW_HPP
#define GMODELSPECTRALPLAW_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpectral.hpp"
#include "GModelPar.hpp"
#include "GEnergy.hpp"
//#include "GXmlElement.hpp"
/* __ Forward declarations _______________________________________________ */
class GRan;
class GTime;
class GXmlElement;
/***********************************************************************//**
* @class GModelSpectralPlaw
*
* @brief Power law spectral model class
*
* This class implements a power law spectrum. The model is defined by
*
* \f[
* S_{\rm E}(E | t) = {\tt m\_norm}
* \left( \frac{E}{\tt m\_pivot} \right)^{\tt m\_index}
* \f]
*
* where
* - \f${\tt m\_norm}\f$ is the normalization or prefactor,
* - \f${\tt m\_index}\f$ is the spectral index, and
* - \f${\tt m\_pivot}\f$ is the pivot energy.
***************************************************************************/
class GModelSpectralPlaw : public GModelSpectral {
public:
// Constructors and destructors
GModelSpectralPlaw(void);
GModelSpectralPlaw(const std::string& type,
const std::string& prefactor,
const std::string& index,
const std::string& pivot);
GModelSpectralPlaw(const double& prefactor,
const double& index,
const GEnergy& pivot);
explicit GModelSpectralPlaw(const GXmlElement& xml);
GModelSpectralPlaw(const GModelSpectralPlaw& model);
virtual ~GModelSpectralPlaw(void);
// Operators
virtual GModelSpectralPlaw& operator=(const GModelSpectralPlaw& model);
// Implemented pure virtual methods
virtual void clear(void);
virtual GModelSpectralPlaw* clone(void) const;
virtual std::string classname(void) const;
virtual std::string type(void) const;
virtual double eval(const GEnergy& srcEng,
const GTime& srcTime = GTime(),
const bool& gradients = false) const;
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 prefactor(void) const;
double index(void) const;
GEnergy pivot(void) const;
void prefactor(const double& prefactor);
void index(const double& index);
void pivot(const GEnergy& pivot);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpectralPlaw& model);
void free_members(void);
void update_eval_cache(const GEnergy& energy) const;
void update_mc_cache(const GEnergy& emin, const GEnergy& emax) const;
// Protected members
std::string m_type; //!< Model type
GModelPar m_norm; //!< Normalization factor
GModelPar m_index; //!< Spectral index
GModelPar m_pivot; //!< Pivot energy
// Cached members used for pre-computations
mutable GEnergy m_last_energy; //!< Last energy value
mutable double m_last_norm; //!< Last norm parameter
mutable double m_last_index; //!< Last index parameter
mutable double m_last_pivot; //!< Last pivot parameter
mutable double m_last_e_norm; //!< Last E/Epivot value
mutable double m_last_log_e_norm; //!< Last ln(E/Epivot) value
mutable double m_last_power; //!< Last power value
mutable double m_mc_emin; //!< Minimum energy
mutable double m_mc_emax; //!< Maximum energy
mutable double m_mc_exponent; //!< Exponent (index+1)
mutable double m_mc_pow_emin; //!< Power of minimum energy
mutable double m_mc_pow_ewidth; //!< Power of energy width
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpectralPlaw").
***************************************************************************/
inline
std::string GModelSpectralPlaw::classname(void) const
{
return ("GModelSpectralPlaw");
}
/***********************************************************************//**
* @brief Return model type
*
* @return Model type.
*
* Returns the type of the spectral power law model.
***************************************************************************/
inline
std::string GModelSpectralPlaw::type(void) const
{
return (m_type);
}
/***********************************************************************//**
* @brief Return pre factor
*
* @return Pre factor (ph/cm2/s/MeV).
*
* Returns the pre factor.
***************************************************************************/
inline
double GModelSpectralPlaw::prefactor(void) const
{
return (m_norm.value());
}
/***********************************************************************//**
* @brief Set pre factor
*
* @param[in] prefactor Pre factor (ph/cm2/s/MeV).
*
* Sets the pre factor.
***************************************************************************/
inline
void GModelSpectralPlaw::prefactor(const double& prefactor)
{
m_norm.value(prefactor);
return;
}
/***********************************************************************//**
* @brief Return power law index
*
* @return Power law index.
*
* Returns the power law index.
***************************************************************************/
inline
double GModelSpectralPlaw::index(void) const
{
return (m_index.value());
}
/***********************************************************************//**
* @brief Set power law index
*
* @param[in] index Power law index.
*
* Sets the power law index.
***************************************************************************/
inline
void GModelSpectralPlaw::index(const double& index)
{
m_index.value(index);
return;
}
/***********************************************************************//**
* @brief Return pivot energy
*
* @return Pivot energy.
*
* Returns the pivot energy.
***************************************************************************/
inline
GEnergy GModelSpectralPlaw::pivot(void) const
{
GEnergy energy;
energy.MeV(m_pivot.value());
return energy;
}
/***********************************************************************//**
* @brief Set pivot energy
*
* @param[in] pivot Pivot energy.
*
* Sets the pivot energy.
***************************************************************************/
inline
void GModelSpectralPlaw::pivot(const GEnergy& pivot)
{
m_pivot.value(pivot.MeV());
return;
}
#endif /* GMODELSPECTRALPLAW_HPP */