GModelSpectralSuperExpPlaw.hpp
13.2 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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
/***************************************************************************
* GModelSpectralSuperExpPlaw.hpp - Super exp. cut off power law model *
* ----------------------------------------------------------------------- *
* copyright (C) 2014-2016 by Michael Mayer *
* ----------------------------------------------------------------------- *
* *
* 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 GModelSpectralSuperExpPlaw.hpp
* @brief Super exponential cut off power law spectral class interface definition
* @author Michael Mayer
*/
#ifndef GMODELSPECTRALSUPEREXPPLAW_HPP
#define GMODELSPECTRALSUPEREXPPLAW_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpectral.hpp"
#include "GFunction.hpp"
#include "GEnergy.hpp"
#include "GModelPar.hpp"
//#include "GXmlElement.hpp"
/* __ Forward declarations _______________________________________________ */
class GRan;
class GTime;
class GXmlElement;
/***********************************************************************//**
* @class GModelSpectralSuperExpPlaw
*
* @brief Super exponential cut off power law spectral class
*
* This class implements a power law spectrum with super exponential cut off.
* The model is defined by
*
* \f[
* S_{\rm E}(E | t) = {\tt m\_norm}
* \left( \frac{E}{\tt m\_pivot} \right)^{\tt m\_index1}
* \exp \left( \frac{-E}{\tt m\_ecut}^{\tt m\_index2} \right)
* \f]
*
* where
*
* \f${\tt m\_norm}\f$ is the normalization or prefactor,
* \f${\tt m\_index1}\f$ is the spectral index,
* \f${\tt m\_ecut}\f$ is the cut off energy, and
* \f${\tt m\_pivot}\f$ is the pivot energy.
* \f${\tt m\_index2}\f$ is index defining the cutoff shape,
***************************************************************************/
class GModelSpectralSuperExpPlaw : public GModelSpectral {
public:
// Constructors and destructors
GModelSpectralSuperExpPlaw(void);
GModelSpectralSuperExpPlaw(const std::string& type,
const std::string& prefactor,
const std::string& index1,
const std::string& pivot,
const std::string& cutoff,
const std::string& index2);
GModelSpectralSuperExpPlaw(const double& prefactor,
const double& index1,
const GEnergy& pivot,
const GEnergy& cutoff,
const double& index2);
explicit GModelSpectralSuperExpPlaw(const GXmlElement& xml);
GModelSpectralSuperExpPlaw(const GModelSpectralSuperExpPlaw& model);
virtual ~GModelSpectralSuperExpPlaw(void);
// Operators
virtual GModelSpectralSuperExpPlaw& operator=(const GModelSpectralSuperExpPlaw& model);
// Implemented pure virtual methods
virtual void clear(void);
virtual GModelSpectralSuperExpPlaw* 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;
void prefactor(const double& prefactor);
double index1(void) const;
void index1(const double& index1);
double index2(void) const;
void index2(const double& index2);
GEnergy cutoff(void) const;
void cutoff(const GEnergy& cutoff);
GEnergy pivot(void) const;
void pivot(const GEnergy& pivot);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpectralSuperExpPlaw& model);
void free_members(void);
void update_eval_cache(const GEnergy& energy) const;
void update_mc_cache(const GEnergy& emin, const GEnergy& emax) const;
// Photon flux integration kernel
class flux_kernel : public GFunction {
public:
flux_kernel(const double& norm,
const double& index1,
const double& pivot,
const double& ecut,
const double& index2) :
m_norm(norm),
m_index1(index1),
m_inv_pivot(1.0/pivot),
m_inv_ecut(1.0/ecut),
m_index2(index2) {}
double eval(const double& eng);
protected:
double m_norm; //!< Normalization
double m_index1; //!< Index1
double m_inv_pivot; //!< 1 / Pivot energy
double m_inv_ecut; //!< 1 / Cut off energy
double m_index2; //!< Index2
};
// Energy flux integration kernel
class eflux_kernel : public GFunction {
public:
eflux_kernel(const double& norm,
const double& index1,
const double& pivot,
const double& ecut,
const double& index2) :
m_norm(norm),
m_index1(index1),
m_inv_pivot(1.0/pivot),
m_inv_ecut(1.0/ecut),
m_index2(index2) {}
double eval(const double& eng);
protected:
double m_norm; //!< Normalization
double m_index1; //!< Index1
double m_inv_pivot; //!< 1 / Pivot energy
double m_inv_ecut; //!< 1 / Cut off energy
double m_index2; //!< Index2
};
// Protected members
std::string m_type; //!< Model type
GModelPar m_norm; //!< Normalization factor
GModelPar m_index1; //!< Spectral index
GModelPar m_index2; //!< Index of cutoff
GModelPar m_ecut; //!< Exponential cut off energy
GModelPar m_pivot; //!< Pivot energy
// Cached members used for pre-computations
mutable GEnergy m_last_energy; //!< Last energy value
mutable double m_last_index1; //!< Last index1 parameter
mutable double m_last_ecut; //!< Last energy cut-off parameter
mutable double m_last_pivot; //!< Last pivot parameter
mutable double m_last_index2; //!< Last index2 parameter
mutable double m_last_e_norm; //!< Last E/Epivot value
mutable double m_last_e_cut; //!< Last E/Ecut value
mutable double m_last_exponent; //!< last pow(E/Ecut,index2) 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 ("GModelSpectralSuperExpPlaw").
***************************************************************************/
inline
std::string GModelSpectralSuperExpPlaw::classname(void) const
{
return ("GModelSpectralSuperExpPlaw");
}
/***********************************************************************//**
* @brief Return model type
*
* @return "SuperExpCutoff".
*
* Returns the type of the exponentially cut off power law model.
***************************************************************************/
inline
std::string GModelSpectralSuperExpPlaw::type(void) const
{
return (m_type);
}
/***********************************************************************//**
* @brief Return pre factor
*
* @return Pre factor (ph/cm2/s/MeV).
*
* Returns the pre factor.
***************************************************************************/
inline
double GModelSpectralSuperExpPlaw::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 GModelSpectralSuperExpPlaw::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 GModelSpectralSuperExpPlaw::index1(void) const
{
return (m_index1.value());
}
/***********************************************************************//**
* @brief Set power law index
*
* @param[in] index1 Power law index.
*
* Sets the power law index.
***************************************************************************/
inline
void GModelSpectralSuperExpPlaw::index1(const double& index1)
{
m_index1.value(index1);
return;
}
/***********************************************************************//**
* @brief Return cut off index
*
* @return cut off index.
*
* Returns the cut off index.
***************************************************************************/
inline
double GModelSpectralSuperExpPlaw::index2(void) const
{
return (m_index2.value());
}
/***********************************************************************//**
* @brief Set cut off index
*
* @param[in] index2 Cut off index.
*
* Sets the cut off index.
***************************************************************************/
inline
void GModelSpectralSuperExpPlaw::index2(const double& index2)
{
m_index2.value(index2);
return;
}
/***********************************************************************//**
* @brief Return pivot energy
*
* @return Pivot energy.
*
* Returns the pivot energy.
***************************************************************************/
inline
GEnergy GModelSpectralSuperExpPlaw::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 GModelSpectralSuperExpPlaw::pivot(const GEnergy& pivot)
{
m_pivot.value(pivot.MeV());
return;
}
/***********************************************************************//**
* @brief Return exponential cut-off energy
*
* @return Exponential cut-off energy.
*
* Returns the exponential cut-off energy.
***************************************************************************/
inline
GEnergy GModelSpectralSuperExpPlaw::cutoff(void) const
{
GEnergy energy;
energy.MeV(m_ecut.value());
return energy;
}
/***********************************************************************//**
* @brief Set exponential cut-off energy
*
* @param[in] cutoff Exponential cut-off energy.
*
* Sets the exponential cut-off energy.
***************************************************************************/
inline
void GModelSpectralSuperExpPlaw::cutoff(const GEnergy& cutoff)
{
m_ecut.value(cutoff.MeV());
return;
}
#endif /* GMODELSPECTRALSUPEREXPPLAW_HPP */