Mass-less, spherical object following a timelike geodesic. More...

#include <GyotoStar.h>

Inheritance diagram for Gyoto::Astrobj::Star:

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

	Star (SmartPointer< Metric::Generic > gg, double radius, double const pos[4], double const v[3])
	Create Star object and set initial condition. More...

	Star ()
	Default constructor. More...

	Star (const Star &orig)
	Copy constructor.

virtual Star *	clone () const
	Cloner. More...

virtual	~Star ()
	Destructor.

virtual std::string	className () const
	"Star" More...

virtual std::string	className_l () const
	"star" More...

virtual void	metric (SmartPointer< Metric::Generic >)
	Set the Metric gg_. More...

virtual SmartPointer< Metric::Generic >	metric () const
	Get the Metric gg_. More...

virtual double	getMass () const
	Return 1. More...

virtual double	rMax ()
	Get maximal distance from center of coordinate system. More...

virtual void	setInitialCondition (double const coord[8])
	Same as Worldline::setInitialCondition(gg, coord, sys,1) More...

virtual int	setParameter (std::string name, std::string content, std::string unit)
	Set parameter by name. More...

virtual void	setParameters (FactoryMessenger *fmp)
	Main loop in Subcontractor_t function. More...

virtual void	fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const
	Output a single Property to XML. More...

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)
	Get the 6 Cartesian coordinates for specific dates. More...

virtual void	getVelocity (double const pos[4], double vel[4])
	Yield velocity of the center of the sphere. More...

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

double	radius (std::string const &) const
	Get radius_ in specified unit.

virtual void	radius (double, std::string const &)
	Set radius_ in specified unit. More...

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	operator() (double const data[])=0
	The actual function. More...

virtual double	deltaMax (double *coord)

