Gyoto::Astrobj::EquatorialHotSpot Class Reference

Inheritance diagram for Gyoto::Astrobj::EquatorialHotSpot:
Gyoto::Astrobj::ThinDisk Gyoto::Worldline Gyoto::Astrobj::Generic Gyoto::Functor::Double_constDoubleArray Gyoto::Hook::Listener Gyoto::SmartPointee Gyoto::Object

List of all members.

Public Types

typedef Gyoto::SmartPointer
< Gyoto::SmartPointee
Subcontractor_t (Gyoto::FactoryMessenger *, std::vector< std::string > const &)
 A subcontractor builds an object upon order from the Factory.

Public Member Functions

virtual Property const * getProperties () const
 Get list of properties.
 EquatorialHotSpot (const EquatorialHotSpot &o)
virtual EquatorialHotSpotclone () const
 Cloner.
void spotRadSize (double t)
double spotRadSize () const
void beaming (std::string const &b)
std::string beaming () const
void beamAngle (double t)
double beamAngle () const
double getMass () const
 Get mass of particule.
void metric (SmartPointer< Metric::Generic > gg)
 Set metric Smartpointer.
void setInitialCondition (double coord[8])
void getVelocity (double const pos[4], double vel[4])
 Get fluid 4-velocity at point.
double emission (double nu_em, double dsem, double *, double coord_obj[8]) const
virtual int setParameter (std::string name, std::string content, std::string unit)
 Set parameter by name.
void setParameters (FactoryMessenger *fmp)
 Main loop in Subcontractor_t function.
virtual void fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const
 Output a single Property to XML.
virtual double innerRadius () const
 Get rin_.
virtual double innerRadius (std::string const &) const
 Get rin_.
virtual void innerRadius (double)
 Set rin_.
virtual void innerRadius (double, std::string const &)
 Set rin_.
virtual double outerRadius () const
 Get rout_.
virtual double outerRadius (std::string const &) const
 Get rout_.
virtual void outerRadius (double)
 Set rout_.
virtual void outerRadius (double, std::string const &)
 Set rout_.
virtual double thickness () const
 Get thickness_.
virtual double thickness (std::string const &) const
 Get thickness_.
virtual void thickness (double)
 Set thickness_.
virtual void thickness (double, std::string const &)
 Set thickness_.
virtual int dir () const
 Get dir_.
virtual void dir (int)
 Set dir_.
virtual bool corotating () const
virtual void corotating (bool t)
 Get dir_==1.
virtual double operator() (double const coord[])
 Set dir_=t?1:-1.
virtual double projectedRadius (double const coord[]) const
 Projected radius of position coord on the equatorial plane.
virtual double sphericalPhi (double const coord[]) const
 Longitude.
virtual int Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL)
 Does a photon at these coordinates impact the object?
virtual SmartPointer
< Metric::Generic
metric () const
 Get the Metric gg_.
virtual double rMax ()
 Get maximal distance from center of coordinate system.
virtual double rMax () const
 Get maximal distance from center of coordinate system.
virtual double rMax (std::string const &unit)
 Get rmax_ is specified unit.
virtual double rMax (std::string const &unit) const
 Get rmax_ is specified unit.
virtual void rMax (double val)
 Set maximal distance from center of coordinate system.
virtual void rMax (double val, std::string const &unit)
 Set maximal distance from center of coordinate system.
virtual double deltaMax (double coord[8])
 Get max step constraint for adaptive integration.
const std::string kind () const
 Get the kind of the Astrobj (e.g. "Star").
void opticallyThin (bool flag)
 Set whether the object is optically thin.
bool opticallyThin () const
 Query whether object is optically thin.
