Utilities

class fdsreader.utils.extent.Extent(*args, skip_dimension: Literal['x', 1, 'y', 2, 'z', 3, ''] = '')

Three-dimensional value-based extent with support for a missing dimension (2D).

as_list(reduced=True) → List[float]

Gives the extent in list notation (without empty extents).

Parameters:

reduced – Whether to leave out empty extents or not.

as_tuple(reduced=True) → Tuple[float, ...]

Gives the extent in tuple notation (without empty extents).

Parameters:

reduced – Whether to leave out empty extents or not.

property x_end: float

Gives the absolute extent in x-direction.

property x_start: float

Gives the absolute extent in x-direction.

property y_end: float

Gives the absolute extent in y-direction.

property y_start: float

Gives the absolute extent in y-direction.

property z_end: float

Gives the absolute extent in z-direction.

property z_start: float

Gives the absolute extent in z-direction.

class fdsreader.utils.dimension.Dimension(*args, skip_dimension: Literal['x', 1, 'y', 2, 'z', 3, ''] = '')

Three-dimensional index-based extent with support for a missing dimension (2D).

Variables:

• x – Number of data points in x-direction (end is exclusive).

• y – Number of data points in y-direction (end is exclusive).

• z – Number of data points in z-direction (end is exclusive).

as_list(cell_centered=False, reduced=True) → List

Gives the dimension in list notation (without empty extents).

Parameters:

reduced – Whether to leave out empty dimensions (size of 1) or not.

as_tuple(cell_centered=False, reduced=True) → Tuple

Gives the dimensions in tuple notation (optionally without empty dimensions).

Parameters:

reduced – Whether to leave out empty dimensions (size of 1) or not.

shape(cell_centered=False) → Tuple

Method to get the actual number of data points per dimension.

size(cell_centered=False)