EllipsoidGravity

class pyarts3.arts.EllipsoidGravity(*args, **kwargs)

Ellipsoid gravity operator - allows calculation of gravity on ellipsoidal bodies

Overview

Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	Earth()	Earth ellipsoid gravity operator
Static Method	Jupiter()	Jupiter ellipsoid gravity operator
Static Method	Mars()	Mars ellipsoid gravity operator
Static Method	Mercury()	Mercury ellipsoid gravity operator
Static Method	Moon()	Moon ellipsoid gravity operator
Static Method	Saturn()	Saturn ellipsoid gravity operator
Static Method	Venus()	Venus ellipsoid gravity operator
Static Method	fromxml()	Create variable from file.
Numeric	GM	Standard gravitational parameter in m^3/s^2.
Numeric	a	Semi-major axis in m.
Numeric	e	Eccentricity.
Operator	__call__()	Calculate gravity at a given position.
Operator	__eq__()	Return self==value.
Operator	__format__()	Default object formatter.
Operator	__ge__()	Return self>=value.
Operator	__getstate__()	Helper for pickle.
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self) -> None
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	Return repr(self).
Operator	__str__()	Return str(self).

Constructors

__init__(self) → None

__init__(self, arg: pyarts3.arts.EllipsoidGravity) → None

__init__(self) → None

Methods

readxml(self, file: str) → str

Read variable from file.

Parameters:

file (str) – A file that can be read.

Raises:

RuntimeError – For any failure to read.

Returns:

file – The file path found (may differ from input due to environment variables).

Return type:

str

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

Saves variable to file.

Parameters:

• file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files.

• type (str, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.

• clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

Earth() → pyarts3.arts.EllipsoidGravity

Earth ellipsoid gravity operator

Jupiter() → pyarts3.arts.EllipsoidGravity

Jupiter ellipsoid gravity operator

Mars() → pyarts3.arts.EllipsoidGravity

Mars ellipsoid gravity operator

Mercury() → pyarts3.arts.EllipsoidGravity

Mercury ellipsoid gravity operator

Moon() → pyarts3.arts.EllipsoidGravity

Moon ellipsoid gravity operator

Saturn() → pyarts3.arts.EllipsoidGravity

Saturn ellipsoid gravity operator

Venus() → pyarts3.arts.EllipsoidGravity

Venus ellipsoid gravity operator

fromxml(file: str) → pyarts3.arts.EllipsoidGravity

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

Returns:

artstype – The variable created from the file.

Return type:

T

Attributes

GM: Numeric

Standard gravitational parameter in m^3/s^2.

a: Numeric

Semi-major axis in m.

e: Numeric

Eccentricity.

Operators

__call__(self, h: object, lat: object, lon: object) → object

Calculate gravity at a given position.

__eq__(value, /)

Return self==value.

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(value, /)

Return self>=value.

__getstate__()

Helper for pickle.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

__init__(self, arg: pyarts3.arts.EllipsoidGravity) → None

__init__(self) → None

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__()

Return repr(self).

__str__()

Return str(self).