Gyoto
GyotoPhoton.h
Go to the documentation of this file.
1 
9 /*
10  Copyright 2011-2016 Frederic Vincent, Thibaut Paumard
11 
12  This file is part of Gyoto.
13 
14  Gyoto is free software: you can redistribute it and/or modify
15  it under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  Gyoto is distributed in the hope that it will be useful,
20  but WITHOUT ANY WARRANTY; without even the implied warranty of
21  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  GNU General Public License for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with Gyoto. If not, see <http://www.gnu.org/licenses/>.
26  */
27 
28 #ifndef __GyotoPhoton_H_
29 #define __GyotoPhoton_H_
30 
31 #include "GyotoFunctors.h"
32 
33 namespace Gyoto{
34  class Photon;
35  namespace Astrobj { class Generic; }
36 }
37 
38 #include <GyotoDefs.h>
39 #include <GyotoMetric.h>
40 #include <GyotoScreen.h>
41 #include <GyotoWorldline.h>
42 #include <GyotoObject.h>
43 
44 #include <float.h>
45 
53 : public Gyoto::Worldline,
54  public Gyoto::SmartPointee,
55  public Gyoto::Object
56 {
57  friend class Gyoto::SmartPointer<Gyoto::Photon>;
58  // Data :
59  // -----
60 
61  protected:
63 
66  SmartPointer<Gyoto::Astrobj::Generic> object_;
67 
69 
72  double freq_obs_;
73 
75 
78  double transmission_freqobs_;
79 
81 
85  SmartPointer<Spectrometer::Generic> spectro_;
86 
88 
92  double * transmission_;
93 
94  // Constructors - Destructor
95  // -------------------------
96 
97  public:
101  virtual std::string className() const ;
102  virtual std::string className_l() const ;
103 
107  Photon() ;
108  Photon(const Photon& ) ;
109  Photon* clone() const ;
110  protected:
111  Photon(Photon* orig, size_t i0, int dir, double step_max);
113  public:
115  Photon(SmartPointer<Metric::Generic> gg, SmartPointer<Astrobj::Generic> obj,
116  double* coord) ;
117 
119  Photon(SmartPointer<Metric::Generic> gg, SmartPointer<Astrobj::Generic> obj,
120  SmartPointer<Screen> screen, double d_alpha, double d_delta);
121 
122  virtual ~Photon() ;
123 
124  virtual double getMass() const ;
125 
127  void astrobj(SmartPointer<Astrobj::Generic>);
129  SmartPointer<Astrobj::Generic> astrobj() const ;
130 
131  using Worldline::metric;
132  // Set Worldline::metric_ as well as the Astrobj metric
133  void metric(SmartPointer<Metric::Generic>);
134 
135 
137  void spectrometer(SmartPointer<Spectrometer::Generic> spr);
139  SmartPointer<Spectrometer::Generic> spectrometer() const ;
140 
142  void freqObs(double);
144  double freqObs() const;
145 
146 
147  // Mutators / assignment
148  // ---------------------
149  public:
150 
152 
162  void setInitialCondition(SmartPointer<Metric::Generic> gg,
163  SmartPointer<Astrobj::Generic> obj,
164  const double coord[8]) ;
165 
167 
176  void setInitialCondition(SmartPointer<Metric::Generic> gg,
177  SmartPointer<Astrobj::Generic> obj,
178  SmartPointer<Screen> screen,
179  double d_alpha,
180  double d_delta);
181 
183 
188  int hit(Astrobj::Properties *data=NULL);
189 
208  double findMin(Functor::Double_constDoubleArray* object,
209  double t1, double t2, double &tmin,
210  double threshold = DBL_MIN) ;
211 
213 
225  void findValue(Functor::Double_constDoubleArray* object,
226  double value,
227  double tinside, double &toutside) ;
228 
229 #ifdef GYOTO_USE_XERCES
230  virtual void setParameters(FactoryMessenger *fmp) ;
231  static SmartPointer<Photon> Subcontractor(Gyoto::FactoryMessenger*);
232 #endif
233 
234  /* transmission stuff */
235  public:
237  void resetTransmission() ;
238 
240 
247  double getTransmission(size_t i) const ;
248 
250 
256  double getTransmissionMax() const ;
257 
259 
262  double const * getTransmission() const ;
263 
265 
271  virtual void transmit(size_t i, double t);
272 
273  private:
275  void _allocateTransmission();
276 
277  public:
278  class Refined;
279 
280 };
281 
304  protected:
306  public:
307  Refined(Photon *parent, size_t i, int dir, double step_max);
309  virtual void transmit(size_t i, double t);
311 };
312 
313 
314 #endif
#define GYOTO_OBJECT
Declare class::properties and class::getProperties()
Definition: GyotoObject.h:84
Timelike or null geodesics.
Definition: GyotoWorldline.h:219
A null geodesic transporting light.
Definition: GyotoPhoton.h:52
Classes with an operator() method.
#define GYOTO_OBJECT_THREAD_SAFETY
Declare virtual bool isThreadSafe() const.
Definition: GyotoObject.h:99
Photon * parent_
Parent Photon.
Definition: GyotoPhoton.h:305
Refine last step of integration in a Photon.
Definition: GyotoPhoton.h:303
Gyoto ubiquitous macros and typedefs.
Timelike or null geodesics.
Base class for metric description.
Introspectable objects.
#define GYOTO_WORLDLINE
Declare the Worldline interface wrappers.
Definition: GyotoWorldline.h:151
Namespace for the Gyoto library.
Definition: GyotoAstrobj.h:43
Pointers performing reference counting.
Definition: GyotoProperty.h:45
Can be pointed to by a SmartPointer.
Definition: GyotoSmartPointer.h:80
Object with properties.
Definition: GyotoObject.h:151
Description of the observer screen.
SmartPointer< Metric::Generic > metric() const
Get metric.
SmartPointer< Astrobj::Generic > Subcontractor(FactoryMessenger *fmp, std::vector< std::string > const &plugin)
A template for Subcontractor_t functions.
Definition: GyotoAstrobj.h:76