Gyoto
|
Complex astronomical object. More...
#include <GyotoComplexAstrobj.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 | |
Complex () | |
Default constructor. | |
Complex (const Complex &) | |
Copy constructor. | |
virtual Complex * | clone () const |
"Virtual" copy constructor | |
virtual double | deltaMax (double coord[8]) |
Get max step constraint for adaptive integration. More... | |
virtual | ~Complex () |
Destructor. More... | |
void | append (Gyoto::SmartPointer< Gyoto::Astrobj::Generic > element) |
Add element at the end of the array. More... | |
void | remove (size_t i) |
Remove i-th element from the array. | |
size_t | getCardinal () const |
Get the number of elements in the array. | |
void | metric (SmartPointer< Metric::Generic > gg) |
Set metric in each element. | |
virtual void | fillElement (FactoryMessenger *fmp) const |
Fill the XML element for this Object. More... | |
virtual void | setParameters (FactoryMessenger *fmp) |
Main loop in Subcontractor_t function. More... | |
virtual int | Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL) |
Call Impact() for each of the elements. More... | |
Gyoto::SmartPointer< Gyoto::Astrobj::Generic > & | operator[] (size_t i) |
Retrieve i-th element. More... | |
Gyoto::SmartPointer< Gyoto::Astrobj::Generic > const & | operator[] (size_t i) const |
Retrieve a const version of the i-th element. | |
virtual Property const * | getProperties () const |
Get list of properties. More... | |
virtual SmartPointer< Metric::Generic > | metric () const |
Get 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... | |
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 | processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const |
Fills Astrobj::Properties. More... | |
virtual double | emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const |
Specific intensity Iν 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 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 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 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 Attributes | |
size_t | cardinal_ |
Number of objects. | |
Gyoto::SmartPointer< Gyoto::Astrobj::Generic > * | elements_ |
Array of Astrobj::Generic. | |
double | step_max_ |
Maximum δ step inside the Astrobj. More... | |
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::Complex > |
Complex astronomical object.
A Gyoto::Astrobj::Generic whic contain several Gyoto::Astrobj::Generic instances. It is essentially a SmartPointer<Astrobj::Generic> array, which some methods around. Indeed, the operator[](size_t i) method is implemented to retrieve the i-th element.
In an XML description, the <Astrobj> section must be unique, its kind is "Complex". Each sub-astrobj then appears as a <SubAstrobj> subsection:
|
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().
|
virtual |
Destructor.
Frees every SmartPointer<Astrobj::Generic> before freed the array itself.
void Gyoto::Astrobj::Complex::append | ( | Gyoto::SmartPointer< Gyoto::Astrobj::Generic > | element | ) |
Add element at the end of the array.
If the Astrobj::Complex itself does not have a metric already assigned, it takes it from the new element. Else, it sets the metric in the new element to its own. This ensures that all elements use the same metric (this heuristic is not entirely fool-proof, it's safer to set the metric directly in the Astrobj::Complex).
|
virtual |
Get max step constraint for adaptive integration.
[in] | coord | position |
Reimplemented from Gyoto::Astrobj::Generic.
|
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ν
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 :
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.
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::Python::ThinDisk, Gyoto::Astrobj::Python::Standard, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::Torus, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::ThinDiskPL, and Gyoto::Astrobj::ThinDiskIronLine.
|
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.
|
virtual |
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 from Gyoto::Object.
|
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.
|
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.
|
virtualinherited |
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::Object.
Reimplemented in Gyoto::Astrobj::Python::ThinDisk, Gyoto::Astrobj::Python::Standard, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Star, Gyoto::Astrobj::Standard, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::Torus, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::FixedStar, and Gyoto::Astrobj::ThinDiskIronLine.
|
inherited |
Print (to stdout) some help on this class.
Describe all properties that this instance supports.
|
virtual |
Call Impact() for each of the elements.
Astrobj::Complex::Impact(Gyoto::Photon* ph, size_t index, Astrobj::Properties *data) calls the specific implementation of Astrobj::Generic::Impact() for each of its elements twice: the first time, data is set to NULL so that Astrobj::Complex::Impact() only knows whether each object is hit by the Photon. If no object is hit, return. If a single object is hit, call Impact() again only for this object, passing data this time. If several objects are hit, the Photon's trajectory is refined so that the step is at most step_max_ and the Impact() methods for each of the hit objects are called again for each step, passing data. It is therefore important that the transmission of the Photon is not touched by Impact() when data==NULL.
Implements Gyoto::Astrobj::Generic.
|
virtualinherited |
∫ν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 in Gyoto::Astrobj::Python::ThinDisk, Gyoto::Astrobj::Python::Standard, Gyoto::Astrobj::UniformSphere, and Gyoto::Astrobj::Torus.
|
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.
Gyoto::SmartPointer<Gyoto::Astrobj::Generic>& Gyoto::Astrobj::Complex::operator[] | ( | size_t | i | ) |
Retrieve i-th element.
This should work as expected:
|
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.
|
virtualinherited |
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::UniformSphere, and Gyoto::Astrobj::PageThorneDisk.
|
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.
|
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>):
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.
|
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.
|
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.
|
protected |
Maximum δ step inside the Astrobj.
Currently not settable, always equal to GYOTO_DEFAULT_DELTA