GModelSpectralGauss.hpp
8.01 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
/***************************************************************************
* GModelSpectralGauss.hpp - Spectral Gaussian model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2014-2016 by Christoph Deil & Ellis Owen *
* ----------------------------------------------------------------------- *
* *
* 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 GModelSpectralGauss.hpp
* @brief Gaussian spectral model class interface definition
* @author Christoph Deil & Ellis Owen
*/
#ifndef GMODELSPECTRALGAUSS_HPP
#define GMODELSPECTRALGAUSS_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpectral.hpp"
#include "GFunction.hpp"
#include "GModelPar.hpp"
#include "GEnergy.hpp"
/* __ Forward declarations _______________________________________________ */
class GRan;
class GTime;
class GXmlElement;
/***********************************************************************//**
* @class GModelSpectralGauss
*
* @brief Gaussian spectral model class
*
* This class implements a Gaussian spectrum. The model is defined by
*
* \f[
* S_{\rm E}(E | t) =
* \frac{\tt m\_norm}{\sqrt{2 \pi} m\_sigma^2} \exp
* \left(\frac{-(E - m\_mean)^2}{2 m_\sigma^2} \right)
* \f]
*
* where
* - \f${\tt m\_norm}\f$ is the normalization,
* - \f${\tt m\_mean}\f$ is the mean energy,
* - \f${\tt m\_sigma}\f$ is the energy width.
***************************************************************************/
class GModelSpectralGauss : public GModelSpectral {
public:
// Constructors and destructors
GModelSpectralGauss(void);
explicit GModelSpectralGauss(const GXmlElement& xml);
GModelSpectralGauss(const double& norm,
const GEnergy& mean,
const GEnergy& sigma);
GModelSpectralGauss(const GModelSpectralGauss& model);
virtual ~GModelSpectralGauss(void);
// Operators
virtual GModelSpectralGauss& operator=(const GModelSpectralGauss& model);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GModelSpectralGauss* 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 norm(void) const;
void norm(const double& norm);
GEnergy mean(void) const;
void mean(const GEnergy& mean);
GEnergy sigma(void) const;
void sigma(const GEnergy& sigma);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpectralGauss& model);
void free_members(void);
void update_eval_cache(const GEnergy& energy) const;
// Energy flux integration kernel
class eflux_kernel : public GFunction {
public:
eflux_kernel(const double& norm,
const double& mean,
const double& sigma) :
m_norm(norm),
m_mean(mean),
m_sigma(sigma) {}
double eval(const double& eng);
protected:
double m_norm; //!< Normalization
double m_mean; //!< Mean
double m_sigma; //!< Sigma
};
// Protected members
GModelPar m_norm; //!< Normalization factor
GModelPar m_mean; //!< Gaussian mean energy
GModelPar m_sigma; //!< Gaussian energy width
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModelSpectralGauss").
***************************************************************************/
inline
std::string GModelSpectralGauss::classname(void) const
{
return ("GModelSpectralGauss");
}
/***********************************************************************//**
* @brief Return model type
*
* @return "ConstantValue".
*
* Returns the type of the Gaussian spectral model.
***************************************************************************/
inline
std::string GModelSpectralGauss::type(void) const
{
return "Gaussian";
}
/***********************************************************************//**
* @brief Return normalization
*
* @return Normalization (ph/cm2/s).
***************************************************************************/
inline
double GModelSpectralGauss::norm(void) const
{
return (m_norm.value());
}
/***********************************************************************//**
* @brief Set normalization
*
* @param[in] norm Normalization (ph/cm2/s).
***************************************************************************/
inline
void GModelSpectralGauss::norm(const double& norm)
{
m_norm.value(norm);
return;
}
/***********************************************************************//**
* @brief Return mean energy
*
* @return Mean energy.
***************************************************************************/
inline
GEnergy GModelSpectralGauss::mean(void) const
{
GEnergy energy;
energy.MeV(m_mean.value());
return energy;
}
/***********************************************************************//**
* @brief Set mean energy
*
* @param[in] mean Mean energy.
***************************************************************************/
inline
void GModelSpectralGauss::mean(const GEnergy& mean)
{
m_mean.value(mean.MeV());
return;
}
/***********************************************************************//**
* @brief Return energy width
*
* @return Energy width
***************************************************************************/
inline
GEnergy GModelSpectralGauss::sigma(void) const
{
GEnergy energy;
energy.MeV(m_sigma.value());
return energy;
}
/***********************************************************************//**
* @brief Set energy width
*
* @param[in] sigma Energy width.
***************************************************************************/
inline
void GModelSpectralGauss::sigma(const GEnergy& sigma)
{
m_sigma.value(sigma.MeV());
return;
}
#endif /* GMODELSPECTRALGAUSS_HPP */