void radiativeQ (bool flag)
bool radiativeQ () const
virtual void radiativeQ (double Inu[], double Taunu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const
void showshadow (bool flag)
bool showshadow () const
void redshift (bool flag)
bool redshift () const
virtual Gyoto::Quantity_t getDefaultQuantities ()
 Which quantities to compute if know was requested.
virtual void processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const
 Fills Astrobj::Properties.
virtual double emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const
 Specific intensity I.
virtual void emission (double Inu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const
 Specific intensity I for several values of em.
virtual double integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const
 12 I d (or j)
virtual void integrateEmission (double *I, double const *boundaries, size_t const *chaninds, size_t nbnu, double dsem, double *cph, double *co) const
 12 I d (or j)
virtual double transmission (double nuem, double dsem, double coord[8]) const
 Transmission: exp( * dsem ).
void incRefCount ()
 Increment the reference counter. Warning: Don't mess with the counter.
int decRefCount ()
 Decrement the reference counter and return current value. Warning: Don't mess with the counter.
int getRefCount ()
 Get the current number of references.
virtual bool isThreadSafe () const
 Whether this class is thread-safe.
void set (Property const &p, Value val)
 Set Value of a Property.
void set (Property const &p, Value val, std::string const &unit)
 Set Value (expressed in unit) of a Property.
void set (std::string const &pname, Value val)
 Set Value of a Property.
void set (std::string const &pname, Value val, std::string const &unit)
 Set Value (expressed in unit) of a Property.
Value get (Property const &p) const
 Get Value of a Property.
Value get (std::string const &pname) const
 Get Value of a Property.
Value get (Property const &p, std::string const &unit) const
 Get Value of a Property, converted to unit.
Value get (std::string const &pname, std::string const &unit) const
 Get Value of a Property, converted to unit.
Property const * property (std::string const pname) const
 Find property by name.
virtual void fillElement (Gyoto::FactoryMessenger *fmp) const
 Fill the XML element for this Object.
virtual void setParameter (Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit)
 Set parameter by Property (and name).
std::string describeProperty (Gyoto::Property const &p) const
 Format desrciption for a property.
void help () const
 Print (to stdout) some help on this class.
size_t getImin () const
 Get imin_.
size_t getImax () const
 Get imax_.
size_t getI0 () const
 Get i0_.
SmartPointer< Metric::Genericmetric () const
 Get metric.
void initCoord (std::vector< double > const &)
std::vector< double > initCoord () const
virtual void setInitCoord (const double coord[8], int dir=0)
 Set Initial coordinate.
virtual void setInitCoord (double const pos[4], double const vel[3], int dir=0)
 Set initial coordinate.
virtual void setPosition (double const pos[4])
 Set initial 4-position.
virtual void setVelocity (double const vel[3])
 Set initial 3-velocity.
void reset ()
 Forget integration, keeping initial contition.
void reInit ()
 Reset and recompute particle properties.
virtual std::string className () const
 "Worldline"
virtual std::string className_l () const
 "worldline"
void integrator (std::string const &type)
 Set the integrator.
std::string integrator () const
 Describe the integrator used by state_.
double deltaMin () const
 Get delta_min_.
void deltaMin (double h1)
 Set delta_min_.
double deltaMax () const
 Get delta_max_.
virtual double deltaMax (double const pos[8], double delta_max_external) const
void deltaMax (double h1)
void absTol (double)
 Set abstol_.
double absTol () const
 Get abstol_.
void relTol (double)
 Set reltol_.
double relTol () const
 Get reltol_.
double deltaMaxOverR () const
 Get delta_max_over_r_.
void deltaMaxOverR (double t)
 Set delta_max_over_r_.
void delta (const double delta)
 Assignment to another Worldline.
void delta (double, const std::string &unit)
 Set delta_ in specified units.
double delta () const
 Get delta_.
double delta (const std::string &unit) const
 Get delta_ in specified units.
double tMin () const
 Get tmin_.
double tMin (const std::string &unit) const
 Get tmin_ in specified unit.
void tMin (double tlim)
 Set tmin_.
void tMin (double, const std::string &unit)
 Set tmin_ in specified unit.
void adaptive (bool mode)
 Set adaptive_.
bool adaptive () const
 Get adaptive_.
void secondary (bool sec)
 Set secondary_.
bool secondary () const
 Get secondary_.
void maxiter (size_t miter)
 Set maxiter_.
size_t maxiter () const
 Get maxiter_.
double const * getCst () const
 Returns the worldline's cst of motion (if any).
void setCst (double const *cst, size_t const ncsts)
 Set Metric-specific constants of motion.
void setInitialCondition (SmartPointer< Metric::Generic > gg, const double coord[8], const int dir)
 Set or re-set the initial condition prior to integration.
void getInitialCoord (double dest[8]) const
 Get initial coordinate.
void getCoord (size_t index, double dest[8]) const
 Get coordinates corresponding to index.
void getCoord (double const *const dates, size_t const n_dates, double *const x1dest, double *const x2dest, double *const x3dest, double *const x0dot=NULL, double *const x1dot=NULL, double *const x2dot=NULL, double *const x3dot=NULL)
 Get 8-coordinates for specific dates.
void getCoord (double *x0, double *x1, double *x2, double *x3) const
 Get all computed positions.
void getCartesianPos (size_t index, double dest[4]) const
 Get Cartesian expression of 4-position at index.
virtual void xStore (size_t ind, double const coord[8])
 Store coord at index ind.
virtual void xFill (double tlim)
 Fill x0, x1... by integrating the Worldline from previously set inittial condition to time tlim.
size_t get_nelements () const
 Get number of computed dates.
void get_t (double *dest) const
 Get computed dates.
void getCartesian (double const *const dates, size_t const n_dates, double *const x, double *const y, double *const z, double *const xprime=NULL, double *const yprime=NULL, double *const zprime=NULL)
 Get the 6 Cartesian coordinates for specific dates.
void get_xyz (double *x, double *y, double *z) const
 Get 3-position in cartesian coordinates for computed dates.
void checkPhiTheta (double coord[8]) const
 Bring in [0,] and in [0,2].
void getSkyPos (SmartPointer< Screen > screen, double *dalpha, double *ddellta, double *dD) const
 Get computed positions in sky coordinates.
void get_dot (double *x0dot, double *x1dot, double *x2dot, double *x3dot) const
 Get computed 4-velocities.
void get_prime (double *x1prime, double *x2prime, double *x3prime) const
 Get computed 3-velocities.
void save_txyz (char *fichierxyz) const
 Save in a file.
void save_txyz (char *const filename, double const t1, double const mass_sun, double const distance_kpc, std::string const unit, SmartPointer< Screen > sc=NULL)
 Save, converted.

Public Attributes

 GYOTO_WORLDLINE
int stopcond
 Whether and why integration is finished.

Static Public Attributes

static GYOTO_OBJECT Property const properties []
 Property list.

Protected Member Functions

virtual void xAllocate ()
 Allocate x0, x1 etc. with default size.
virtual void xAllocate (size_t size)
 Allocate x0, x1 etc. with a specified size.
virtual size_t xExpand (int dir)
 Expand x0, x1 etc... to hold more elements.
virtual void xExpand (double *&x, int dir)
 Expand one array to hold more elements.
virtual void tell (Gyoto::Hook::Teller *)
 This is how a Teller tells.

Protected Attributes

double rin_
 disk inner radius in geometrical units
double rout_
 disk outer radius in geometrical units
double thickness_
 disk thickness
int dir_
 1 for corotating (default), -1 for counterrotating.
SmartPointer
< Gyoto::Metric::Generic
gg_
 The Metric in this end of the Universe.
double rmax_
 Maximum distance to the center of the coordinate system [geometrical units].
bool flag_radtransf_
 1 if radiative transfer inside Astrobj, else 0
int radiativeq_
 1 to use the new radiativeQ function (under dvp)
int shadow_
 1 to highlight the shadow region in the image
int noredshift_
 1 to impose redshift factor g = 1
std::string kind_
 The "kind" that is output in the XML entity.
std::vector< std::string > plugins_
 The plug-ins that needs to be loaded to access this instance's class.
SmartPointer
< Gyoto::Metric::Generic
metric_
 The Gyoto::Metric in this part of the universe.
double * x0_
 t or T
double * x1_
 r or x
double * x2_
 or y
double * x3_
 or z
double * x0dot_
 tdot or Tdot
double * x1dot_
 rdot or xdot
double * x2dot_
 dot or ydot
double * x3dot_
 dot or zdot
size_t x_size_
 Size of x0_, x1_... arrays.
size_t imin_
 Minimum index for which x0_, x1_... have been computed.
size_t i0_
 Index of initial condition in array.
size_t imax_
 Maximum index for which x0_, x1_... have been computed.
bool adaptive_
 Whether integration should use adaptive delta.
bool secondary_
 Experimental: choose 0 to compute only primary image.
double delta_
 Initial integrating step.
double tmin_
 Time limit for the integration (geometrical units).
double * cst_
 Worldline's csts of motion (if any).
size_t cst_n_
 Number of constants of motion.
int wait_pos_
 Hack in setParameters().
double * init_vel_
 Hack in setParameters().
size_t maxiter_
 Maximum number of iterations when integrating.
double delta_min_
 Minimum integration step for the adaptive integrator.
double delta_max_
 Maximum integration step for the adaptive integrator.
double delta_max_over_r_
 Numerical tuning parameter.
double abstol_
 Absolute tolerance of the integrator.
double reltol_
 Absolute tolerance of the integrator.
SmartPointer
< Worldline::IntegState::Generic
state_
 An object to hold the integration state.

Private Types

enum  beaming_t { IsotropicBeaming = 0, NormalBeaming = 1, RadialBeaming = 2 }

Private Attributes

double sizespot_
beaming_t beaming_
double beamangle_

Friends

class Gyoto::SmartPointer< Gyoto::Astrobj::EquatorialHotSpot >
class Gyoto::SmartPointer< Gyoto::Astrobj::ThinDisk >
class Gyoto::SmartPointer< Gyoto::Astrobj::Generic >
class Gyoto::Hook::Teller

Member Typedef Documentation

typedef Gyoto::SmartPointer<Gyoto::SmartPointee> Gyoto::SmartPointee::Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &) [inherited]

A subcontractor builds an object upon order from the Factory.

Various classes need to provide a subcontractor to be able to instantiate themselves upon order from the Factory. A subcontractor is a function (often a static member function) which accepts a pointer to a FactoryMessenger as unique parameter, communicates with the Factory using this messenger to read an XML description of the object to build, and returns this objet. SmartPointee::Subcontractor_t* is just generic enough a typedef to cast to and from other subcontractor types: Astrobj::Subcontractor_t, Metric::Subcontractor_t, Spectrum::Subcontractor_t. A subcontractor needs to be registered using the relevant Register() function: Astrobj::Register(), Metric::Register(), Spectrum::Register().


Member Function Documentation

void Gyoto::Worldline::checkPhiTheta ( double  coord[8]  )  const [inherited]

Bring in [0,] and in [0,2].

checkPhiTheta() Modifies coord if the corrdinates are spherical-like so that coord[2]=theta is in [0,pi] and coord[3]=phi is in [0,2pi]. Important to use in all astrobj in spherical coordinates to prevent "z-axis problems".

virtual EquatorialHotSpot* Gyoto::Astrobj::EquatorialHotSpot::clone (  )  const [virtual]

Cloner.

This method must be implemented by the various Astrobj::Generic subclasses in order to support cloning:

 SmartPointer<Astrobj> deep_copy = original->clone();

Cloning is necessary for multi-threading, recommended for interaction with the Yorick plug-in etc.

Implementing it is very straightforward, as long as the copy constructor Generic(const Generic& ) has been implemented:

 MyAstrobj* MyAstrobj::clone() const { return new MyAstrobj(*this); }

Reimplemented from Gyoto::Astrobj::ThinDisk.

void Gyoto::Worldline::delta ( const double  delta  )  [inherited]

Assignment to another Worldline.

Set delta_

void Gyoto::Worldline::deltaMax ( double  h1  )  [inherited]

Set delta_max_

virtual double Gyoto::Worldline::deltaMax ( double const   pos[8],
double  delta_max_external 
) const [virtual, inherited]

Get delta max at a given position

Parameters:
[in] pos 4-position
[in] delta_max_external external constraint on delta_max
Returns:
the smallest value between delta_max_, delta_max_external, and R*delta_max_over_r_ where R is pos[1] in spherical coordinates and max(x1, x2, x3) in Cartesian coordinates.
virtual double Gyoto::Astrobj::Generic::deltaMax ( double  coord[8]  )  [virtual, inherited]

Get max step constraint for adaptive integration.

Parameters:
[in] coord position
Returns:
max step to find this object reliably

Reimplemented in Gyoto::Astrobj::Complex.

std::string Gyoto::Object::describeProperty ( Gyoto::Property const &  p  )  const [inherited]

Format desrciption for a property.

Returns a string containing the name(s) and type of the property, as well as whether it supports unit.

virtual void Gyoto::Astrobj::Generic::emission ( double  Inu[],
double  nu_em[],
size_t  nbnu,
double  dsem,
double  coord_ph[8],
double  coord_obj[8] = NULL 
) const [virtual, inherited]

Specific intensity I for several values of em.

Called by the default implementation for processHitQuantities().

emission() computes the intensity I emitted by the small volume of length dsem. It should take self-absorption along dsem into account.

Same as emission(double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const looping on several values of nu_em.

Parameters:
Inu[nbnu] Output (must be set to a previously allocated array of doubles)
nu_em[nbnu] Frequencies at emission
nbnu Size of Inu[] and nu_em[]
dsem Length over which to integrate inside the object
coord_ph Photon coordinate
coord_obj Emitter coordinate at current photon position
Returns:
I or dI [W m-2 sr-2]

Reimplemented in Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

virtual double Gyoto::Astrobj::Generic::emission ( double  nu_em,
double  dsem,
double  coord_ph[8],
double  coord_obj[8] = NULL 
) const [virtual, inherited]

Specific intensity I.

Called by the default implementation for processHitQuantities().

emission() computes the intensity I emitted by the small volume of length dsem, in the emitter's frame. It should take self-absorption along dsem into account.

Reminder :

  • intensity = I [J m^-2 s^-1 ster^-1 Hz^-1];
  • invariant intensity = I/3, which has the same value in any frame;
  • emission coefficient = j [J m^-3 s^-1 ster^-1 Hz^-1] , defined by dI = j*ds, where ds is the distance travelled by the photon inside the object;
  • invariant emission coef = j/2, which has the same value in any frame.

The equation used for radiative transfer (without absorption) is:

d(I/3)/d = (j/2) [*]

where is the integration parameter along the null geodesic.

NB: Let us consider a particular observer, with being the frequency measured by this observer, and ds being the proper distance (as measured by the observer) that the photon travels as it moves from to +d along its geodesic. Then it can be shown that:

d = ds/

This shows that Eq. [*] is homogeneous.

The default implementation returns 1. if optically thick and dsem if optically thin. It allows for a quick implementation of your object for visualization purposes.

Parameters:
nu_em Frequency at emission [Hz]
dsem length over which to integrate inside the object [geometrical units]
coord_ph Photon coordinate
coord_obj Emitter coordinate at current photon position

Reimplemented in Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::InflateStar, Gyoto::Astrobj::Jet, Gyoto::Astrobj::NeutronStarAnalyticEmission, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::ThinDiskIronLine, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::Torus, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

virtual void Gyoto::Object::fillElement ( Gyoto::FactoryMessenger fmp  )  const [virtual, inherited]

Fill the XML element for this Object.

The base implementation simply calls fillProperty() for each Property defined for the Object.

Derived classes should avoid overriding fillElement(). It may make sense occasionally, e.g. to make sure that the metric is output first.

To customize how a given Property is rendered, it is better to override fillProperty().

If this method is overridden, the implementation should in general call fillElement() on the direct base.

Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Spectrometer::Complex, and Gyoto::Scenery.

virtual void Gyoto::Astrobj::EquatorialHotSpot::fillProperty ( Gyoto::FactoryMessenger fmp,
Property const &  p 
) const [virtual]

Output a single Property to XML.

The base implementation decides what to do based on the p.type. The format matches how setParameters() an setParameter() would interpret the XML descition.

Overriding this method should be avoided, but makes sense in some cases (for instance Screen::fillProperty() selects a different unit for Distance based on its magnitude, so that stellar sizes are expressed in solar radii while smaller sizes can be expressed in meters and larger sizes in parsecs).

Overriding implementation should fall-back on calling the implementation in the direct parent class:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual void fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const ;
 };
 void B::fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const {
   if (name=="Duff") fmp->doSomething();
   else A::fillProperty(fmp, p);
 }

Reimplemented from Gyoto::Object.

void Gyoto::Worldline::getCartesian ( double const *const   dates,
size_t const   n_dates,
double *const   x,
double *const   y,
double *const   z,
double *const   xprime = NULL,
double *const   yprime = NULL,
double *const   zprime = NULL 
) [inherited]

Get the 6 Cartesian coordinates for specific dates.

The 6 coordinates (x, y, z, dx/dt, dy/dt, dz/dt) will be computed using the integrator and interpolated if necessary, so they will be as accurate as possible. Transforming to Cartesian coordinates is not necessarily meaningful.

Parameters:
[in] dates List of dates for which the coordinates are to be computed;
[in] n_dates Number of dates to compute ;
[out] x,y,z,xprime,yprime,zprime Arrays in which to store the result. These pointer may be set to NULL to retrieve only part of the information. Else, they must be pre-allocated.

Reimplemented in Gyoto::Astrobj::Star.

void Gyoto::Worldline::getCoord ( double *  x0,
double *  x1,
double *  x2,
double *  x3 
) const [inherited]

Get all computed positions.

Get all the pre-computed 8 coordinates (e.g. thanks to a prior call to xFill()) of this worldline.

void Gyoto::Worldline::getCoord ( double const *const   dates,
size_t const   n_dates,
double *const   x1dest,
double *const   x2dest,
double *const   x3dest,
double *const   x0dot = NULL,
double *const   x1dot = NULL,
double *const   x2dot = NULL,
double *const   x3dot = NULL 
) [inherited]

Get 8-coordinates for specific dates.

The coordinates will be computed using the integrator, so they will be as accurate as possible. Some heuristics are used to speed up the process and it is presumably faster to call this routine with a sorted list of dates. The line will be integrated further as required. An error will be thrown if it is not possible to reach a certain date.

Parameters:
dates the list of dates for which the coordinates are to be computed;
n_dates the number of dates to compute ;
x1dest,x2dest,x3dest,x0dot,x1dot,x2dot,x3dot arrays in which to store the result. These pointer may be set to NULL to retrieve only part of the information. They must be pre-allocated.
double const* Gyoto::Worldline::getCst (  )  const [inherited]

Returns the worldline's cst of motion (if any).

Return pointer to array holding the previously set Metric-specific constants of motion

virtual Gyoto::Quantity_t Gyoto::Astrobj::Generic::getDefaultQuantities (  )  [virtual, inherited]

Which quantities to compute if know was requested.

Return a Gyoto::Quantity_t suitable as input to Gyoto::Scenery::setRequestedQuantities() to set de default quantities to compute for this object. The default of these defaults GYOTO_QUANTITY_INTENSITY.

Reimplemented in Gyoto::Astrobj::PageThorneDisk.

virtual Property const* Gyoto::Astrobj::EquatorialHotSpot::getProperties (  )  const [virtual]

Get list of properties.

This method is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_END macro.

Reimplemented from Gyoto::Astrobj::ThinDisk.

void Gyoto::Astrobj::EquatorialHotSpot::getVelocity ( double const   pos[4],
double  vel[4] 
) [virtual]

Get fluid 4-velocity at point.

Fill vel with the 4-vector velocity of the fluid at 4-position pos. getVelocity() should work at some distance from the equatorial plane. The default implementation calls Metric::Generic::circularVelocity().

Parameters:
[in] pos 4-position at which to compute velocity;
[out] vel 4-velocity at pos.

Reimplemented from Gyoto::Astrobj::ThinDisk.

void Gyoto::Object::help (  )  const [inherited]

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

virtual int Gyoto::Astrobj::ThinDisk::Impact ( Gyoto::Photon ph,
size_t  index,
Astrobj::Properties data = NULL 
) [virtual, inherited]

Does a photon at these coordinates impact the object?

Impact() checks whether a Photon impacts the object between two integration steps of the photon's trajectory (those two steps are photon->getCoord(index, coord1) and photon->getCoord(index+1, coord2)). Impact returns 1 if the photon impacts the object between these two steps, else 0. In many cases of geometrically thick obects, the implementation Astrobj::Standard::Impact() will be fine.

Impact will call Generic::processHitQuantities() (which is virtual and may be re-implemented) to compute observable properties on demand: if the data pointer is non-NULL, the object will look in it for pointers to properties which apply to its kind. If a pointer to a property known to this object is present, then the property is computed and store at the pointed-to address. For instance, all objects know the "intensity" property. If data->intensity != NULL, the instensity is computed and stored in *data->intensity.

If data is non-NULL and only in this case, processHitQuantities() will also call ph->transmit() to update the transmissions of the Photon (see Photon::transmit(size_t, double)). This must not be done if data is NULL (see Astrobj::Complex::Impact() for an explanation).

Impact() may not extend the ph Worldline. The only two dates that are guaranteed to be defined are at indices index and index+1.

Parameters:
ph Gyoto::Photon aimed at the object;
index Index of the last photon step;
data Pointer to a structure to hold the observables at impact.
Returns:
1 if impact, 0 if not.

Implements Gyoto::Astrobj::Generic.

virtual void Gyoto::Astrobj::Generic::integrateEmission ( double *  I,
double const *  boundaries,
size_t const *  chaninds,
size_t  nbnu,
double  dsem,
double *  cph,
double *  co 
) const [virtual, inherited]

12 I d (or j)

Like double integrateEmission(double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]) const for each Spectrometer channel.

