Gyoto::Astrobj::UniformSphere Class Reference

Optically thick or thin, spherical objects. More...

#include <GyotoUniformSphere.h>

Inheritance diagram for Gyoto::Astrobj::UniformSphere:

Public Types
typedef Gyoto::SmartPointer< Gyoto::SmartPointee >	Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &)
	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_.
double	deltaInObj () const
	Get Generic::delta_inobj_. More...
void	deltaInObj (double val)
	Set Generic::delta_inobj_.
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")
	GYOTO_OBJECT_ACCESSORS_UNIT (deltaMaxInsideRMax)
void	opticallyThin (bool flag)
	Set whether the object is optically thin. More...
bool	opticallyThin () const
	Query whether object is optically thin. More...
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	processHitQuantities (Photon *ph, state_t const &coord_ph_hit, double const *coord_obj_hit, double dt, Astrobj::Properties *data) const
	Fills Astrobj::Properties. More...
virtual void	processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const =delete
virtual double	emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete
	Obsolete, update your code;.
virtual void	emission (double Inu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
	Specific intensity Iν for several values of νem More...
virtual void	emission (double Inu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete
	Obsolete, update your code.
virtual void	radiativeQ (double Inu[], double Taunu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
	emission and transmission together
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 =delete
virtual void	radiativeQ (double *Inu, double *Qnu, double *Unu, double *Vnu, double *alphaInu, double *alphaQnu, double *alphaUnu, double *alphaVnu, double *rQnu, double *rUnu, double *rVnu, double const *nuem, size_t nbnu, double dsem, state_t const &cph, double const *co) const
virtual double	integrateEmission (double nu1, double nu2, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const
	∫ν1ν2 Iν dν (or jν) More...
virtual double	integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const =delete
	Obsolete, update your code.
virtual void	integrateEmission (double *I, double const *boundaries, size_t const *chaninds, size_t nbnu, double dsem, state_t const &cph, double const *co) 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 =delete
	Obsolete, update your code.
virtual double	transmission (double nuem, double dsem, state_t const &coord_ph, double const coord_obj[8]) const
	Transmission: exp( αν * dsem ) More...
virtual double	transmission (double nuem, double dsem, state_t const &coord) const =delete
	Obsolete, update your code.
virtual double	transmission (double nuem, double dsem, double coord[8]) const =delete
	Obsolete, update your code.
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.
virtual bool	isThreadSafe () const
	Whether this class is thread-safe. More...
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, state_t const &cp, double const co[8]=NULL) const
	Emission is determined by spectrum_ and opacity_.
virtual double	integrateEmission (double nu1, double nu2, double dsem, state_t const &c_ph, double const *c_obj=NULL) const
virtual double	transmission (double nuem, double dsem, state_t const &, double const *) const
	Transmission is determined by opacity_.

Protected Attributes
double	radius_
	sphere radius [geometrical units]
bool	isotropic_
	if 1, then emission just returns 1
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])
double	delta_inobj_
	Constant value of the integration step inside object, in units of the compact object's mass M.
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...
double	deltamaxinsidermax_
	Maximum Photon integration step inside rmax_ [geometrical units]. More...
bool	flag_radtransf_
	1 if radiative transfer inside Astrobj, else 0
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...
std::vector< std::string >	plugins_
	The plug-ins that needs to be loaded to access this instance's class. More...

Friends
class	Gyoto::SmartPointer< Gyoto::Astrobj::UniformSphere >

Detailed Description

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:

<Radius> value </Radius>
<Spectrum kind="..."> parameters for this spectrum kind </Spectrum>
<Opacity kind="..."> parameters for this spectrum kind </Opacity>

The following are numerical parameters mostly usefull when the
sphere is far from the compact object. Larger values speed up
computation but may miss the sphere.
<DeltaMaxOverRadius> 0.1 </DeltaMaxOverRadius>
<DeltaMaxOverDistance> 0.1 </DeltaMaxOverDistance>

setGenericParameters() also takes care of calling setParameter().

Member Typedef Documentation

Subcontractor_t

typedef Gyoto::SmartPointer<Gyoto::SmartPointee> Gyoto::SmartPointee::Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &)

inherited

A subcontractor builds an object upon order from the Factory.

Various classes need to provide a subcontractor to be able to instantiate 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().

