domain.py

Domain dataclass

Domain(
    x_min: float,
    x_max: float,
    z_min: float,
    z_max: float,
    extent: NDArray | None = None,
)

Handle metadata for model domain geometry.

Parameters

x_min: float Required domain minimum x provided during instantiation. x_max: float Required domain maximum x provided during instantiation. z_min: float Required domain minimum z provided during instantiation. z_max: float Required domain maximum z provided during instantiation.

Attributes

extent: NDArray Sequence of limits as (x_min, x_max, z_max, z_min).

Returned by:

• Python package levelset
  •  LevelSetElementaryMethods
    •  compute_domain
    •  pad_domain
  •  LevelSetSolver
    •  compute_domain
    •  pad_domain
  •  LevelSetSolverBase
    •  compute_domain
    •  pad_domain
  •  LevelSetSpeedMethods
    •  compute_domain
    •  pad_domain

Used by:

• Python package levelset
  •  LevelSetData
  •  LevelSetElementaryMethods  compute_pixel_dimensions
  •  LevelSetSolver
    •  compute_pixel_dimensions
    •  compute_pixel_origin
    •  pad_domain
  •  LevelSetSolverBase
  •  LevelSetSpeedMethods
    •  compute_pixel_dimensions
    •  compute_pixel_origin
    •  pad_domain

Methods:

• __post_init__ –

  Complete instantiation of domain class by computing bounds etc.

• bounds –

  Get domain (x,z) bounds.

• origin –

  Get domain (x,z) origin.

__post_init__

__post_init__() -> None

Complete instantiation of domain class by computing bounds etc.

Source code in erosionfront/levelset/domain.py

def __post_init__(self) -> None:
    """
    Complete instantiation of domain class by computing bounds etc.
    """
    self.extent = np.array([
        self.x_min, self.x_max, self.z_max, self.z_min,
    ])

bounds

bounds() -> NDArray | None

Get domain (x,z) bounds.

Returns

2x2 matrix containing row vectors (x_min,z_min) and (x_max,z_max).

Source code in erosionfront/levelset/domain.py

def bounds(self) -> NDArray | None:
    """
    Get domain (x,z) bounds.

    Returns
    -------
    2x2 matrix containing row vectors (x_min,z_min) and (x_max,z_max).
    """
    return np.array([
        self.extent[:2], self.extent[2:][::-1]
    ]).T if self.extent is not None else None

origin

origin() -> NDArray | None

Get domain (x,z) origin.

Returns

NDArray | None: Extents as array if they exist, otherwise None.

Source code in erosionfront/levelset/domain.py

def origin(self) -> NDArray | None:
    """
    Get domain (x,z) origin.

    Returns
    -------
    NDArray | None:
        Extents as array if they exist, otherwise None.
    """
    return np.array([
        self.extent[0], self.extent[-1]
    ]) if self.extent is not None else None