Gyoto
|
Optically thin or thick torus in circular rotation. More...
#include <GyotoTorus.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... | |
Torus () | |
Default constructor. More... | |
Torus (const Torus &) | |
Copy constructor. | |
virtual Torus * | clone () const |
"Virtual" copy constructor | |
virtual | ~Torus () |
Destructor: does nothing. | |
double | largeRadius () const |
double | largeRadius (std::string unit) const |
double | smallRadius () const |
double | smallRadius (std::string unit) const |
void | largeRadius (double c) |
Set large radius Torus::c_. | |
void | smallRadius (double a) |
Set small radius. | |
void | largeRadius (double c, std::string unit) |
Set large radius Torus::c_ in specified unit. | |
void | smallRadius (double a, std::string unit) |
Set small radius in specified unit. | |
virtual void | spectrum (SmartPointer< Spectrum::Generic >) |
Set Torus::spectrum_. | |
virtual SmartPointer < Spectrum::Generic > | spectrum () const |
Get Torus::spectrum_. | |
virtual void | opacity (SmartPointer< Spectrum::Generic >) |
Set Torus::opacity_. | |
virtual SmartPointer < Spectrum::Generic > | opacity () const |
Get Torus::opacity_. | |
virtual double | rMax () |
Get maximal distance from center of coordinate system. More... | |
virtual double | operator() (double const coord[4]) |
Function defining the object interior. More... | |
virtual double | deltaMax (double *) |
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 SmartPointer < Metric::Generic > | metric () const |
Get the Metric gg_. | |
virtual void | metric (SmartPointer< Metric::Generic >) |
Set the Metric gg_. | |
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 | 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 | setParameters (Gyoto::FactoryMessenger *fmp) |
Main loop for parsing Properties from XML description. 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 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... | |
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... | |
Static Public Attributes | |
static GYOTO_OBJECT Property const | properties [] |
Protected Member Functions | |
virtual void | getVelocity (double const pos[4], double vel[4]) |
Fluid velocity field. More... | |
virtual double | emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const |
Specific intensity Iν 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 double | transmission (double nuem, double dsem, double coord[8]) const |
Transmission: exp( αν * dsem ) More... | |
Protected Attributes | |
double | c_ |
Large Radius. More... | |
SmartPointer< Spectrum::Generic > | spectrum_ |
Emission law. | |
SmartPointer< Spectrum::Generic > | opacity_ |
Absorption law. | |
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 | 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::Torus > |
Optically thin or thick torus in circular rotation.
Any Metric::Generic is acceptable as long as it implements Metric::Generic::circularVelocity().
|
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::Torus::Torus | ( | ) |
Default constructor.
kind_ = "Torus", c_ = 3.5, a_=0.5
|
virtualinherited |
Get max step constraint for adaptive integration.
[in] | coord | position |
Reimplemented in Gyoto::Astrobj::Complex.
|
protectedvirtual |
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 from Gyoto::Astrobj::Generic.
|
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::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.
|
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::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.
|
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.
|
protectedvirtual |
Fluid velocity field.
Fill vel with the 4-vector velocity of the fluid at 4-position pos.
[in] | pos | 4-position at which to compute velocity; |
[out] | vel | 4-velocity at pos. |
Implements Gyoto::Astrobj::Standard.
|
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 |
|
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.
double Gyoto::Astrobj::Torus::largeRadius | ( | ) | const |
Get large radius Torus::c_ in geometrical units
double Gyoto::Astrobj::Torus::largeRadius | ( | std::string | unit | ) | const |
Get large radius Torus::c_ in specified unit
|
virtual |
Function defining the object interior.
A potential, distance, or whatever function such that operator()(double const coord[4]) < Standard::critical_value_ if and only if coord is inside the object. This function is used by the default implmenetation of Impact(). If Impact() is overloaded, it is not necessary to overload operator()(double coord[4]). The default implementation throws an error.
Implements Gyoto::Astrobj::Standard.
|
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 |
|
virtual |
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 from Gyoto::Astrobj::Generic.
|
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) |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Metric::RotStar3_1.
|
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 for parsing Properties from XML description.
This function queries the FactoryMessenger for elements to parse, and tries to matche each element to a Property to set it accordingly.
Any class that tries to be buildable from XML must supply a subcontractor (for base classes such as Metric, Astrobj, Spectrum and Spectrometer, it is done as a template that must be specialized for each class).
This subcontractor typically looks somewhat like this:
Although this is discouraged, it is possible to override the following functions to customize how XML entities are parsed: - setParameters() if low-level access to the FactoryMessenger is required; - setParameter(std::string name, std::string content, std::string unit) to interpret an entity that does not match a Property (e.g. alternative name); - setParameter(Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit) to change how a Property is interpreted.
|
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 in Gyoto::Astrobj::Star, and Gyoto::Astrobj::Complex.
double Gyoto::Astrobj::Torus::smallRadius | ( | ) | const |
Get small radius in geometrical units
double Gyoto::Astrobj::Torus::smallRadius | ( | std::string | unit | ) | const |
Get small radius in specified unit
|
protectedvirtual |
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 from Gyoto::Astrobj::Generic.
|
protected |
Large Radius.
Distance from the center of the coordinate system to the center of the torus tube. The (square of the) radius of a vertical cross-section is stored in critical_value_.
|
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.