Constructor & Destructor Documentation

UniformSphere() [1/2]

Gyoto::Astrobj::UniformSphere::UniformSphere	(	std::string	kind,
		SmartPointer< Metric::Generic >	gg,
		double	radius
	)

Standard constructor.

Create UniformSphere object.

Parameters

kind	specifi kind (e.g. "Star" or "FixedStar")
gg	Gyoto::SmartPointer to the Gyoto::Metric in this part of the Universe
radius	sphere radius

UniformSphere() [2/2]

Gyoto::Astrobj::UniformSphere::UniformSphere

(

std::string

kind

)

Default constructor.

Create UniformSphere object. Use metric(), radius(), spectrum() and opacity() to set the members.

Parameters

kind	specify kind (e.g. "Star" or "FixedStar")

Member Function Documentation

clone()

virtual Generic* Gyoto::Astrobj::Generic::clone ( ) const

pure virtualinherited

Cloner.

This method must be implemented by the various Astrobj::Generic subclasses in order to support cloning:

SmartPointer<Astrobj> deep_copy = original->clone();

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:

MyAstrobj* MyAstrobj::clone() const { return new MyAstrobj(*this); }

Implemented in Gyoto::Astrobj::Python::ThinDisk, Gyoto::Astrobj::Python::Standard, Gyoto::Astrobj::Star, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::Jet, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::ThinDisk, Gyoto::Astrobj::Complex, Gyoto::Astrobj::XillverReflection, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::FlaredDiskSynchrotron, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::Blob, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::SphericalAccretion, Gyoto::Astrobj::Torus, Gyoto::Astrobj::PatternDiskBB, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Astrobj::InflateStar, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::ThinDiskGridIntensity, Gyoto::Astrobj::ThinDiskPL, Gyoto::Astrobj::DynamicalDiskBolometric, Gyoto::Astrobj::ThinDiskProfile, Gyoto::Astrobj::NeutronStarAnalyticEmission, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::NeutronStar, and Gyoto::Astrobj::ThinDiskIronLine.

deltaInObj()

double Gyoto::Astrobj::Standard::deltaInObj ( ) const

inherited

Get Generic::delta_inobj_.

Get the constant integration step inside the astrobj

Returns

delta_inobj_ in geometrical units

deltaMax() [1/2]

virtual double Gyoto::Astrobj::UniformSphere::deltaMax ( double *  coord )

virtual

Parameters

[in]

coord

current photon position

Returns

max( dltmor_*radius_, dltmod_*operator()(double coord[]) )

deltaMax() [2/2]

virtual double Gyoto::Astrobj::Generic::deltaMax ( double  coord[8] )

virtualinherited

Get max step constraint for adaptive integration.

Parameters

[in]

coord

position

Returns

max step to find this object reliably

Reimplemented in Gyoto::Astrobj::Complex.

describeProperty()

std::string Gyoto::Object::describeProperty ( Gyoto::Property const &  p ) const

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.

emission()

virtual void Gyoto::Astrobj::Generic::emission ( double  Inu[], double const  nu_em[], size_t  nbnu, double  dsem, state_t const &  coord_ph, double const  coord_obj[8] = NULL  ) const

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.

Parameters

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

Returns

I_ν or dI_ν [W m-2 sr-2]

Reimplemented in Gyoto::Astrobj::Python::ThinDisk, and Gyoto::Astrobj::Python::Standard.

fillElement()

virtual void Gyoto::Object::fillElement ( Gyoto::FactoryMessenger *  fmp ) const

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, Gyoto::Astrobj::Complex, and Gyoto::Metric::Complex.

fillProperty()

virtual void Gyoto::Object::fillProperty ( Gyoto::FactoryMessenger *  fmp, Property const &  p  ) const

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:

class A: public Object {};
class B: public A { 
 using B::setParameter;
 virtual void fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const ;
};
void B::fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const {
  if (name=="Duff") fmp->doSomething();
  else A::fillProperty(fmp, p);
}

Reimplemented in Gyoto::Screen, Gyoto::Scenery, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::XillverReflection, Gyoto::Metric::Shift, and Gyoto::Astrobj::NeutronStarModelAtmosphere.

getCartesian()