Reimplemented in Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

virtual double Gyoto::Astrobj::Generic::integrateEmission ( double  nu1,
double  nu2,
double  dsem,
double  c_ph[8],
double  c_obj[8] = NULL 
) const [virtual, inherited]

12 I d (or j)

Compute the integral of emission() from 1 to 2. The default implementation is a numerical integrator which works well enough and is reasonably fast if emission() is a smooth function (i.e. no emission or absorption lines). If possible, it is wise to implement an analytical solution. It is used by processHitQuantities to compute the "BinSpectrum" quantity which is the most physical: it is the only quantity that can be actually measured directly by a real-life instrument.

Reimplemented in Gyoto::Astrobj::Torus, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

void Gyoto::Worldline::integrator ( std::string const &  type  )  [inherited]

Set the integrator.

Initialize state_ to use the required integrator.

Parameters:
[in] type Either "Legacy" or (if GYOTO_HAVE_BOOST_INTEGRATORS) one of "runge_kutta_cash_karp54", "runge_kutta_fehlberg78", "runge_kutta_dopri5", "runge_kutta_cash_karp54_classic"
virtual bool Gyoto::Object::isThreadSafe (  )  const [virtual, inherited]

Whether this class is thread-safe.

Return True if this object is thread-safe, i.e. if an instance and its clone can be used in parallel threads (in the context of Scenery::raytrace()). Known objects which are not thread-safe include Lorene metrics and everything from the Python plug-in.