virtual double	deltaMax (double coord[8])
	Get max step constraint for adaptive integration. More...

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 double	integrateEmission (double nu1, double nu2, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const
	∫_ν₁^ν₂ 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
	∫_ν₁^ν₂ 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( α_ν * ds_em ) 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.

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	giveDelta (double coord[8])
	Maximum δ inside object. 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")

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

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

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	fillElement (Gyoto::FactoryMessenger *fmp) const
	Fill the XML element for this Object. 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...

size_t	getImin () const
	Get imin_.

size_t	getImax () const
	Get imax_.

size_t	getI0 () const
	Get i0_.

void	initCoord (std::vector< double > const &)

std::vector< double >	initCoord () const

virtual void	setInitCoord (const double coord[8], int dir, double const Ephi[4], double const Etheta[4])
	Set Initial coordinate. More...

virtual void	setInitCoord (const double coord[8], int dir=0)
	Set Initial coordinate. More...

virtual void	setInitCoord (double const pos[4], double const vel[3], int dir=0)
	Set initial coordinate. More...

virtual void	setPosition (double const pos[4])
	Set initial 4-position.

virtual void	setVelocity (double const vel[3])
	Set initial 3-velocity.

void	reset ()
	Forget integration, keeping initial contition.

void	reInit ()
	Reset and recompute particle properties.

void	integrator (std::string const &type)
	Set the integrator. More...

std::string	integrator () const
	Describe the integrator used by state_.

double	deltaMin () const
	Get delta_min_.

void	deltaMin (double h1)
	Set delta_min_.

double	deltaMax () const
	Get delta_max_.

virtual double	deltaMax (double const pos[8], double delta_max_external) const

void	deltaMax (double h1)

void	absTol (double)
	Set abstol_.

double	absTol () const
	Get abstol_.

void	relTol (double)
	Set reltol_.

double	relTol () const
	Get reltol_.

double	deltaMaxOverR () const
	Get delta_max_over_r_.

void	deltaMaxOverR (double t)
	Set delta_max_over_r_.

void	delta (const double delta)
	Expand memory slots for polarization vectors. More...

void	delta (double, const std::string &unit)
	Set delta_ in specified units.

double	delta () const
	Get delta_.

double	delta (const std::string &unit) const
	Get delta_ in specified units.

double	tMin () const
	Get tmin_.

double	tMin (const std::string &unit) const
	Get tmin_ in specified unit.

void	tMin (double tlim)
	Set tmin_.

void	tMin (double, const std::string &unit)
	Set tmin_ in specified unit.

void	adaptive (bool mode)
	Set adaptive_.

bool	adaptive () const
	Get adaptive_.

void	secondary (bool sec)
	Set secondary_.

bool	secondary () const
	Get secondary_.

void	parallelTransport (bool pt)
	Set parallel_transport_.

bool	parallelTransport () const
	Get parallel_transport_.

void	maxiter (size_t miter)
	Set maxiter_.

size_t	maxiter () const
	Get maxiter_.

double const *	getCst () const
	Returns the worldline's cst of motion (if any) More...

void	setCst (double const *cst, size_t const ncsts)
	Set Metric-specific constants of motion. More...

void	setInitialCondition (SmartPointer< Metric::Generic > gg, const double coord[8], const int dir, double const Ephi[4], double const Etheta[4])
	Set or re-set the initial condition prior to integration. More...

void	setInitialCondition (SmartPointer< Metric::Generic > gg, const double coord[8], const int dir)
	Set or re-set the initial condition prior to integration. More...

void	getInitialCoord (std::vector< double > &dest) const
	Get initial coordinates + base vectors. More...

void	getCoord (size_t index, Gyoto::state_t &dest) const
	Get coordinates+base vectors corresponding to index. More...

void	getCoord (size_t index, Gyoto::state_t &dest)
	Get coordinates+base vectors corresponding to index. More...

void	getCoord (double date, Gyoto::state_t &dest, bool proper=false)
	Get coordinates+base vectors corresponding to date dest[0]. More...

void	getCoord (double const const dates, size_t const n_dates, double const x1dest, double const x2dest, double const x3dest, double const x0dot=NULL, double const x1dot=NULL, double const x2dot=NULL, double const x3dot=NULL, double ep0=NULL, double ep1=NULL, double ep2=NULL, double ep3=NULL, double et0=NULL, double et1=NULL, double et2=NULL, double et3=NULL, double *otime=NULL, bool proper=false)
	Get 8-coordinates for specific dates. More...

void	getCoord (double x0, double x1, double x2, double x3) const
	Get all computed positions. More...

void	getCartesianPos (size_t index, double dest[4]) const
	Get Cartesian expression of 4-position at index.

virtual void	xStore (size_t ind, state_t const &coord, double tau)
	Store coord at index ind. More...

virtual void	xStore (size_t ind, state_t const &coord)=delete
	Obsolete, update your code.

virtual void	xStore (size_t ind, double const coord[8])=delete
	Obsolete, update your code.

virtual void	xFill (double tlim, bool proper=false)
	Fill x0, x1... by integrating the Worldline from previously set inittial condition to time tlim.

size_t	get_nelements () const
	Get number of computed dates.

void	get_t (double *dest) const
	Get computed dates.

void	get_tau (double *dest) const
	Get computed proper times or values of the affine parameter.

void	get_xyz (double x, double y, double *z) const
	Get 3-position in cartesian coordinates for computed dates.

void	checkPhiTheta (double coord[8]) const
	Bring θ in [0,Π] and φ in [0,2Π]. More...

void	getSkyPos (SmartPointer< Screen > screen, double dalpha, double ddellta, double *dD) const
	Get computed positions in sky coordinates.

void	get_dot (double x0dot, double x1dot, double x2dot, double x3dot) const
	Get computed 4-velocities.

void	get_prime (double x1prime, double x2prime, double *x3prime) const
	Get computed 3-velocities.

void	save_txyz (char *fichierxyz) const
	Save in a file.

void	save_txyz (char *const filename, double const t1, double const mass_sun, double const distance_kpc, std::string const unit, SmartPointer< Screen > sc=NULL)
	Save, converted.

Public Attributes
	GYOTO_WORLDLINE

int	stopcond
	Whether and why integration is finished.

Static Public Attributes
static GYOTO_OBJECT Property const	properties []

Protected Member Functions
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_. More...

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

virtual void	xAllocate ()
	Allocate x0, x1 etc. with default size. More...

virtual void	xAllocate (size_t size)
	Allocate x0, x1 etc. with a specified size. More...

virtual size_t	xExpand (int dir)
	Expand x0, x1 etc... to hold more elements. More...

virtual void	xExpand (double *&x, int dir)
	Expand one array to hold more elements. More...

virtual void	eAllocate ()
	Allocate ep0_ ... et3_. More...

virtual void	eDeallocate ()
	Deallocate ep0_ ... et3_. More...

virtual void	eExpand (int dir)

virtual void	tell (Gyoto::Hook::Teller *)
	This is how a Teller tells. More...

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

SmartPointer< Gyoto::Metric::Generic >	metric_
	The Gyoto::Metric in this part of the universe.

double *	tau_
	proper time or affine parameter

double *	x0_
	t or T

double *	x1_
	r or x

double *	x2_
	θ or y

double *	x3_
	φ or z

double *	x0dot_
	tdot or Tdot

double *	x1dot_
	rdot or xdot

double *	x2dot_
	θdot or ydot

double *	x3dot_
	φdot or zdot

double *	ep0_

double *	ep1_
	Coordinate of first base vector to parallel transport.

double *	ep2_
	Coordinate of first base vector to parallel transport.

double *	ep3_
	Coordinate of first base vector to parallel transport.

double *	et0_
	Coordinate of first base vector to parallel transport.

double *	et1_
	Coordinate of Second base vector to parallel transport.

double *	et2_
	Coordinate of Second base vector to parallel transport.

double *	et3_
	Coordinate of Second base vector to parallel transport.

size_t	x_size_
	Coordinate of Second base vector to parallel transport. More...

size_t	imin_
	Minimum index for which x0_, x1_... have been computed.

size_t	i0_
	Index of initial condition in array.

size_t	imax_
	Maximum index for which x0_, x1_... have been computed.

bool	adaptive_
	Whether integration should use adaptive delta.

bool	secondary_
	Experimental: choose 0 to compute only primary image. More...

bool	parallel_transport_
	Whether to parallel transport a local triad. More...

double	delta_
	Initial integrating step. More...

double	tmin_
	Time limit for the integration (geometrical units) More...

double *	cst_
	Worldline's csts of motion (if any)

size_t	cst_n_
	Number of constants of motion.

int	wait_pos_
	Hack in setParameters()

double *	init_vel_
	Hack in setParameters()

size_t	maxiter_
	Maximum number of iterations when integrating.

double	delta_min_
	Minimum integration step for the adaptive integrator. More...

double	delta_max_
	Maximum integration step for the adaptive integrator. More...

double	delta_max_over_r_
	Numerical tuning parameter. More...

double	abstol_
	Absolute tolerance of the integrator. More...

double	reltol_
	Absolute tolerance of the integrator. More...

SmartPointer< Worldline::IntegState::Generic >	state_
	An object to hold the integration state.

Private Attributes
int	__defaultfeatures
	Whether some virtual methods are implemented. More...

int	refCount
	Reference counter.

pthread_mutex_t	mutex_
	A mutex. More...

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

Detailed Description

Mass-less, spherical object following a timelike geodesic.

Gyoto can compute the Star's orbit in a Gyoto::Metric and perform ray-tracing on this target. The XML description of a Star looks like:

<Astrobj kind = "Star">
  <Metric kind = "KerrBL">
    <Spin> 0. </Spin>
  </Metric>
  <Radius> 2. </Radius>
  <Velocity> 0. 0. 0.037037 </Velocity>
  <Position> 600. 9. 1.5707999999999999741 0 </Position>
  <Spectrum kind="BlackBody">
    <Temperature> 6000 </Temperature>
  </Spectrum>
  <Opacity kind="PowerLaw">
    <Exponent> 0 </Exponent>
    <Constant> 0.1 </Constant>
  </Opacity>
  <OpticallyThin/>
</Astrobj>

Star supports exactly the union of the parameters supported by Gyoto::Astrobj::UniformSphere and Gyoto::Worldline.

The Metric element can be of any kind. This Metric sets the coordinate system.

The Star is a coordinate sphere of radius Radius in solid motion.

Position sets the initial 4-coordinate of the centre of the sphere. Velocity contains its initial 3-velocity (the time derivatives of the 3 space coordinates).

Like many Astrobj::Generic impementations, a Star can be OpticallyThin or OpticallyThick.

Spectrum and Opacity (if OpticallyThin) are the descriptions of two Gyoto::Spectrum::Generic sub-classes.

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

◆ Star() [1/2]

Gyoto::Astrobj::Star::Star	(	SmartPointer< Metric::Generic >	gg,
		double	radius,
		double const	pos[4],
		double const	v[3]
	)

Create Star object and set initial condition.

Parameters

gg	Gyoto::SmartPointer to the Gyoto::Metric in this part of the Universe
radius	star radius
pos	initial 4-position
v	initial 3-velocity

◆ Star() [2/2]

Gyoto::Astrobj::Star::Star ( )

Default constructor.

Create Star object with undefined initial conditions. One needs to set the coordinate system, the metric, and the initial position and velocity before integrating the orbit. setInititialCondition() can be used for that.

Member Function Documentation

◆ checkPhiTheta()

void Gyoto::Worldline::checkPhiTheta ( double coord[8] ) const

inherited

Bring θ in [0,Π] and φ in [0,2Π].

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

◆ className()

virtual std::string Gyoto::Astrobj::Star::className ( ) const

virtual

"Star"

Reimplemented from Gyoto::Astrobj::UniformSphere.

Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::InflateStar, and Gyoto::Astrobj::StarTrace.

◆ className_l()

virtual std::string Gyoto::Astrobj::Star::className_l ( ) const

virtual

"star"

Reimplemented from Gyoto::Astrobj::UniformSphere.

Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::InflateStar, and Gyoto::Astrobj::StarTrace.

◆ clone()

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

virtual

Cloner.

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

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

Gyoto::SmartPointer

Pointers performing reference counting.

Definition: GyotoSmartPointer.h:135

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); }