virtual void Gyoto::Astrobj::UniformSphere::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  )

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, Gyoto::Astrobj::Plasmoid, and Gyoto::Astrobj::FixedStar.

getDefaultQuantities()

virtual Gyoto::Quantity_t Gyoto::Astrobj::Generic::getDefaultQuantities ( )

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.

getProperties()

virtual Property const* Gyoto::Astrobj::UniformSphere::getProperties ( ) const

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, Gyoto::Astrobj::Plasmoid, Gyoto::Astrobj::Blob, Gyoto::Astrobj::InflateStar, and Gyoto::Astrobj::FixedStar.

giveDelta()

virtual double Gyoto::Astrobj::Standard::giveDelta ( double  coord[8] )

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; the current implementation only considers a constant delta, equal to Standard::deltaInobj()

Parameters

coord

input coordinate at which δt is given

Reimplemented in Gyoto::Astrobj::Python::Standard.

help()

void Gyoto::Object::help ( ) const

inherited

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

Impact()

virtual int Gyoto::Astrobj::Standard::Impact ( Gyoto::Photon *  ph, size_t  index, Astrobj::Properties *  data = NULL  )

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).

Impact() may not extend the ph Worldline. The only two dates that are guaranteed to be defined are at indices index and index+1.

Parameters

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.

Returns

1 if impact, 0 if not.

Implements Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Plasmoid, and Gyoto::Astrobj::InflateStar.

integrateEmission() [1/2]

virtual double Gyoto::Astrobj::Generic::integrateEmission ( double  nu1, double  nu2, double  dsem, state_t const &  c_ph, double const  c_obj[8] = NULL  ) const

virtualinherited

∫_ν1^ν₂ I_ν dν (or j_ν)

Compute the integral of emission() from ν₁ to ν₂. 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, and Gyoto::Astrobj::Torus.

integrateEmission() [2/2]

virtual void Gyoto::Astrobj::Generic::integrateEmission ( double *  I, double const *  boundaries, size_t const *  chaninds, size_t  nbnu, double  dsem, state_t const &  cph, double const *  co  ) const

virtualinherited

∫_ν1^ν₂ 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, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::PolishDoughnut.

isThreadSafe()

virtual bool Gyoto::Object::isThreadSafe ( ) const

virtualinherited

Whether this class is thread-safe.

Return True if this object is thread-safe, i.e. if an instance and its clone can be used in parallel threads (in the context of Scenery::raytrace()). Known objects which are not thread-safe include Lorene metrics and everything from the Python plug-in.

The default implementation considers that the class itself is thread safe and recurses into the declared properties to check whether they are safe too. Classes that abide to the Object/Property paradigm and are themselves thread-safe have nothing special to do.

Objects that clone children in their copy constructor that are not declared as properties must take these children into account.

Classes that are never thread-safe must declare it. It acn be easily done using GYOTO_OBJECT_THREAD_SAFETY in the class declaration and GYOTO_PROPERTY_THREAD_UNSAFE in the class definition.

operator()()

virtual double Gyoto::Astrobj::UniformSphere::operator() ( double const  coord[4] )

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.

opticallyThin() [1/2]

void Gyoto::Astrobj::Generic::opticallyThin ( bool  flag )

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.

Parameters

flag	1 if optically thin, 0 if optically thick.

opticallyThin() [2/2]

bool Gyoto::Astrobj::Generic::opticallyThin ( ) const

inherited

Query whether object is optically thin.

See opticallyThin(bool flag).

processHitQuantities()

virtual void Gyoto::Astrobj::Generic::processHitQuantities ( Photon *  ph, state_t const &  coord_ph_hit, double const *  coord_obj_hit, double  dt, Astrobj::Properties *  data  ) const

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::PageThorneDisk, Gyoto::Astrobj::ThinDiskProfile, and Gyoto::Astrobj::DynamicalDiskBolometric.

property()

Property const* Gyoto::Object::property ( std::string const  pname ) const

inherited

Find property by name.

Look into the Property list for a Property whose name (or name_false, for a boolean Property) is pname. Return a const pointer to the first such property found, or NULL if none is found.

rMax() [1/4]

virtual double Gyoto::Astrobj::Generic::rMax ( )

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().

Returns

rmax_ in geometrical units

Reimplemented in Gyoto::Astrobj::Star, Gyoto::Astrobj::Torus, Gyoto::Astrobj::Complex, and Gyoto::Astrobj::FixedStar.