The default implementation considers that the class itself is thread safe and recurses into the declared properties to check whether they are safe too. Classes that abide to the Object/Property paradigm and are themselves thread-safe have nothing special to do.

Objects that clone children in their copy constructor that are not declared as properties must take these children into account.

Classes that are never thread-safe must declare it. It acn be easily done using GYOTO_OBJECT_THREAD_SAFETY in the class declaration and GYOTO_PROPERTY_THREAD_UNSAFE in the class definition.

virtual double Gyoto::Astrobj::ThinDisk::operator() ( double const   coord[]  )  [virtual, inherited]

Set dir_=t?1:-1.

A function which changes sign on the equatorial plane. theta-pi/2 or z

Implements Gyoto::Functor::Double_constDoubleArray.

bool Gyoto::Astrobj::Generic::opticallyThin (  )  const [inherited]

Query whether object is optically thin.

See opticallyThin(bool flag).

void Gyoto::Astrobj::Generic::opticallyThin ( bool  flag  )  [inherited]

Set whether the object is optically thin.

Set flag indicating that radiative transfer should be integrated, i.e. the object is to be considered optically thin.

Parameters:
flag,: 1 if optically thin, 0 if optically thick.
virtual void Gyoto::Astrobj::Generic::processHitQuantities ( Photon ph,
double *  coord_ph_hit,
double *  coord_obj_hit,
double  dt,
Astrobj::Properties data 
) const [virtual, inherited]

