Gyoto
|
Optically thick or thin, spherical objects. More...
#include <GyotoUniformSphere.h>
Public Types | |
typedef Gyoto::SmartPointer< Gyoto::SmartPointee > | Subcontractor_t(Gyoto::FactoryMessenger *) |
A subcontractor builds an object upon order from the Factory. More... | |
Public Member Functions | |
virtual Property const * | getProperties () const |
Get list of properties. More... | |
UniformSphere (std::string kind, SmartPointer< Metric::Generic > gg, double radius) | |
Standard constructor. More... | |
UniformSphere (std::string kind) | |
Default constructor. More... | |
UniformSphere (const UniformSphere &orig) | |
Copy constructor. | |
virtual | ~UniformSphere () |
Destructor. | |
virtual std::string | className () const |
"UniformSphere" | |
virtual std::string | className_l () const |
"uniformsphere" | |
virtual void | spectrum (SmartPointer< Spectrum::Generic >) |
Set spectrum_. | |
virtual SmartPointer< Spectrum::Generic > | spectrum () const |
Get spectrum_. | |
virtual void | opacity (SmartPointer< Spectrum::Generic >) |
Set opacity_. | |
virtual SmartPointer< Spectrum::Generic > | opacity () const |
Get opacity_. | |
double | radius () const |
Get radius_ in geometrical units. | |
virtual void | radius (double) |
Set radius_ in geometrical units. | |
double | radius (std::string const &) const |
Get radius_ in specified unit. | |
virtual void | radius (double, std::string const &) |
Set radius_ in specified unit. | |
double | deltaMaxOverRadius () const |
Get dltmor_. | |
virtual void | deltaMaxOverRadius (double f) |
Set dltmor_. | |
double | deltaMaxOverDistance () const |
Get dltmod_. | |
virtual void | deltaMaxOverDistance (double f) |
Set dltmod_. | |
bool | isotropic () const |
void | isotropic (bool) |
double | alpha () const |
void | alpha (double) |
virtual double | operator() (double const coord[4]) |
Square distance to the center of the sphere. More... | |
virtual double | deltaMax (double *coord) |
virtual void | safetyValue (double val) |
Set Standard::safety_value_. | |
virtual double | safetyValue () const |
Get Standard::safety_value_. | |
virtual int | Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL) |
Does a photon at these coordinates impact the object? More... | |
virtual double | operator() (double const data[])=0 |
The actual function. | |
virtual double | giveDelta (double coord[8]) |
Maximum δ inside object. More... | |
virtual Generic * | clone () const =0 |
Cloner. More... | |
virtual SmartPointer< Metric::Generic > | metric () const |
Get the Metric gg_. | |
virtual void | metric (SmartPointer< Metric::Generic >) |
Set the Metric gg_. | |
virtual double | rMax () |
Get maximal distance from center of coordinate system. More... | |
virtual double | rMax () const |
Get maximal distance from center of coordinate system. | |
virtual double | rMax (std::string const &unit) |
Get rmax_ is specified unit. More... | |
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. More... | |
virtual void | rMax (double val, std::string const &unit) |
Set maximal distance from center of coordinate system. More... | |
virtual double | deltaMax (double coord[8]) |
Get max step constraint for adaptive integration. More... | |
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. More... | |
bool | opticallyThin () const |
Query whether object is optically thin. More... | |
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. More... | |
virtual void | setParameters (FactoryMessenger *fmp) |
Main loop in Subcontractor_t function. More... | |
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 More... | |
virtual void | integrateEmission (double *I, double const *boundaries, size_t const *chaninds, size_t nbnu, double dsem, double *cph, double *co) const |
∫ν1ν2 Iν dν (or jν) More... | |
virtual double | transmission (double nuem, double dsem, double coord[8]) const |
Transmission: exp( αν * dsem ) More... | |
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. | |
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. More... | |
virtual void | fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const |
Output a single Property to XML. More... | |
virtual void | fillElement (Gyoto::FactoryMessenger *fmp) const |
Fill the XML element for this Object. More... | |
virtual int | setParameter (std::string name, std::string content, std::string unit) |
Set parameter by name. More... | |
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) More... | |
std::string | describeProperty (Gyoto::Property const &p) const |
Format desrciption for a property. More... | |
void | help () const |
Print (to stdout) some help on this class. More... | |
Static Public Attributes | |
static GYOTO_OBJECT Property const | properties [] |
Protected Member Functions | |
virtual 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)=0 |
Yield the Cartesian coordinates of the center of the sphere. More... | |
virtual void | getVelocity (double const pos[4], double vel[4])=0 |
Yield velocity of the center of the sphere. | |
virtual double | emission (double nu_em, double dsem, double cp[8], double co[8]=NULL) const |
Emission is determined by spectrum_ and opacity_. | |
virtual double | integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const |
∫ν1ν2 Iν dν (or jν) More... | |
virtual double | transmission (double nuem, double dsem, double *) const |
Transmission is determined by opacity_. | |
void | processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Properties *data) const |
Fills Astrobj::Properties. More... | |
Protected Attributes | |
double | radius_ |
sphere radius [geometrical units] | |
bool | isotropic_ |
if 1, then emission just returns 1 | |
double | alpha_ |
index Gamma is: alpha_ = 2-Gamma More... | |
SmartPointer< Spectrum::Generic > | spectrum_ |
sphere emission law | |
SmartPointer< Spectrum::Generic > | opacity_ |
if optically thin, opacity law | |
double | dltmor_ |
see deltaMax(double*) | |
double | dltmod_ |
see deltaMax(double*) | |
double | critical_value_ |
See operator()(double const coord[4]) | |
double | safety_value_ |
See operator()(double const coord[4]) | |
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]. More... | |
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. More... | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Astrobj::UniformSphere > |
Optically thick or thin, spherical objects.
Gyoto::Astrobj::UniformSphere is an abstract type from which uniform, spherical objects inherit (in particular, the Gyoto::Astrobj::Star and Gyoto::Astrobj::FixedStar classes).
These objects are coordinate-spherical: they comprise all the points within a given radius from a centre. The distance is the usual Euclidian distance in a Cartesian coordinate system which is trivially determined by the coordinate system in which the Metric is expressed.
The sphere is in solid motion: all the points have the same 4-velocity. The centre of the sphere may move. This motion and the velocity are provided by the derived classes through the getCartesian() and getVelocity() methods.
The spheres can be optically thick or optically thin. In the optically thin case, the opacity law provided as a Gyoto::Spectrum also sets both the emissivity. Another Gyoto::Spectrum provides the emission law of the source, which is uniform.
Gyoto::Astrobj::UniformSphere::setParameters() take care of interpreting the XML elements describing the parameters of the sphere:
setGenericParameters() also takes care of calling setParameter().
|
inherited |
A subcontractor builds an object upon order from the Factory.
Various classes need to provide a subcontractor to be able to instanciate 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().
Gyoto::Astrobj::UniformSphere::UniformSphere | ( | std::string | kind, |
SmartPointer< Metric::Generic > | gg, | ||
double | radius | ||
) |
Standard constructor.
Create UniformSphere object.
kind | specifi kind (e.g. "Star" or "FixedStar") |
gg | Gyoto::SmartPointer to the Gyoto::Metric in this part of the Universe |
radius | sphere radius |
Gyoto::Astrobj::UniformSphere::UniformSphere | ( | std::string | kind | ) |
Default constructor.
Create UniformSphere object. Use metric(), radius(), spectrum() and opacity() to set the members.
kind | specify kind (e.g. "Star" or "FixedStar") |
|
pure virtualinherited |
Cloner.
This method must be implemented by the various Astrobj::Generic subclasses in order to support cloning:
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:
Implemented in Gyoto::Astrobj::Python::ThinDisk, Gyoto::Astrobj::Python::Standard, Gyoto::Astrobj::Star, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::Complex, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::Torus, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::FixedStar, and Gyoto::Astrobj::ThinDiskIronLine.
|
virtual |
|
virtualinherited |
Get max step constraint for adaptive integration.
[in] | coord | position |
Reimplemented in Gyoto::Astrobj::Complex.
|
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.
|
virtualinherited |
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.
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 |
Reimplemented in Gyoto::Astrobj::Python::ThinDisk, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::PolishDoughnut.
|
virtualinherited |
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::Scenery, Gyoto::Spectrometer::Complex, and Gyoto::Astrobj::Complex.
|
virtualinherited |
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:
Reimplemented in Gyoto::Screen, Gyoto::Scenery, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, and Gyoto::Astrobj::DirectionalDisk.
|
protectedpure virtual |
Yield the Cartesian coordinates of the center of the sphere.
If the coordinate system of the Metric object is spherical, use a trivial conversion.
Implemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::FixedStar.
|
virtualinherited |
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 |
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::Standard.
Reimplemented in Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, and Gyoto::Astrobj::FixedStar.
|
virtualinherited |
Maximum δ inside object.
Gives the requested integration step δt (in coordinate time t) between two neighbooring points along a portion of geodesic inside an astrobj
coord | input coordinate at which δt is given |
Reimplemented in Gyoto::Astrobj::Python::Standard.
|
inherited |
Print (to stdout) some help on this class.
Describe all properties that this instance supports.
|
virtualinherited |
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).
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. |
Implements Gyoto::Astrobj::Generic.
Reimplemented in Gyoto::Astrobj::PolishDoughnut.
|
protectedvirtual |
∫ν1ν2 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 from Gyoto::Astrobj::Generic.
|
virtualinherited |
∫ν1ν2 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::ThinDisk, and Gyoto::Astrobj::Python::Standard.
|
virtual |
Square distance to the center of the sphere.
Ensure integration does not miss the object
Implements Gyoto::Astrobj::Standard.
Reimplemented in Gyoto::Astrobj::StarTrace.
|
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.
flag | 1 if optically thin, 0 if optically thick. |
|
inherited |
Query whether object is optically thin.
|
protectedvirtual |
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 from Gyoto::Astrobj::Generic.
|
inherited |
|
virtualinherited |
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().
Reimplemented in Gyoto::Astrobj::Star, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::FixedStar.
|
virtualinherited |
Get rmax_ is specified unit.
Call rMax() and convert result to unit.
unit | string |
|
virtualinherited |
|
virtualinherited |
Set maximal distance from center of coordinate system.
Call Generic::rMax(double val) after converting val from unit to geometrical units.
val | rmax_ expressed in unit "unit"; |
unit | string... |
|
virtualinherited |
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:
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 |
Reimplemented in Gyoto::Astrobj::Star, Gyoto::Metric::RotStar3_1, and Gyoto::Metric::KerrKS.
|
virtualinherited |
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:
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.
|
virtualinherited |
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>):
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::Object.
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::Complex.
|
virtualinherited |
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.
nuem | frequency in the fluid's frame |
coord | Photon coordinate |
dsem | geometrical length in geometrical units |
Reimplemented in Gyoto::Astrobj::Python::ThinDisk, Gyoto::Astrobj::Python::Standard, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::DynamicalDisk3D.
|
protected |
index Gamma is: alpha_ = 2-Gamma
such that nu*I_nu = nu^alpha_; note that Xray photon
|
protectedinherited |
The "kind" that is output in the XML entity.
E.g. for an Astrobj, fillElement() will ensure
is written.
|
protectedinherited |
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.