Implements Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::InflateStar, and Gyoto::Astrobj::StarTrace.

◆ delta()

void Gyoto::Worldline::delta ( const double delta )

inherited

Expand memory slots for polarization vectors.

Assignment to another Worldline Set delta_

◆ 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/4]

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

virtualinherited

Parameters

[in] coord current photon position

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

◆ deltaMax() [2/4]

virtual double Gyoto::Worldline::deltaMax	(	double const	pos[8],
		double	delta_max_external
	)		const

virtualinherited

Get delta max at a given position

Parameters

[in]	pos	4-position
[in]	delta_max_external	external constraint on delta_max

Returns: the smallest value between delta_max_, delta_max_external, and R*delta_max_over_r_ where R is pos[1] in spherical coordinates and max(x1, x2, x3) in Cartesian coordinates.

◆ deltaMax() [3/4]

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.

◆ deltaMax() [4/4]

void Gyoto::Worldline::deltaMax ( double h1 )

inherited

Set delta_max_

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

◆ eAllocate()

virtual void Gyoto::Worldline::eAllocate ( )

protectedvirtualinherited

Allocate ep0_ ... et3_.

Allocate memory for polarization vectors

◆ eDeallocate()

virtual void Gyoto::Worldline::eDeallocate ( )

protectedvirtualinherited