Fills Astrobj::Properties.

processHitQuantities fills the requested data in Impact. To use it, you need to call it in the Impact() method for your object in case of hit. It will fill Redshift, Intensity, Spectrum, BinSpectrum and update the Photon's transmission by calling Photon::transmit(), only if data==NULL.

You can overload it for your Astrobj. The generic implementation calls emission(), integrateEmission() and transmission() below.

Reimplemented in Gyoto::Astrobj::DynamicalDiskBolometric, Gyoto::Astrobj::PageThorneDisk, and Gyoto::Astrobj::UniformSphere.

Property const* Gyoto::Object::property ( std::string const   pname  )  const [inherited]

Find property by name.

Look into the Property list for a Property whose name (or name_false, for a boolean Property) is pname. Return a const pointer to the first such property found, or NULL if none is found.

virtual void Gyoto::Astrobj::Generic::rMax ( double  val,
std::string const &  unit 
) [virtual, inherited]

Set maximal distance from center of coordinate system.

Call Generic::rMax(double val) after converting val from unit to geometrical units.

Parameters:
val rmax_ expressed in unit "unit";
unit string...
virtual void Gyoto::Astrobj::Generic::rMax ( double  val  )  [virtual, inherited]

Set maximal distance from center of coordinate system.

Set maximal distance from center of coordinate system at which a Photon may hit the object.

