Gyoto
GyotoAstrobj.h
Go to the documentation of this file.
1 
8 /*
9  Copyright 2011-2020 Thibaut Paumard, Frederic Vincent
10 
11  This file is part of Gyoto.
12 
13  Gyoto is free software: you can redistribute it and/or modify
14  it under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  Gyoto is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  GNU General Public License for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with Gyoto. If not, see <http://www.gnu.org/licenses/>.
25  */
26 
27 
28 #ifndef __GyotoAstrobj_H_
29 #define __GyotoAstrobj_H_
30 
31 #include "GyotoConfig.h"
32 
33 #include <iostream>
34 #include <fstream>
35 #include <iomanip>
36 #include <string>
37 
38 #include <GyotoDefs.h>
39 #include <GyotoSmartPointer.h>
40 #include <GyotoConverters.h>
41 #include <GyotoObject.h>
42 #include <eigen3/Eigen/Dense>
43 
44 namespace Gyoto{
45  class Photon;
46  namespace Register { class Entry; }
47  namespace Metric { class Generic; }
48  class FactoryMessenger;
49  namespace Astrobj {
50  class Generic;
51  class Properties;
52 
63  Subcontractor_t(Gyoto::FactoryMessenger*, std::vector<std::string> const &);
65 
77  (FactoryMessenger* fmp, std::vector<std::string> const &plugin) {
78  SmartPointer<T> ao = new T();
79  ao -> plugins(plugin) ;
80 #ifdef GYOTO_USE_XERCES
81  if (fmp) ao -> setParameters(fmp);
82 #endif
83  return ao;
84  }
86 
88 
105  std::vector<std::string> &plugin,
106  int errmode = 0);
107 
115 
119  void initRegister();
121 
133  void Register(std::string name, Gyoto::Astrobj::Subcontractor_t* scp);
135  }
136 }
137 
198 : public Gyoto::SmartPointee,
199  public Gyoto::Object
200 {
202 
203 
204  // Data :
205  // -----
206 private:
207 
216 
217  protected:
218 
222  SmartPointer<Gyoto::Metric::Generic> gg_;
223 
224 
234  double rmax_;
235 
243 
245 
246  int shadow_;
248  // Constructors - Destructor
249  // -------------------------
250  public:
252 
257 
261  Generic(double radmax);
262 
266  Generic(std::string kind);
267 
271  Generic(const Generic& ) ;
272 
289  virtual Generic* clone() const = 0 ;
290 
291  virtual ~Generic() ;
292 
293  // Accessors
294  // ---------
295  public:
299  virtual SmartPointer<Metric::Generic> metric() const;
300 
304  virtual void metric(SmartPointer<Metric::Generic>) ;
305 
317  virtual double rMax();
318  virtual double rMax() const;
319 
326  virtual double rMax(std::string const &unit);
327  virtual double rMax(std::string const &unit) const;
328 
330 
334  virtual double deltaMax(double coord[8]);
335 
342  virtual void rMax(double val);
343 
351  virtual void rMax(double val, std::string const &unit);
352 
353  GYOTO_OBJECT_ACCESSORS_UNIT(deltaMaxInsideRMax);
354 
360  void opticallyThin(bool flag);
362 
365  bool opticallyThin() const ;
367 
368  void showshadow(bool flag);
369  bool showshadow() const ;
370 
371  void redshift(bool flag);
372  bool redshift() const ;
373 
382 
383  //XML I/O
384  public:
385 
386 #ifdef GYOTO_USE_XERCES
408  virtual void setParameters(FactoryMessenger *fmp);
409 
410 
411 #endif
412 
413  // Outputs
414  // -------
415  public:
450  virtual int Impact(Gyoto::Photon* ph, size_t index,
451  Astrobj::Properties *data=NULL) = 0 ;
453 
466  virtual void processHitQuantities(Photon * ph, state_t const &coord_ph_hit,
467  double const * coord_obj_hit, double dt,
468  Astrobj::Properties* data) const;
469  virtual void processHitQuantities(Photon* ph, double* coord_ph_hit,
470  double* coord_obj_hit, double dt,
471  Astrobj::Properties* data) const = delete ;
472 
522  virtual double emission(double nu_em, double dsem, state_t const &coord_ph,
523  double const coord_obj[8]=NULL)
524  const ;
525  virtual double emission(double nu_em, double dsem, double coord_ph[8],
526  double coord_obj[8]=NULL)
527  const = delete;
528 
551  virtual void emission(double Inu[], double const nu_em[], size_t nbnu,
552  double dsem, state_t const &coord_ph,
553  double const coord_obj[8]=NULL) const ;
554  virtual void emission(double Inu[], double nu_em[], size_t nbnu,
555  double dsem, double coord_ph[8],
556  double coord_obj[8]=NULL) const = delete ;
557 
561  virtual void radiativeQ(double Inu[], double Taunu[],
562  double const nu_em[], size_t nbnu,
563  double dsem, state_t const &coord_ph,
564  double const coord_obj[8]=NULL) const ;
565  virtual void radiativeQ(double Inu[], double Taunu[],
566  double nu_em[], size_t nbnu,
567  double dsem, double coord_ph[8],
568  double coord_obj[8]=NULL) const = delete ;
602  virtual void radiativeQ(double *Inu, double *Qnu, double *Unu, double *Vnu,
603  Eigen::Matrix4d *Onu, double const *nuem , size_t nbnu, double dsem,
604  state_t const &cph, double const *co) const ;
605 
617  virtual double integrateEmission(double nu1, double nu2, double dsem,
618  state_t const &c_ph, double const c_obj[8]=NULL) const;
620  virtual double integrateEmission(double nu1, double nu2, double dsem,
621  double c_ph[8], double c_obj[8]=NULL) const=delete;
622 
628  virtual void integrateEmission(double * I, double const * boundaries,
629  size_t const * chaninds, size_t nbnu,
630  double dsem, state_t const &cph, double const *co) const;
632  virtual void integrateEmission(double * I, double const * boundaries,
633  size_t const * chaninds, size_t nbnu,
634  double dsem, double *cph, double *co) const = delete;
636 
646  virtual double transmission(double nuem, double dsem, state_t const &coord_ph, double const coord_obj[8]) const ;
648  virtual double transmission(double nuem, double dsem, state_t const &coord) const = delete;
649  virtual double transmission(double nuem, double dsem, double coord[8]) const = delete;
651 
663  Eigen::Matrix4d Omatrix(double alphanu[4], double rnu[3], double Chi, double dsem) const;
664  Eigen::Matrix4d Omatrix(double alphaInu, double alphaQnu, double alphaUnu, double alphaVnu,
665  double rQnu, double rUnu, double rVnu, double Chi, double dsem) const;
666  Eigen::Matrix4d Omatrix(double alphanu[4], double rnu[3], double sin2Chi, double cos2Chi, double dsem) const;
667  Eigen::Matrix4d Omatrix(double alphaInu, double alphaQnu, double alphaUnu, double alphaVnu,
668  double rQnu, double rUnu, double rVnu, double sin2Chi, double cos2Chi, double dsem) const;
669 
670  Eigen::Matrix4d Pmatrix(double alphaInu, double alphaQnu, double alphaUnu, double alphaVnu,
671  double rQnu, double rUnu, double rVnu, double sin2Chi, double cos2Chi, double dsem) const;
672 
677  Eigen::Vector4d rotateJs(double jInu, double jQnu, double jUnu, double jVnu, double sin2Chi, double cos2Chi) const;
678  Eigen::Vector4d rotateJs(double jInu, double jQnu, double jUnu, double jVnu, double Chi) const;
679 
689  double getChi(double const fourvect[4], state_t const &cph, double const vel[4], bool elec=false) const;
699  void getSinCos2Chi(double const fourvect[4], state_t const &cph, double const vel[4], double* sin2Chi, double* cos2Chi, bool elec=false) const;
708  void computeB4vect(double B4vect[4], std::string const magneticConfig, double const co[8], state_t const &cph) const;
709 
710  void computeB4vect_ipole(double B4vect[4], std::string const magneticConfig, double const co[8], state_t const &cph, double spin) const;
721  double interpolate(int const N, double* const array, double* const Xq, double** const X, int* const X_params, std::string const *cond_limits) const;
731  double interpolate(int const N, double* const array, double* const Xq, double** const X_params, std::string const *cond_limits) const;
732 
733  private :
741  double interp1d(double const x, double const y0, double const y1) const;
751  double interpNd(int const N, double* const Xq, double** const X, double* const Y, std::string const *cond_limit) const;
760  int getIndice(double &xq, std::string const cond_limit, double const X_params[3], double* const X=NULL) const;
761 
762 };
763 
794  public:
795  double *intensity;
796  double *time;
797 
803  double *distance;
804 
808  double * first_dmin;
809 
815  int first_dmin_found;
816 
821  double *redshift;
822 
826  double *nbcrosseqplane;
827 
831  double *spectrum;
832 
833  double *stokesQ;
834  double *stokesU;
835  double *stokesV;
836 
842  double *binspectrum;
843 
848  ptrdiff_t offset;
849 
853  double * impactcoords;
854 
859  double *user1;
860 
865  double *user2;
866 
871  double *user3;
872 
877  double *user4;
878 
883  double *user5;
884 # ifdef HAVE_UDUNITS
888  Gyoto::SmartPointer<Gyoto::Units::Converter> intensity_converter_ ;
892  Gyoto::SmartPointer<Gyoto::Units::Converter> spectrum_converter_ ;
896  Gyoto::SmartPointer<Gyoto::Units::Converter> binspectrum_converter_ ;
897 # endif
898 
900  bool alloc;
901 
902  public:
904  Properties (double*, double*);
905 
917  void init(size_t nbnuobs=0);
918 
925  Properties& operator++();
926 
933  Properties& operator+=(ptrdiff_t offset);
934 
935  operator Gyoto::Quantity_t () const;
936 
937 # ifdef HAVE_UDUNITS
938  void intensityConverter(Gyoto::SmartPointer<Gyoto::Units::Converter>);
940  void intensityConverter(std::string);
942  void spectrumConverter(Gyoto::SmartPointer<Gyoto::Units::Converter>);
944  void spectrumConverter(std::string);
946  void binSpectrumConverter(Gyoto::SmartPointer<Gyoto::Units::Converter>);
948  void binSpectrumConverter(std::string);
950 # endif
951 };
952 
953 #endif
Compile-time configuration.
GYOTO converters.
Gyoto ubiquitous macros and typedefs.
Introspectable objects.
#define GYOTO_OBJECT
Declare class::properties and class::getProperties()
Definition: GyotoObject.h:84
#define GYOTO_OBJECT_ACCESSORS_UNIT(method)
Declare a quadruplet of accessors to double member that supports unit.
Definition: GyotoObject.h:70
Reference-counting pointers.
Base class for astronomical object.
Definition: GyotoAstrobj.h:200
double interpNd(int const N, double *const Xq, double **const X, double *const Y, std::string const *cond_limit) const
int __defaultfeatures
Whether some virtual methods are implemented.
Definition: GyotoAstrobj.h:215
virtual double transmission(double nuem, double dsem, state_t const &coord_ph, double const coord_obj[8]) const
Transmission: exp( αν * dsem )
virtual void setParameters(FactoryMessenger *fmp)
Main loop in Subcontractor_t function.
double interp1d(double const x, double const y0, double const y1) const
double deltamaxinsidermax_
Maximum Photon integration step inside rmax_ [geometrical units].
Definition: GyotoAstrobj.h:242
Eigen::Matrix4d Omatrix(double alphanu[4], double rnu[3], double Chi, double dsem) const
virtual double integrateEmission(double nu1, double nu2, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const
∫ν1ν2 Iν dν (or jν)
void getSinCos2Chi(double const fourvect[4], state_t const &cph, double const vel[4], double *sin2Chi, double *cos2Chi, bool elec=false) const
bool flag_radtransf_
1 if radiative transfer inside Astrobj, else 0
Definition: GyotoAstrobj.h:244
int shadow_
1 to highlight the shadow region in the image
Definition: GyotoAstrobj.h:246
double rmax_
Maximum distance to the center of the coordinate system [geometrical units].
Definition: GyotoAstrobj.h:234
void computeB4vect(double B4vect[4], std::string const magneticConfig, double const co[8], state_t const &cph) const
virtual int Impact(Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL)=0
Does a photon at these coordinates impact the object?
bool opticallyThin() const
Query whether object is optically thin.
virtual void radiativeQ(double Inu[], double Taunu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
emission and transmission together
double interpolate(int const N, double *const array, double *const Xq, double **const X, int *const X_params, std::string const *cond_limits) const
virtual double emission(double nu_em, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
Specific intensity Iν
virtual void processHitQuantities(Photon *ph, state_t const &coord_ph_hit, double const *coord_obj_hit, double dt, Astrobj::Properties *data) const
Fills Astrobj::Properties.
virtual double deltaMax(double coord[8])
Get max step constraint for adaptive integration.
virtual double rMax()
Get maximal distance from center of coordinate system.
int getIndice(double &xq, std::string const cond_limit, double const X_params[3], double *const X=NULL) const
virtual SmartPointer< Metric::Generic > metric() const
Get the Metric gg_.
virtual Gyoto::Quantity_t getDefaultQuantities()
Which quantities to compute if know was requested.
int noredshift_
1 to impose redshift factor g = 1
Definition: GyotoAstrobj.h:247
virtual Generic * clone() const =0
Cloner.
double getChi(double const fourvect[4], state_t const &cph, double const vel[4], bool elec=false) const
Eigen::Vector4d rotateJs(double jInu, double jQnu, double jUnu, double jVnu, double sin2Chi, double cos2Chi) const
SmartPointer< Gyoto::Metric::Generic > gg_
The Metric in this end of the Universe.
Definition: GyotoAstrobj.h:222
Observable properties of an Astronomical object.
Definition: GyotoAstrobj.h:792
Factory / SmartPointee::Subcontractor_t interface.
Definition: GyotoFactoryMessenger.h:92
Base class for metrics.
Definition: GyotoMetric.h:162
Object with properties.
Definition: GyotoObject.h:152
A null geodesic transporting light.
Definition: GyotoPhoton.h:57
Entry in a register (or a full register)
Definition: GyotoRegister.h:117
Can be pointed to by a SmartPointer.
Definition: GyotoSmartPointer.h:81
void initRegister()
Empty the Astrobj register.
SmartPointer< Astrobj::Generic > Subcontractor(FactoryMessenger *fmp, std::vector< std::string > const &plugin)
A template for Subcontractor_t functions.
Definition: GyotoAstrobj.h:77
SmartPointer< Gyoto::Astrobj::Generic > Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &)
A function to build instances of a specific Astrobj::Generic sub-class.
Definition: GyotoAstrobj.h:63
void Register(std::string name, Gyoto::Astrobj::Subcontractor_t *scp)
Make an Astrobj kind known to the Factory.
Gyoto::Register::Entry * Register_
The Astrobj register.
Gyoto::Astrobj::Subcontractor_t * getSubcontractor(std::string name, std::vector< std::string > &plugin, int errmode=0)
Query the Astrobj register.
void init(char const *pluglist=NULL)
Initialise the various registers.
Namespace for the Gyoto library.
Definition: GyotoAstrobj.h:44
unsigned int Quantity_t
Type for observabke quantities.
Definition: GyotoDefs.h:76