Deallocate ep0_ ... et3_.

Deallocate memory for polarization vectors

◆ eExpand()

virtual void Gyoto::Worldline::eExpand ( int dir )

protectedvirtualinherited

Call xExpand(double * &x, int dir) on #ep0_, ep1_ etc.

◆ emission() [1/2]

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::Standard, and Gyoto::Astrobj::Python::ThinDisk.

◆ emission() [2/2]

virtual double Gyoto::Astrobj::UniformSphere::emission	(	double	nu_em,
		double	dsem,
		state_t const &	cp,
		double const	co[8] = `NULL`
	)		const

protectedvirtualinherited

Emission is determined by spectrum_ and opacity_.

Reimplemented from Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::InflateStar.

◆ 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::Astrobj::Complex, Gyoto::Spectrometer::Complex, and Gyoto::Scenery.

◆ fillProperty()

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

virtual

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 from Gyoto::Object.

◆ getCartesian()

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

virtual

Get the 6 Cartesian coordinates for specific dates.

This method is present in both the API of UniformSphere and Worldline. It is pure virtual in UniformSphere. The Star reimplementation is a trivial wrapper around Worldline::getCartesian().

Implements Gyoto::Astrobj::UniformSphere.

◆ getCoord() [1/5]

void Gyoto::Worldline::getCoord	(	double *	x0,
		double *	x1,
		double *	x2,
		double *	x3
	)		const

inherited

Get all computed positions.

Get all the pre-computed 8 coordinates (e.g. thanks to a prior call to xFill()) of this worldline.

◆ getCoord() [2/5]

void Gyoto::Worldline::getCoord	(	double const *const	dates,
		size_t const	n_dates,
		double *const	x1dest,
		double *const	x2dest,
		double *const	x3dest,
		double *const	x0dot = `NULL`,
		double *const	x1dot = `NULL`,
		double *const	x2dot = `NULL`,
		double *const	x3dot = `NULL`,
		double *	ep0 = `NULL`,
		double *	ep1 = `NULL`,
		double *	ep2 = `NULL`,
		double *	ep3 = `NULL`,
		double *	et0 = `NULL`,
		double *	et1 = `NULL`,
		double *	et2 = `NULL`,
		double *	et3 = `NULL`,
		double *	otime = `NULL`,
		bool	proper = `false`
	)