Parameters:
val new rmax_ in geometrical units.
virtual double Gyoto::Astrobj::Generic::rMax ( std::string const &  unit  )  [virtual, inherited]

Get rmax_ is specified unit.

Call rMax() and convert result to unit.

Parameters:
unit string
Returns:
double rmax converted to unit
virtual double Gyoto::Astrobj::Generic::rMax (  )  [virtual, inherited]

Get maximal distance from center of coordinate system.

Get maximal distance from center of coordinate system at which a Photon may hit the object.

Child classes may use the rmax_ member to cache this value, if its current value is DBL_MAX.

It can also be set using rMax().

Returns:
rmax_ in geometrical units

Reimplemented in Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::Star, and Gyoto::Astrobj::Torus.

void Gyoto::Worldline::setCst ( double const *  cst,
size_t const   ncsts 
) [inherited]

Set Metric-specific constants of motion.

The will (re)allocate Worldline::cst_, copy cst into it, and set Worldline::cst_n_.

virtual void Gyoto::Worldline::setInitCoord ( double const   pos[4],
double const   vel[3],
int  dir = 0 
) [virtual, inherited]

Set initial coordinate.

Parameters:
pos initial 4-position
vel initial 3-velocity
dir direction of integration
virtual void Gyoto::Worldline::setInitCoord ( const double  coord[8],
int  dir = 0 
) [virtual, inherited]

