Gyoto
|
Optically thick or thin, spherical objects. More...
#include <GyotoUniformSphere.h>
Public Member Functions | |
UniformSphere (std::string kind, SmartPointer< Metric::Generic > gg, double radius) | |
Standard constructor. | |
UniformSphere (std::string kind) | |
Default constructor. | |
UniformSphere (const UniformSphere &orig) | |
Copy constructor. | |
virtual | ~UniformSphere () |
Destructor. | |
virtual std::string | className () const |
"UniformSphere" | |
virtual std::string | className_l () const |
"uniformsphere" | |
virtual void | setSpectrum (SmartPointer< Spectrum::Generic >) |
Set spectrum_. | |
virtual SmartPointer < Spectrum::Generic > | getSpectrum () const |
Get spectrum_. | |
virtual void | setOpacity (SmartPointer< Spectrum::Generic >) |
Set opacity_. | |
virtual SmartPointer < Spectrum::Generic > | getOpacity () const |
Get opacity_. | |
double | getRadius () const |
Get radius_. | |
void | setRadius (double) |
Set radius_. | |
virtual int | setParameter (std::string name, std::string content) |
Called from setParameters() | |
virtual void | fillElement (FactoryMessenger *fmp) const |
Fill the generic XML bits. | |
virtual void | setParameters (FactoryMessenger *fmp) |
Interpret common XML sections. | |
virtual double | operator() (double const coord[4]) |
Square distance to the center of the sphere. | |
virtual void | setSafetyValue (double val) |
virtual double | getSafetyValue () const |
virtual int | Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL) |
does a photon at these coordinates impact the object? | |
virtual double | operator() (double const data[])=0 |
virtual double | giveDelta (double coord[8]) |
virtual Generic * | clone () const =0 |
"Virtual" copy constructor | |
virtual SmartPointer < Metric::Generic > | getMetric () const |
virtual void | setMetric (SmartPointer< Metric::Generic >) |
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 void | processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const |
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 | |
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. | |
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 |
^nu2 I_nu dnu (or j_nu) | |
virtual double | transmission (double nuem, double dsem, double *) const |
Transmission is determined by opacity_. | |
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 | |
double | radius_ |
sphere radius | |
SmartPointer< Spectrum::Generic > | spectrum_ |
sphere emission law | |
SmartPointer< Spectrum::Generic > | opacity_ |
if optically thin, opacity law | |
double | critical_value_ |
see operator()(double const coord[4]) const | |
double | safety_value_ |
see operator()(double const coord[4]) const | |
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::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 setMetric(), setRadius(), setSpectrum() and setOpacity() to set the members.
kind,: | specifi kind (e.g. "Star" or "FixedStar") |
|
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".
|
pure virtualinherited |
"Virtual" copy constructor
This method must be implemented by the various Astrobj::Generic subclasses in order to support cloning:
Implementing it is very straightforward, as long as the copy constructor Generic(const Generic& ) has been implemented:
Implemented in Gyoto::Astrobj::Star, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::Complex, Gyoto::Astrobj::Disk3D_BB, Gyoto::Astrobj::Torus, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::PatternDiskBB, and Gyoto::Astrobj::FixedStar.
|
virtual |
Fill the generic XML bits.
The sub-classes implementations of the Astrobj::Generic::fillElement() method should call Astrobj::UniformSphere::fillElement() to fill the common bits.
Reimplemented from Gyoto::Astrobj::Standard.
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::FixedStar.
|
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 |
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.
|
virtualinherited |
Used by Standard::Impact().
Gives the requested integration step delta_t (in coordinate time t) between two neighbooring points along a portion of geodesic inside an astrobj
coord | input coordinate at which delta_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 adress. 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.
|
protectedvirtual |
^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 from Gyoto::Astrobj::Generic.
|
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 |
Set the Metric
Reimplemented in Gyoto::Astrobj::Star, Gyoto::Astrobj::Complex, Gyoto::Astrobj::Disk3D_BB, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::FixedStar, and Gyoto::Astrobj::PageThorneDisk.
|
virtual |
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 from Gyoto::Astrobj::Standard.
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::FixedStar.
|
virtual |
Interpret common XML sections.
The sub-classes subcontractor function (see Astrobj::Subcontractor_t) should call this after creating the object to interpret the common bits (Spectrum, Opacity, Radius):
Reimplemented from Gyoto::Astrobj::Generic.
Reimplemented in Gyoto::Astrobj::Star.
|
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.
|
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.