HydrostaticPressureOption

class pyarts3.arts.HydrostaticPressureOption(*args, **kwargs)

These options control how the hydrostatic pressure is computed in ARTS.

There are two main options for how the hydrostatic pressure is computed:

HydrostaticEquation:

\[p(z + h) = p(z) \left(1 - \frac{Mg}{RT} h\right)\]
HypsometricEquation:

\[p(z + h) = p(z) e^{- \frac{Mg}{RT} h }\]

where:

\(p(z)\) is the pressure at altitude \(z\),
\(h\) is the altitude difference,
\(g\) is the gravitational acceleration at altitude \(z\),
\(M\) is the mean mass of an atmospheric molecule at altitude \(z\),
\(R\) is the specific gas constant, and
\(T\) is the temperature at altitude \(z\).

Note

We do not consider The Eötvös effect. We also do not directly support “virtual temperature”, as water is baked into \(M\). Either addition would be welcome as additional options.

Valid options:

"HydrostaticEquation": Piece-wise linearly decaying with altitude.
"HypsometricEquation": Piece-wise exponentailly decaying with altitude.

Overview

Method	`readxml()`	Read variable from file
Method	`savexml()`	Saves variable to file
Static Method	`fromxml()`	Create variable from file
Static Method	`get_options()`	Get a list of all options
Static Method	`get_options_as_strings()`	Get a list of all options as strings
Static Data	`pyarts3.arts.HydrostaticPressureOption.HydrostaticEquation`	“HydrostaticEquation” (`HydrostaticPressureOption`)
Static Data	`pyarts3.arts.HydrostaticPressureOption.HypsometricEquation`	“HypsometricEquation” (`HydrostaticPressureOption`)
Operator	`__eq__()`	self == other
Operator	`__format__()`	Default object formatter.
Operator	`__ge__()`	self >= other
Operator	`__getstate__()`	__getstate__(self) -> tuple[str]
Operator	`__gt__()`	self > other
Operator	`__hash__()`	Allows hashing
Operator	`__init__()`	__init__(self, arg: str, /) -> None
Operator	`__le__()`	self <= other
Operator	`__lt__()`	self < other
Operator	`__ne__()`	self != other
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__setstate__()`	__setstate__(self, arg: tuple[str], /) -> None
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None
__init__(self, arg: pyarts3.arts.HydrostaticPressureOption) → None
__init__(self, arg: str, /) → None

Methods

readxml(self, file: str) → str

Read variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

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) – Type of file to save. See FileType for options.
clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:: Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) → pyarts3.arts.HydrostaticPressureOption

Create variable from file

Parameters:: file (str) – A file that can be read

On Error:: Throws RuntimeError for any failure to read

get_options() → list[pyarts3.arts.HydrostaticPressureOption]: Get a list of all options

get_options_as_strings() → list[str]: Get a list of all options as strings

Operators

__eq__(self, arg: pyarts3.arts.HydrostaticPressureOption, /) → bool: self == other

__format__(format_spec, /)

Default object formatter.

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

__ge__(self, arg: pyarts3.arts.HydrostaticPressureOption, /) → bool: self >= other

__getstate__(self) → tuple[str]

__gt__(self, arg: pyarts3.arts.HydrostaticPressureOption, /) → bool: self > other

__hash__(self) → int: Allows hashing

__init__(self) → None
__init__(self, arg: pyarts3.arts.HydrostaticPressureOption) → None
__init__(self, arg: str, /) → None

__le__(self, arg: pyarts3.arts.HydrostaticPressureOption, /) → bool: self <= other

__lt__(self, arg: pyarts3.arts.HydrostaticPressureOption, /) → bool: self < other

__ne__(self, arg: pyarts3.arts.HydrostaticPressureOption, /) → bool: self != other

__repr__(self) → str

__setstate__(self, arg: tuple[str], /) → None

__str__(self) → str