Set Initial coordinate.

Set imin_=imax_=i0_, and x_[i0_]=coord[].

If dir==1, i0_ is set to 0. If dir==-1, i0_ is set to x_size_-1.

If dir==0 and the Worldine has never been computed (i0_==0, imin_==1 and imax_==0), then dir defaults to 1 for a massive particle and -1 for a massless particle.

If dir==0 and the Worldine has already been computed, i0_ is not changed.

Parameters:
coord new initial coordinates
dir direction of integration. 1 for forward integration, -1 for backards integration, 0 for unknown or both.

Reimplemented in Gyoto::Astrobj::StarTrace.

void Gyoto::Worldline::setInitialCondition ( SmartPointer< Metric::Generic gg,
const double  coord[8],
const int  dir 
) [inherited]

Set or re-set the initial condition prior to integration.

Parameters:
gg Gyoto::SmartPointer to the Gyoto::Metric in this universe;
coord 8 element array containing the initial condition, i.e. the 4-position and the 4-velocity of the Photon at the receiving end;
dir direction: 1 for future, -1 for past.
virtual void Gyoto::Object::setParameter ( Gyoto::Property const &  p,
std::string const &  name,
std::string const &  content,
std::string const &  unit 
) [virtual, inherited]

Set parameter by Property (and name).

This function is used when parsing an XML description, if Property (p) of this name is found (i.e. either p.name or p.name_false is equal to name). Implementation should fall-back on calling the direct's parent implementation:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual void setParameter(Gyoto::Property const &p,
                            std::string name,
                                std::string content,
                                std::string unit);
 };
 void B::setParameter(Gyoto::Property const &p,
                          std::string name,
                          std::string content,
                          std::string unit) {
   if (name=="Duff") doSomething(content, unit);
   else A::setParameter(p, name, content, unit);
 }
Parameters:
p Property that matches name (p.name == name or p.name_false == name)
name XML name of the parameter (XML entity)
content string representation of the value
unit string representation of the unit

Reimplemented in Gyoto::Astrobj::PolishDoughnut.

virtual int Gyoto::Astrobj::EquatorialHotSpot::setParameter ( std::string  name,
std::string  content,
std::string  unit 
) [virtual]

Set parameter by name.

This function is used when parsing an XML description, if no Property of this name is found. Overriding implementation should fall-back on calling the direct's parent implementation:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual int setParameter(std::string name,
                            std::string content,
                            std::string unit);
 };
 int B::setParameter(std::string name,
                            std::string content,
                            std::string unit) {
   if (name=="Duff") doSomething(content, unit);
   else return A::setParameter(name, content, unit);
   return 0;  // name was known
 }
Parameters:
name XML name of the parameter (XML entity). This may have a path component, e.g. "Astrobj::Radius", in which case a property named "Astrobj" will be sought in the current object, and setParameter will be called recusrively on this Astrobj with Radius as name.
content string representation of the value
unit string representation of the unit
Returns:
0 if this parameter is known, 1 if it is not.

Reimplemented from Gyoto::Object.

void Gyoto::Astrobj::EquatorialHotSpot::setParameters ( FactoryMessenger fmp  )  [virtual]

Main loop in Subcontractor_t function.

The Subcontractor_t function for each Astrobj kind should look somewhat like this (templated as Gyoto::Astrobj::Subcontractor<MyKind>):

 SmartPointer<Astrobj::Generic>
 Gyoto::Astrobj::MyKind::Subcontractor(FactoryMessenger* fmp) {
   SmartPointer<MyKind> ao = new MyKind();
   ao -> setParameters(fmp);
   return ao;
 }

Each object kind should implement setParameter(string name, string content, string unit) to interpret the individual XML elements. setParameters() can be overloaded in case the specific Astrobj class needs low level access to the FactoryMessenger. See UniformSphere::setParameters().

Reimplemented from Gyoto::Astrobj::Generic.

virtual void Gyoto::Worldline::tell ( Gyoto::Hook::Teller msg  )  [protected, virtual, inherited]

This is how a Teller tells.

A teller will basically call listener->tell(this).

Parameters:
msg Teller* the Teller who is telling... Useful if the Listener listens to several Tellers.

Reimplemented from Gyoto::Hook::Listener.

virtual double Gyoto::Astrobj::Generic::transmission ( double  nuem,
double  dsem,
double  coord[8] 
) const [virtual, inherited]

Transmission: exp( * dsem ).

