Spacetime

Instances of Spacetime are ambient Schwarzschild spacetimes in which photospheres are embedded.

class xpsi.Spacetime.Spacetime(bounds, values, star_shape='AGM_14')[source]

Bases: ParameterSubspace

The ambient Schwarzschild spacetime and Earth coordinates.

Parameters:

  • bounds (dict) – Tuples of hard bounds on parameters with keys matching the names in the initialiser body. A None bound will be interpreted as fixed variable, in which case a value must be supplied in the corresponding dictionary. If there is no entry for a default parameter, it will be assumed to be fixed, but an exception will be raised if there is no associated value.

  • values (dict) – Values of fixed parameters or initial values for free parameters, with keys matching the names in the initialiser body. If there is no entry for a default parameter, no initial value will be specified, but an exception will be raised if there is also no bound specified.

  • star_shape (string) – A string specifying the assumed shape of the star. Options ‘AGM_14’ (an oblate spheroid from Algendy & Morsink 2014) or ‘sphere’ are currently allowed.

We define a property for parameters and combinations of parameters to shortcut access, given that this subspace is passed to other subspaces for model computation. We would like to access the values with fewer characters than self[<name>].

Required parameter names:

  • frequency

  • mass

  • radius

  • distance

  • cos_inclination

property M

Get the (rotationally deformed) gravitational mass in SI.

property Omega

Get the coordinate angular rotation frequency.

property R

Get the coordinate equatorial radius in SI.

property R_r_s

Get the ratio of the equatorial radius to the Schwarzschild radius.

property d

Get the distance of the Earth to the star in SI.

property d_sq

Get the squared distance of the Earth to the star in SI.

property epsilon

Get the derived parameter epsilon for universal relations.

A dimensionless function of stellar properties.

See Morsink et al. (2007), and AlGendy & Morsink (2014).

property f

Get the coordinate rotation frequency.

property i

Get the inclination of the Earth to the rotational axis.

property r_g

Get the Schwarzschild gravitational radius in SI.

property r_s

Get the Schwarzschild radius in SI.

property zeta

Get the derived parameter zeta for universal relations.

A dimensionless function of stellar properties.

See Morsink et al. (2007), and AlGendy & Morsink (2014).