inherited

Get 8-coordinates for specific dates.

The coordinates will be computed using the integrator, so they will be as accurate as possible. Some heuristics are used to speed up the process and it is presumably faster to call this routine with a sorted list of dates. The line will be integrated further as required. An error will be thrown if it is not possible to reach a certain date.

Parameters

[in]	dates	the list of dates for which the coordinates are to be computed in proper time or affine parameter if #proper is true or in coordinate time if #proper is false (default);
[in]	n_dates	the number of dates to compute ;
[out]	x1dest,x2dest,x3dest,x0dot,x1dot,x2dot,x3dot	arrays in which to store the result. These pointer may be set to NULL to retrieve only part of the information. They must be pre-allocated.
[out]	ephi0,ephi1,ephi2,ephi3,etheta0,etheta1,etheta2,etheta3	arrays in which to store the ephi and etheta (parallel transport case). These pointer may be set to NULL to retrieve only part of the information. They must be pre-allocated.
[out]	otime	array in which to store the other time: coordinate time if #proper, else proper time or affine parameter.
[in]	proper	bool: whether #dates is proper time (or affine parameter) or coordinate time.

◆ getCoord() [3/5]

void Gyoto::Worldline::getCoord	(	double	date,
		Gyoto::state_t &	dest,
		bool	proper = `false`
	)

inherited

Get coordinates+base vectors corresponding to date dest[0].

Depending on the value of parallel_transport_, get position (xi_), velocity (xidot_) and possibly other triad vectors (epi_ and eti_). coord is resized to the right number of elements.

◆ getCoord() [4/5]

void Gyoto::Worldline::getCoord	(	size_t	index,
		Gyoto::state_t &	dest
	)

inherited

Get coordinates+base vectors corresponding to index.

We need this non-const implementation to allow the const, size_t and the non-const, double implementations to coexist.

◆ getCoord() [5/5]

void Gyoto::Worldline::getCoord	(	size_t	index,
		Gyoto::state_t &	dest
	)		const

inherited

Get coordinates+base vectors corresponding to index.

Depending on the value of parallel_transport_, get position (xi_), velocity (xidot_) and possibly other triad vectors (epi_ and eti_). coord is resized to the right number of elements.

◆ getCst()

double const * Gyoto::Worldline::getCst ( ) const

inherited

Returns the worldline's cst of motion (if any)

Return pointer to array holding the previously set Metric-specific constants of motion

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

◆ getInitialCoord()

void Gyoto::Worldline::getInitialCoord ( std::vector< double > & dest ) const

inherited

Get initial coordinates + base vectors.

Depending on the size of dest and on the value of parallel_transport_, get position (xi_), velocity (xidot_) and possibly other triad vectors (epi_ and eti_).

◆ getMass()

virtual double Gyoto::Astrobj::Star::getMass ( ) const

virtual

Return 1.

The mass of a Star is always 1. Stars do not perturb the metric. The only relevant point is that Stars are massive particules, their exact mass is of no importance.

Implements Gyoto::Worldline.

◆ getProperties()

virtual Property const * Gyoto::Astrobj::Star::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::UniformSphere.

Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::InflateStar, and Gyoto::Astrobj::StarTrace.

◆ getVelocity()

virtual void Gyoto::Astrobj::Star::getVelocity	(	double const	pos[4],
		double	vel[4]
	)

virtual

Yield velocity of the center of the sphere.

Implements Gyoto::Astrobj::UniformSphere.

◆ 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::InflateStar, and Gyoto::Astrobj::PolishDoughnut.