transmission() computes the transmission of this fluid element or 0 if optically thick. The default implementation returns 1. (no attenuation) if optically thin, 0. if optically thick.

Parameters:
nuem frequency in the fluid's frame
coord Photon coordinate
dsem geometrical length in geometrical units

Reimplemented in Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Torus, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.

virtual void Gyoto::Worldline::xAllocate ( size_t  size  )  [protected, virtual, inherited]

Allocate x0, x1 etc. with a specified size.

Parameters:
size : number of cells in each array x0, x1 etc.

Reimplemented in Gyoto::Astrobj::StarTrace.

virtual void Gyoto::Worldline::xAllocate (  )  [protected, virtual, inherited]

Allocate x0, x1 etc. with default size.

The default size is GYOTO_DEFAULT_X_SIZE

virtual void Gyoto::Worldline::xExpand ( double *&  x,
int  dir 
) [protected, virtual, inherited]

Expand one array to hold more elements.

If you need to expand more arrays than x0_ ... x3_ and the dots, call this on your array before calling xExpand(int dir).

Parameters:
inout] x array to expand
[in] dir 
virtual size_t Gyoto::Worldline::xExpand ( int  dir  )  [protected, virtual, inherited]

Expand x0, x1 etc... to hold more elements.

Double the size of arrays x0, x1 etc. and copy old version of the array in the first half if dir =1 and in the second half if dir =-1.

Parameters:
dir : 1 to expand after last element, -1 to expand before first element
Returns:
ind : if dir=1, new index of old last element, if dir=-1, new index of old first element

Reimplemented in Gyoto::Astrobj::StarTrace.


Member Data Documentation

double Gyoto::Worldline::abstol_ [protected, inherited]

Absolute tolerance of the integrator.

Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.

double Gyoto::Worldline::delta_ [protected, inherited]

Initial integrating step.

Default: GYOTO_DEFAULT_DELTA

double Gyoto::Worldline::delta_max_ [protected, inherited]

Maximum integration step for the adaptive integrator.

The default (GYOTO_DEFAULT_DELTA_MAX) is usually fine.

For IntegState::Legacy, set it in the Metric instead!

double Gyoto::Worldline::delta_max_over_r_ [protected, inherited]

Numerical tuning parameter.

For IntegState::Legacy, set it in the Metric instead!

Ensure that delta (the numerical integration step) is never larger than a fraction of the distance between the current location and the center of the coordinate system.

The default (GYOTO_DEFAULT_DELTA_MAX_OVER_R) is usually fine.

double Gyoto::Worldline::delta_min_ [protected, inherited]

Minimum integration step for the adaptive integrator.

The default (GYOTO_DEFAULT_DELTA_MIN) is usually fine.

For IntegState::Legacy, set it in the Metric instead!

std::string Gyoto::Object::kind_ [protected, inherited]

The "kind" that is output in the XML entity.

E.g. for an Astrobj, fillElement() will ensure

   <Astrobj kind="kind_" ...>...</Astrobj>

is written.

std::vector<std::string> Gyoto::Object::plugins_ [protected, inherited]

The plug-ins that needs to be loaded to access this instance's class.

E.g. for an Astrobj, fillElement() will ensure

   <Astrobj ... plugin="plugins_">...</Astrobj>

is written.

Property list.

This static member is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_START, GYOTO_PROPERTY_END and GYOTO_PROPERTY_* macros.

The list of properties is implemented as a static array of Property instances. The last item in a Property of type Property::empty_t, which evaluates to false, so the list can be considered to be NULL-terminated (it is actually rather false-terminated). This empty_t last item can be a link to another Property list: for instance, the last item in Gyoto::Astrobj::Standard::properties is a link to Gyoto::Astrobj::Generic::properties.

Reimplemented from Gyoto::Astrobj::ThinDisk.

double Gyoto::Worldline::reltol_ [protected, inherited]

Absolute tolerance of the integrator.

Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.

double Gyoto::Astrobj::Generic::rmax_ [protected, inherited]

Maximum distance to the center of the coordinate system [geometrical units].

Maximum distance from the center of the coordinate system at which a photon may hit the object. Child classes may compute a decent value for rmax_ at any time if rmax_ is DBL_MAX. External classes (Photons in particular) must use rMax() to access this information.

rmax_ is in geometrical units.

bool Gyoto::Worldline::secondary_ [protected, inherited]

Experimental: choose 0 to compute only primary image.

This feature is in development.

double Gyoto::Astrobj::ThinDisk::thickness_ [protected, inherited]

disk thickness

Geometrical thickness in geometrical units. Used only in the optically thin regime (flag_radtransf_==1). Should be << rin_. Default: 1e-3.

double Gyoto::Worldline::tmin_ [protected, inherited]

Time limit for the integration (geometrical units).

Computation does not go back before tmin_. Default is -DBL_MAX. tmin_ is always expressed in geometrical units, it is essentially a tuning parameter for the ray-tracing process. tmin_ should be chosen to always be longer than the distance between the screen and the object.

Reimplemented in Gyoto::Astrobj::StarTrace.


The documentation for this class was generated from the following file:

Generated on 22 Jul 2017 for Gyoto by  doxygen 1.6.1