DisortFlux

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

The flux result variable for Disort.

1. AscendingGrid frequency grid

2. DescendingGrid level altitude grid

3. Matrix upwelling flux

4. Matrix diffuse downwelling flux

5. Matrix direct downwelling flux

6. Matrix derivative of net upward flux with respect to downward optical depth (DFDT)

The matrices have shape (frequency, layer) and are evaluated at the lower boundary of each layer, corresponding to alt_grid[1:]. The top boundary is omitted. Flux and DFDT are in W/(m^2 Hz); DFDT is not a temperature tendency. Multiply DFDT by physical extinction [1/m], divide by density [kg/m^3] and mass specific heat capacity [J/(kg K)], and integrate over frequency to obtain heating in K/s. The Python recipe pyarts3.recipe.heating_rates.from_disort performs this conversion.

Overview

Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
DescendingGrid	alt_grid	Altitude grid of the fluxes (level values)
Matrix	dfdt	Derivative of net upward flux with respect to downward optical depth [W/(m^2 Hz)], at each layer’s lower boundary (alt_grid[1:]), using that layer’s optical properties. Not a temperature tendency. See pyarts3.recipe.heating_rates.from_disort.
Matrix	down_diffuse	Downward diffuse flux (layer values)
Matrix	down_direct	Downward direct flux (layer values)
AscendingGrid	freq_grid	Frequency grid of the fluxes
Matrix	up	Upwelling flux (layer values)
Operator	__eq__()	Return self==value.
Operator	__format__()	__format__(self, arg: str, /) -> str
Operator	__ge__()	Return self>=value.
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	__init__(self, arg: pyarts3.arts.DisortFlux) -> None
Operator	__le__()	Return self<=value.
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	__repr__(self) -> str
Operator	__str__()	__str__(self) -> str

Constructors

__init__(self) → None

__init__(self, arg: pyarts3.arts.DisortFlux) → 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

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

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

alt_grid: DescendingGrid

Altitude grid of the fluxes (level values)

dfdt: Matrix

Derivative of net upward flux with respect to downward optical depth [W/(m^2 Hz)], at each layer’s lower boundary (alt_grid[1:]), using that layer’s optical properties. Not a temperature tendency. See pyarts3.recipe.heating_rates.from_disort.

down_diffuse: Matrix

Downward diffuse flux (layer values)

down_direct: Matrix

Downward direct flux (layer values)

freq_grid: AscendingGrid

Frequency grid of the fluxes

up: Matrix

Upwelling flux (layer values)

Operators

__eq__(value, /)

Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /)

Return self>=value.

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

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

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__str__(self) → str