rMax() [2/4]

virtual double Gyoto::Astrobj::Generic::rMax ( std::string const &  unit )

virtualinherited

Get rmax_ is specified unit.

Call rMax() and convert result to unit.

Parameters

unit

string

Returns

double rmax converted to unit

rMax() [3/4]

virtual void Gyoto::Astrobj::Generic::rMax ( double  val )

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.

Parameters

val	new rmax_ in geometrical units.

rMax() [4/4]

virtual void Gyoto::Astrobj::Generic::rMax ( double  val, std::string const &  unit  )

virtualinherited

Set maximal distance from center of coordinate system.

Call Generic::rMax(double val) after converting val from unit to geometrical units.

Parameters

val	rmax_ expressed in unit "unit";
unit	string...

setParameter() [1/2]

virtual int Gyoto::Object::setParameter ( std::string  name, std::string  content, std::string  unit  )

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:

class A: public Object {};
class B: public A { 
 using B::setParameter;
 virtual int setParameter(std::string name,
                    std::string content,
                    std::string unit);
};
int B::setParameter(std::string name,
                    std::string content,
                    std::string unit) {
  if (name=="Duff") doSomething(content, unit);
  else return A::setParameter(name, content, unit);
  return 0;  // name was known
}

Parameters

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

Returns

0 if this parameter is known, 1 if it is not.

Reimplemented in Gyoto::Astrobj::Star, Gyoto::Metric::RotStar3_1, Gyoto::Metric::KerrKS, and Gyoto::Astrobj::EquatorialHotSpot.

setParameter() [2/2]

virtual void Gyoto::Object::setParameter ( Gyoto::Property const &  p, std::string const &  name, std::string const &  content, std::string const &  unit  )

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:

class A: public Object {};
class B: public A { 
 using B::setParameter;
 virtual void setParameter(Gyoto::Property const &p,
                           std::string name,
                        std::string content,
                        std::string unit);
};
void B::setParameter(Gyoto::Property const &p,
                          std::string name,
                  std::string content,
                  std::string unit) {
  if (name=="Duff") doSomething(content, unit);
  else A::setParameter(p, name, content, unit);
}

Parameters

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.

setParameters()

virtual void Gyoto::Astrobj::Generic::setParameters ( FactoryMessenger *  fmp )

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>):

SmartPointer<Astrobj::Generic>
Gyoto::Astrobj::MyKind::Subcontractor(FactoryMessenger* fmp) {
  SmartPointer<MyKind> ao = new MyKind();
  ao -> setParameters(fmp);
  return ao;
}

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, Gyoto::Astrobj::Complex, Gyoto::Astrobj::OscilTorus, and Gyoto::Astrobj::EquatorialHotSpot.

transmission()

virtual double Gyoto::Astrobj::Generic::transmission ( double  nuem, double  dsem, state_t const &  coord_ph, double const  coord_obj[8]  ) const

virtualinherited

Transmission: exp( α_ν * ds_em )

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.

Parameters

nuem	frequency in the fluid's frame
coord	Photon coordinate
dsem	geometrical length in geometrical units

Reimplemented in Gyoto::Astrobj::PatternDisk, and Gyoto::Astrobj::DynamicalDisk3D.

Member Data Documentation

deltamaxinsidermax_

double Gyoto::Astrobj::Generic::deltamaxinsidermax_

protectedinherited

Maximum Photon integration step inside rmax_ [geometrical units].

Maximum step for Photon integation when inside the sphere of radius rmax_.

deltamaxinsidermax_ is in geometrical units.

kind_

std::string Gyoto::Object::kind_

protectedinherited

The "kind" that is output in the XML entity.

E.g. for an Astrobj, fillElement() will ensure

<Astrobj kind="kind_" ...>...</Astrobj>

is written.

plugins_

std::vector<std::string> Gyoto::Object::plugins_

protectedinherited

The plug-ins that needs to be loaded to access this instance's class.

E.g. for an Astrobj, fillElement() will ensure

<Astrobj ... plugin="plugins_">...</Astrobj>

is written.

rmax_

double Gyoto::Astrobj::Generic::rmax_

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.

---

The documentation for this class was generated from the following file:

• GyotoUniformSphere.h