GModelSpatialRadialShell.hpp
8.77 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
/***************************************************************************
* GModelSpatialRadialShell.hpp - Radial shell source model class *
* ----------------------------------------------------------------------- *
* copyright (C) 2011-2013 by Christoph Deil *
* ----------------------------------------------------------------------- *
* *
* 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 GModelSpatialRadialShell.hpp
* @brief Radial shell model class interface definition
* @author Christoph Deil
*/
#ifndef GMODELSPATIALRADIALSHELL_HPP
#define GMODELSPATIALRADIALSHELL_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpatialRadial.hpp"
#include "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GXmlElement.hpp"
/**************************************************************************
* @class GModelSpatialRadialShell
*
* @brief Shell source model class
*
* This class implements the spatial component of the factorised source
* model for a shell source (can be used e.g. as a toy supernova remnant
* model). The shell is simply the volume between an inner and outer radius
* (a large sphere with a smaller sphere cut out) with constant volume
* emissivity and no absorption. To determine the surface brightness
* distribution on the sky, the shell is analytically integrated along lines
* of sight.
* The shell is parametrised by the inner shell radius and the shell width.
* Obviously, the shell width has to be a positive quantity. To assure
* positivity, 1 arcsec is added internally to the shell width. This should
* be negligible compared to shell widths encountered (and detectable) in
* the gamma-ray domain, and improves the convergence of the fitting
* algorithms.
***************************************************************************/
class GModelSpatialRadialShell : public GModelSpatialRadial {
public:
// Constructors and destructors
GModelSpatialRadialShell(void);
explicit GModelSpatialRadialShell(const GSkyDir& dir,
const double& radius,
const double& width,
const bool& small_angle = true);
explicit GModelSpatialRadialShell(const GXmlElement& xml);
GModelSpatialRadialShell(const GModelSpatialRadialShell& model);
virtual ~GModelSpatialRadialShell(void);
// Operators
virtual GModelSpatialRadialShell& operator=(const GModelSpatialRadialShell& model);
// Implemented pure virtual methods
virtual void clear(void);
virtual GModelSpatialRadialShell* clone(void) const;
virtual std::string type(void) const;
virtual double eval(const double& theta,
const GEnergy& energy,
const GTime& time) const;
virtual double eval_gradients(const double& theta,
const GEnergy& energy,
const GTime& time) const;
virtual GSkyDir mc(const GEnergy& energy,
const GTime& time,
GRan& ran) const;
virtual double theta_max(void) 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 radius(void) const;
double width(void) const;
const bool& small_angle(void) const;
void radius(const double& radius);
void width(const double& width);
void small_angle(const bool& small_angle);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpatialRadialShell& model);
void free_members(void);
void update(void) const;
static double f1(double x);
static double f2(double x);
// Protected members
GModelPar m_radius; //!< Inner shell radius (deg)
GModelPar m_width; //!< Shell thickness (deg)
bool m_small_angle; //!< Use small angle approximate formulae
// Cached members used for pre-computations
mutable double m_last_radius; //!< Last shell radius (deg)
mutable double m_last_width; //!< Last shell width (deg)
mutable double m_theta_in; //!< Inner shell radius (rad)
mutable double m_x_in; //!< m_theta_in^2 or sin(m_theta_in)^2
mutable double m_theta_out; //!< Outer shell radius (rad)
mutable double m_x_out; //!< m_theta_out^2 or sin(m_theta_out)^2
mutable double m_norm; //!< Shell normalization
};
/***********************************************************************//**
* @brief Return model type
*
* @return "ShellFunction".
*
* Returns the type of the radial shell model.
***************************************************************************/
inline
std::string GModelSpatialRadialShell::type(void) const
{
return "ShellFunction";
}
/***********************************************************************//**
* @brief Return shell radius
*
* @return Shell radius (degrees).
*
* Returns the shell radius in degrees.
***************************************************************************/
inline
double GModelSpatialRadialShell::radius(void) const
{
return (m_radius.value());
}
/***********************************************************************//**
* @brief Set shell radius
*
* @param[in] radius Shell radius (degrees).
*
* Sets the shell radius in degrees.
***************************************************************************/
inline
void GModelSpatialRadialShell::radius(const double& radius)
{
m_radius.value(radius);
return;
}
/***********************************************************************//**
* @brief Return shell width
*
* @return Shell width (degrees).
*
* Returns the shell width in degrees.
***************************************************************************/
inline
double GModelSpatialRadialShell::width(void) const
{
return (m_width.value());
}
/***********************************************************************//**
* @brief Set width radius
*
* @param[in] width Shell width (degrees).
*
* Sets the shell width in degrees.
***************************************************************************/
inline
void GModelSpatialRadialShell::width(const double& width)
{
m_width.value(width);
return;
}
/***********************************************************************//**
* @brief Return shell approximation flag
*
* @return True if small angle approximation is taken.
*
* Signals if the small angle approximation is taken.
***************************************************************************/
inline
const bool& GModelSpatialRadialShell::small_angle(void) const
{
return (m_small_angle);
}
/***********************************************************************//**
* @brief Set shell approximation flag
*
* @param[in] small_angle Shell approximation flag.
*
* Sets the shell approximation flag. True specifies that the small angle
* approximation shall be taken, false specifies that the correct spherical
* computation shall be used.
***************************************************************************/
inline
void GModelSpatialRadialShell::small_angle(const bool& small_angle)
{
m_small_angle = small_angle;
return;
}
#endif /* GMODELSPATIALRADIALSHELL_HPP */