Gyoto
|
Complex astronomical object. More...
#include <GyotoComplexAstrobj.h>
Public Member Functions | |
Complex () | |
Default constructor. | |
Complex (const Complex &) | |
Copy constructor. | |
virtual Complex * | clone () const |
"Virtual" copy constructor | |
virtual | ~Complex () |
Destructor. | |
void | append (Gyoto::SmartPointer< Gyoto::Astrobj::Generic > element) |
Add element at the end of the array. | |
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 | setMetric (SmartPointer< Metric::Generic > gg) |
Set metric in each element. | |
virtual void | fillElement (FactoryMessenger *fmp) const |
called from Factory | |
virtual void | setParameters (FactoryMessenger *fmp) |
Main loop in Subcontractor_t function. | |
virtual int | Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL) |
Call Impact() for each of the elements. | |
Gyoto::SmartPointer < Gyoto::Astrobj::Generic > | operator[] (size_t i) |
Retrieve i-th element. | |
Gyoto::SmartPointer < Gyoto::Astrobj::Generic > const | operator[] (size_t i) const |
Retrieve a const version of the i-th element. | |
virtual SmartPointer < Metric::Generic > | getMetric () const |
virtual double | getRmax () |
Get maximal distance from center of coordinate system. | |
const std::string | getKind () const |
Get the kind of the Astrobj (e.g. "Star") | |
virtual void | setRmax (double val) |
Set maximal distance from center of coordinate system. | |
virtual void | unsetRmax () |
Set rmax_set_ to 0. | |
void | setFlag_radtransf (int flag) |
Set whether the object is optically thin. | |
int | getFlag_radtransf () const |
Query whether object is optically thin. | |
virtual Quantity_t | getDefaultQuantities () |
virtual int | setParameter (std::string name, std::string content) |
Called from setParameters() | |
virtual void | processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const |
virtual double | emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const |
INVARIANT emission j_{}/^{2}. | |
virtual double | integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const |
^nu2 I_nu dnu (or j_nu) | |
virtual double | transmission (double nuem, double dsem, double coord[8]) const |
Transmission: exp( {} * dsem ) | |
void | checkPhiTheta (double coord[8]) const |
Protected Types | |
typedef Gyoto::SmartPointer < Gyoto::SmartPointee > | Subcontractor_t (Gyoto::FactoryMessenger *) |
A subcontractor builds an object upon order from the Factory. |
Protected Member Functions | |
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. |
Protected Attributes | |
size_t | cardinal_ |
Gyoto::SmartPointer < Gyoto::Astrobj::Generic > * | elements_ |
double | step_max_ |
SmartPointer < Gyoto::Metric::Generic > | gg_ |
double | rmax_ |
Maximum distance to the center of the coordinate system. | |
int | rmax_set_ |
Never recompute rmax: it was externally set. | |
const std::string | kind_ |
Kind of object (e.g. "Star"...) | |
int | flag_radtransf_ |
1 if radiative transfer inside Astrobj, else 0 |
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 arround. Indeed, the operator[](size_t i) method is implemented to retrived 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).
|
inherited |
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".
|
virtualinherited |
INVARIANT emission j_{}/^{2}.
Called by the default implementation for processHitQuantities().
emission() computes the intensity I_nu emitted by the small volume of length dsem. It should take self-absorption along dsem into account.
Reminder :
The equation used for radiative transfer (without absorption) is: d(I_nu/nu^3)/dlambda = (j_nu/nu^2) [*] where lambda is the integration parameter along the null geodesic.
NB: Let us consider a particular observer, with nu 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 lambda to lambda+dlambda along its geodesic. Then it can be shown that : dlambda = ds/nu 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 |
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::PatternDisk, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::Torus, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::Disk3D_BB, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::PatternDiskBB, and Gyoto::Astrobj::ThinDiskPL.
|
virtual |
called from Factory
Astrobj implementations should impement fillElement to save their parameters to XML and call the generic implementation to save generic parts such as Flag_radtrans: Generic::fillElement(fmp).
Reimplemented from Gyoto::Astrobj::Generic.
|
virtualinherited |
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.
|
inherited |
Query whether object is optically thin.
|
virtualinherited |
Get the Metric
Reimplemented in Gyoto::Astrobj::Star.
|
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.
It can also be set using setRmax(). If setRmax has been used to set rmax_, getRmax() must not recompute it.
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::Torus.
|
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 |
^nu2 I_nu dnu (or j_nu)
Compute the integral of emission() from nu1 to nu2. 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::UniformSphere, and Gyoto::Astrobj::Torus.
Gyoto::SmartPointer<Gyoto::Astrobj::Generic> Gyoto::Astrobj::Complex::operator[] | ( | size_t | i | ) |
Retrieve i-th element.
This should work as expected:
|
virtualinherited |
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::transmi(), only if data==NULL.
You can overload it for your Astrobj. The generic implementation calls emission(), integrateEmission() and transmission() below.
|
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. |
|
virtualinherited |
Called from setParameters()
Assume MyKind is a sublcass of Astrobj::Generic which has towo members (a string StringMember and a double DoubleMember):
If MyKind is not a direct subclass of Generic but is a subclass of e.g. Standard, UniformSphere of ThinDisk, it should call the corresponding setParameter() implementation instead of Generic::setParameter().
name | XML name of the parameter |
content | string representation of the value |
Reimplemented in Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::Standard, Gyoto::Astrobj::Star, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::Torus, Gyoto::Astrobj::Disk3D_BB, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::ThinDiskPL, and Gyoto::Astrobj::PatternDiskBB.
|
virtual |
Main loop in Subcontractor_t function.
The Subcontractor_t function for each Astrobj kind should look somewhat like this:
Each object kind should implement setParameter(string name, string content) 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 |
Set maximal distance from center of coordinate system.
Set maximal distance from center of coordinate system at which a Photon may hit the object.
Side effect: set rmax_set_ to 1.
|
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::PatternDisk, and Gyoto::Astrobj::Torus.
|
virtualinherited |
Set rmax_set_ to 0.
getRmax() will then be free to recompute rmax_. Astrobjs which cache rmax_ may need to update it when unsetRmax() is called.
Reimplemented in Gyoto::Astrobj::Star.
|
protected |
Number of objects
|
protectedinherited |
The Metric in this end of the Universe
|
protectedinherited |
Kind of object (e.g. "Star"...)
The kind should match the name of the class, e.g. "Star" for a Gyoto::Star.
|
protectedinherited |
Maximum distance to the center of the coordinate system.
Maximum distance from the center of the coordinate system at which a photon may hit the object. Child classes may choose to update rmax at all time or to use it to cache the value, for instance when getRmax() is called. External classes (Photons in particular) must use getRmax() to access this information.
rmax_set_==1 means that rmax_ was set using setRmax() or the constructor. In this case, getRmax() must always return this value, not recompute it.
|
protectedinherited |
Never recompute rmax: it was externally set.
rmax_set_==1 means that rmax_ was set using setRmax() or the constructor. In this case, getRmax() must always return this value, not recompute it.
Use unsetRmax() to reset rmax_set_ to 0.