◆ integrateEmission() [1/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

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

◆ integrateEmission() [2/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

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

◆ integrator()

void Gyoto::Worldline::integrator ( std::string const & type )

inherited

Set the integrator.

Initialize state_ to use the required integrator.

Parameters

[in] type Either "Legacy" or (if GYOTO_HAVE_BOOST_INTEGRATORS) one of "runge_kutta_cash_karp54", "runge_kutta_fehlberg78", "runge_kutta_dopri5", "runge_kutta_cash_karp54_classic"

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

◆ metric() [1/2]

virtual SmartPointer< Metric::Generic > Gyoto::Astrobj::Star::metric ( ) const

virtual

Get the Metric gg_.

Reimplemented from Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::StarTrace.

◆ metric() [2/2]

virtual void Gyoto::Astrobj::Star::metric ( SmartPointer< Metric::Generic > )

virtual

Set the Metric gg_.

Reimplemented from Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::StarTrace, and Gyoto::Astrobj::StarTrace.

◆ operator()() [1/2]

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

virtualinherited

Square distance to the center of the sphere.

Ensure integration does not miss the object

Implements Gyoto::Astrobj::Standard.

Reimplemented in Gyoto::Astrobj::StarTrace.

◆ operator()() [2/2]

virtual double Gyoto::Functor::Double_constDoubleArray::operator() ( double const data[] )

pure virtualinherited

The actual function.

Implemented in Gyoto::Astrobj::ThinDisk.

◆ opticallyThin() [1/2]

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

inherited

Query whether object is optically thin.

See opticallyThin(bool flag).

◆ opticallyThin() [2/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.

◆ 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, 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.

◆ radiativeQ()

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

virtualinherited

emission and transmission together

Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::Jet, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::FlaredDiskSynchrotron.

◆ radius() [1/2]

virtual void Gyoto::Astrobj::UniformSphere::radius ( double )

virtualinherited

Set radius_ in geometrical units.

Reimplemented in Gyoto::Astrobj::FixedStar, and Gyoto::Astrobj::FixedStar.

◆ radius() [2/2]

virtual void Gyoto::Astrobj::UniformSphere::radius	(	double	,
		std::string const &
	)

virtualinherited

Set radius_ in specified unit.

Reimplemented in Gyoto::Astrobj::FixedStar.

◆ rMax() [1/4]

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

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

Returns: rmax_ in geometrical units

Reimplemented from Gyoto::Astrobj::Generic.

◆ rMax() [2/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() [3/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...

◆ rMax() [4/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

◆ setCst()

void Gyoto::Worldline::setCst	(	double const *	cst,
		size_t const	ncsts
	)

inherited

Set Metric-specific constants of motion.

The will (re)allocate Worldline::cst_, copy cst into it, and set Worldline::cst_n_.

◆ setInitCoord() [1/3]

virtual void Gyoto::Worldline::setInitCoord	(	const double	coord[8],
		int	dir,
		double const	Ephi[4],
		double const	Etheta[4]
	)

virtualinherited

Set Initial coordinate.

Set imin_=imax_=i0_, and x[i0]=coord[].

If dir==1, i0_ is set to 0. If dir==-1, i0_ is set to x_size_-1.

If dir==0 and the Worldine has never been computed (i0_==0, imin_==1 and imax_==0), then dir defaults to 1 for a massive particle and -1 for a massless particle.

If dir==0 and the Worldine has already been computed, i0_ is not changed.

Parameters

coord new initial coordinates

dir direction of integration. 1 for forward integration, -1 for backards integration, 0 for unknown or both

Ephi initial value of base vector to parallel-transport. Ignored if parallel_transport_ is false.

Etheta initial value of base vector to parallel-transport. Ignored if parallel_transport_ is false.

◆ setInitCoord() [2/3]

virtual void Gyoto::Worldline::setInitCoord	(	const double	coord[8],
		int	dir = `0`
	)

virtualinherited

Set Initial coordinate.

Set imin_=imax_=i0_, and x[i0]=coord[].

If dir==1, i0_ is set to 0. If dir==-1, i0_ is set to x_size_-1.

If dir==0 and the Worldine has never been computed (i0_==0, imin_==1 and imax_==0), then dir defaults to 1 for a massive particle and -1 for a massless particle.

If dir==0 and the Worldine has already been computed, i0_ is not changed.

Parameters

coord new initial coordinates

dir direction of integration. 1 for forward integration, -1 for backards integration, 0 for unknown or both

Reimplemented in Gyoto::Astrobj::StarTrace.

◆ setInitCoord() [3/3]

virtual void Gyoto::Worldline::setInitCoord	(	double const	pos[4],
		double const	vel[3],
		int	dir = `0`
	)

virtualinherited

Set initial coordinate.

Parameters

pos	initial 4-position
vel	initial 3-velocity
dir	direction of integration

◆ setInitialCondition() [1/3]

virtual void Gyoto::Astrobj::Star::setInitialCondition ( double const coord[8] )

virtual

Same as Worldline::setInitialCondition(gg, coord, sys,1)

Reimplemented in Gyoto::Astrobj::StarTrace, and Gyoto::Astrobj::StarTrace.

◆ setInitialCondition() [2/3]

void Gyoto::Worldline::setInitialCondition	(	SmartPointer< Metric::Generic >	gg,
		const double	coord[8],
		const int	dir
	)

inherited

Set or re-set the initial condition prior to integration.

Parameters

gg	Gyoto::SmartPointer to the Gyoto::Metric in this universe;
coord	8 element array containing the initial condition, i.e. the 4-position and the 4-velocity of the Photon at the receiving end;
dir	direction: 1 for future, -1 for past.

◆ setInitialCondition() [3/3]

void Gyoto::Worldline::setInitialCondition	(	SmartPointer< Metric::Generic >	gg,
		const double	coord[8],
		const int	dir,
		double const	Ephi[4],
		double const	Etheta[4]
	)

inherited

Set or re-set the initial condition prior to integration.

Parameters

gg	Gyoto::SmartPointer to the Gyoto::Metric in this universe;
coord	8 element array containing the initial condition, i.e. the 4-position and the 4-velocity of the Photon at the receiving end;
dir	direction: 1 for future, -1 for past.
Ephi	initial value of base vector to parallel-transport. Ignored if parallel_transport_ is false.
Etheta	initial value of base vector to parallel-transport. Ignored if parallel_transport_ is false.

◆ setParameter() [1/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.

◆ setParameter() [2/2]

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

virtual

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 from Gyoto::Object.

◆ setParameters()

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

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

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::Astrobj::Generic.

◆ tell()

virtual void Gyoto::Worldline::tell ( Gyoto::Hook::Teller * msg )

protectedvirtualinherited

This is how a Teller tells.

A teller will basically call listener->tell(this).

Parameters

msg	Teller* the Teller who is telling... Useful if the Listener listens to several Tellers.

Reimplemented from Gyoto::Hook::Listener.

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

◆ xAllocate() [1/2]

virtual void Gyoto::Worldline::xAllocate ( )

protectedvirtualinherited

Allocate x0, x1 etc. with default size.

The default size is GYOTO_DEFAULT_X_SIZE

◆ xAllocate() [2/2]

virtual void Gyoto::Worldline::xAllocate ( size_t size )

protectedvirtualinherited

Allocate x0, x1 etc. with a specified size.

Parameters

size	: number of cells in each array x0, x1 etc.

Reimplemented in Gyoto::Astrobj::StarTrace.

◆ xExpand() [1/2]

virtual void Gyoto::Worldline::xExpand	(	double *&	x,
		int	dir
	)

protectedvirtualinherited

Expand one array to hold more elements.

If you need to expand more arrays than x0_ ... x3_ and the dots, call this on your array before calling xExpand(int dir).

Parameters

[in,out]	x	array to expand
[in]	dir

◆ xExpand() [2/2]

virtual size_t Gyoto::Worldline::xExpand ( int dir )

protectedvirtualinherited

Expand x0, x1 etc... to hold more elements.

Double the size of arrays x0, x1 etc. and copy old version of the array in the first half if dir =1 and in the second half if dir =-1.

Parameters

dir	: 1 to expand after last element, -1 to expand before first element

Returns: ind : if dir=1, new index of old last element, if dir=-1, new index of old first element

Reimplemented in Gyoto::Astrobj::StarTrace.

◆ xStore()

virtual void Gyoto::Worldline::xStore	(	size_t	ind,
		state_t const &	coord,
		double	tau
	)

virtualinherited

Store coord at index ind.

Reimplemented in Gyoto::Astrobj::StarTrace.

Member Data Documentation

◆ __defaultfeatures

int Gyoto::Astrobj::Generic::__defaultfeatures

privateinherited

Whether some virtual methods are implemented.

The default implementations of some methods call one-another. This member is used internally to avoid infinite recursion.

◆ abstol_

double Gyoto::Worldline::abstol_

protectedinherited

Absolute tolerance of the integrator.

Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.

◆ delta_

double Gyoto::Worldline::delta_

protectedinherited

Initial integrating step.

Default: GYOTO_DEFAULT_DELTA

◆ delta_max_

double Gyoto::Worldline::delta_max_

protectedinherited

Maximum integration step for the adaptive integrator.

The default (GYOTO_DEFAULT_DELTA_MAX) is usually fine.

For IntegState::Legacy, set it in the Metric instead!

◆ delta_max_over_r_

double Gyoto::Worldline::delta_max_over_r_

protectedinherited

Numerical tuning parameter.

For IntegState::Legacy, set it in the Metric instead!

Ensure that delta (the numerical integration step) is never larger than a fraction of the distance between the current location and the center of the coordinate system.

The default (GYOTO_DEFAULT_DELTA_MAX_OVER_R) is usually fine.

◆ delta_min_

double Gyoto::Worldline::delta_min_

protectedinherited

Minimum integration step for the adaptive integrator.

The default (GYOTO_DEFAULT_DELTA_MIN) is usually fine.

For IntegState::Legacy, set it in the Metric instead!

◆ 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

is written.

◆ mutex_

pthread_mutex_t Gyoto::SmartPointee::mutex_

privateinherited

A mutex.

When compiled with libpthread

◆ parallel_transport_

bool Gyoto::Worldline::parallel_transport_

protectedinherited

Whether to parallel transport a local triad.

Typically used to trace the base in which the Stokes parameters are expressed in the context of polarization.

◆ 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

is written.

◆ reltol_

double Gyoto::Worldline::reltol_

protectedinherited

Absolute tolerance of the integrator.

Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.

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

◆ secondary_

bool Gyoto::Worldline::secondary_

protectedinherited

Experimental: choose 0 to compute only primary image.

This feature is in development.

◆ tmin_

double Gyoto::Worldline::tmin_

protectedinherited

Time limit for the integration (geometrical units)

Computation does not go back before tmin_. Default is -DBL_MAX. tmin_ is always expressed in geometrical units, it is essentially a tuning parameter for the ray-tracing process. tmin_ should be chosen to always be longer than the distance between the screen and the object.

◆ x_size_

size_t Gyoto::Worldline::x_size_

protectedinherited

Coordinate of Second base vector to parallel transport.

Size of x0_, x1_... arrays

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

GyotoStar.h

coord	new initial coordinates
dir	direction of integration. 1 for forward integration, -1 for backards integration, 0 for unknown or both
Ephi	initial value of base vector to parallel-transport. Ignored if parallel_transport_ is false.
Etheta	initial value of base vector to parallel-transport. Ignored if parallel_transport_ is false.

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Subcontractor_t

Constructor & Destructor Documentation

◆ Star() [1/2]

◆ Star() [2/2]

Member Function Documentation

◆ checkPhiTheta()

◆ className()

◆ className_l()

◆ clone()

◆ delta()

◆ deltaInObj()

◆ deltaMax() [1/4]

◆ deltaMax() [2/4]

◆ deltaMax() [3/4]

◆ deltaMax() [4/4]

◆ describeProperty()

◆ eAllocate()

◆ eDeallocate()

◆ eExpand()

◆ emission() [1/2]

◆ emission() [2/2]

◆ fillElement()

◆ fillProperty()

◆ getCartesian()

◆ getCoord() [1/5]

◆ getCoord() [2/5]

◆ getCoord() [3/5]

◆ getCoord() [4/5]

◆ getCoord() [5/5]

◆ getCst()

◆ getDefaultQuantities()

◆ getInitialCoord()

◆ getMass()

◆ getProperties()

◆ getVelocity()

◆ giveDelta()

◆ help()

◆ Impact()

◆ integrateEmission() [1/2]

◆ integrateEmission() [2/2]

◆ integrator()

◆ isThreadSafe()

◆ metric() [1/2]

◆ metric() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ opticallyThin() [1/2]

◆ opticallyThin() [2/2]

◆ processHitQuantities()

◆ property()

◆ radiativeQ()

◆ radius() [1/2]

◆ radius() [2/2]

◆ rMax() [1/4]

◆ rMax() [2/4]

◆ rMax() [3/4]

◆ rMax() [4/4]

◆ setCst()

◆ setInitCoord() [1/3]

◆ setInitCoord() [2/3]

◆ setInitCoord() [3/3]

◆ setInitialCondition() [1/3]

◆ setInitialCondition() [2/3]

◆ setInitialCondition() [3/3]

◆ setParameter() [1/2]

◆ setParameter() [2/2]

◆ setParameters()

◆ tell()

◆ transmission()

◆ xAllocate() [1/2]