Gyoto::Worldline Class Reference

geodesic? More...

#include <GyotoWorldline.h>

Inheritance diagram for Gyoto::Worldline:

List of all members.

Public Member Functions
	Worldline ()
	Default constructor.
	Worldline (const size_t sz)
	Default constructor.
	Worldline (const Worldline &)
	Copy constructor.
	Worldline (Worldline *orig, size_t i0, int dir, double step_max)
virtual	~Worldline ()
	Refine constructor.
int	getImin () const
int	getImax () const
int	getI0 () const
virtual double	getMass () const =0
	Get mass of particule.
void	setMetric (SmartPointer< Metric::Generic >)
	Set metric Smartpointer.
SmartPointer< Metric::Generic >	getMetric () const
	Get metric.
void	setInitCoord (const double coord[8], int dir=0)
	Set Initial coordinate.
void	reset ()
	Forget integration, keeping initial contition.
virtual std::string	className () const
	"Worldline"
virtual std::string	className_l () const
	"worldline"
void	operator= (const Worldline &)
	Assignment to another Worldline.
void	setDelta (const double delta)
	Set delta.
double	getTlim () const
	Get tlim value.
void	setTlim (double tlim)
	Set tlim to a given value.
double const *	getCst () const
	Returns the worldline's cst of motion (if any)
void	setCst (double const *cst, size_t const ncsts)
void	setInitialCondition (SmartPointer< Metric::Generic > gg, const double coord[8], const int dir)
	Set or re-set the initial condition prior to integration.
void	getInitialCoord (double dest[8]) const
	get initial coordinate
void	getCoord (size_t index, double dest[8]) const
	get coordinates corresponding to index
void	getCartesianPos (size_t index, double dest[4]) const
	get Cartesian expression of 4-position at index.
void	xFill (double tlim)
	Fill x0, x1... by integrating the Worldline from previously set inittial condition to time tlim.
int	get_nelements () const
void	get_t (double *dest) const
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)
void	get_xyz (double *x, double *y, double *z) const
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)
void	getCoord (double *x0, double *x1, double *x2, double *x3) const
void	getSkyPos (SmartPointer< Screen > screen, double *dalpha, double *ddellta, double *dD) const
void	get_dot (double *x0dot, double *x1dot, double *x2dot, double *x3dot) const
void	get_prime (double *x1prime, double *x2prime, double *x3prime) const
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.

Protected Member Functions
void	xAllocate ()
	Allocate x0, x1 etc. with default size.
void	xAllocate (size_t size)
	Allocate x0, x1 etc. with a specified size.
size_t	xExpand (int dir)
	Expand x0, x1 etc... to hold more elements.

Protected Attributes
SmartPointer < Gyoto::Metric::Generic >	metric_
	The Gyoto::Metric in this part of the universe.
double *	x0_
	t or T
double *	x1_
	r or x
double *	x2_
	theta or y
double *	x3_
	phi or z
double *	x0dot_
	tdot or Tdot
double *	x1dot_
	rdot or xdot
double *	x2dot_
	thetadot or ydot
double *	x3dot_
	phidot or zdot
size_t	x_size_
	Size of x0, x1... arrays.
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.
double	delta_
	Initial integrating step ; defaults to 0.01.
double	tlim_
	Minimum time for integration, stop integration if t<tlim ; defaults to 0.
double *	cst_
	Worldline's csts of motion (if any)
size_t	cst_n_
	Number of constants of motion.

Friends
std::ostream &	operator<< (std::ostream &, const Worldline &)
	Display.

---

Detailed Description

geodesic?

---

Constructor & Destructor Documentation

virtual Gyoto::Worldline::~Worldline ( )

virtual

Refine constructor.

Constructor from a file (see sauve(FILE*) ) Destructor

---

Member Function Documentation

void Gyoto::Worldline::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 (x, y, z, dx/dt, dy/dt, dz/dt) for specific dates. The coordinates will be computed using the integrator, so they will be as accurate as possible. Transforming to Cartesian coordinates is not necessarily meaningful.

Parameters:

dates,:	the list of dates for which the coordinates are to be computed;
n_dates,:	the number of dates to compute ;
x*,:	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.

Reimplemented in Gyoto::Astrobj::Star.

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
	)

Get 8-coordinates for spcific 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:

dates,:	the list of dates for which the coordinates are to be computed;
n_dates,:	the number of dates to compute ;
x*,:	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.

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

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

double const* Gyoto::Worldline::getCst

(

)

const

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

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

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

Set Metric-specific constants of motion

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

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

Set initial condition for this Photon :

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;
sys	: an integer stating in which coordinate system coord is given.

void Gyoto::Worldline::xAllocate ( )

protected

Allocate x0, x1 etc. with default size.

The default size is GYOTO_DEFAULT_X_SIZE

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

protected

Allocate x0, x1 etc. with a specified size.

Parameters:

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

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

protected

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

---

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

• GyotoWorldline.h