wolfhece.mesh2d.topo_unsteady
=============================

.. py:module:: wolfhece.mesh2d.topo_unsteady

.. autoapi-nested-parse::

   Author: HECE - University of Liege, Pierre Archambeau
   Date: 2024

   Copyright (c) 2024 University of Liege. All rights reserved.

   This script and its content are protected by copyright law. Unauthorized
   copying or distribution of this file, via any medium, is strictly prohibited.





Module Contents
---------------

.. py:class:: UnsteadyTopoBathymetry(filename_wo_extension: str | pathlib.Path, dx_dy: tuple[float, float])

   Manage unsteady topo/bathymetry data for WOLF2D meshes and dike breach.

   Position is in ".topipar" file.
   Array data is in ".topi" file.


   .. py:attribute:: _genfile


   .. py:attribute:: _topiparfile


   .. py:attribute:: _topifile


   .. py:attribute:: _arrays_ref
      :type:  list[wolfhece.wolf_array.WolfArray]


   .. py:attribute:: _unsteady_arrays


   .. py:method:: _read_topipar() -> dict

      Read the .topipar file and return parameters as a dictionary.




   .. py:method:: _read_topi()

      Read the .topi file and populate unsteady arrays.




   .. py:method:: read_all()

      Read all unsteady topo/bathymetry data from files.




   .. py:method:: find_first_time_with_difference(reference_array: wolfhece.wolf_array.WolfArray) -> float | None

      Find the first time where the unsteady topo/bathymetry differs from the reference array.




   .. py:method:: find_first_time_with_difference_greater_than(reference_array: wolfhece.wolf_array.WolfArray, threshold: float) -> float | None

      Find the first time where the unsteady topo/bathymetry differs from the reference array by more than a threshold.




   .. py:method:: find_last_time_with_difference(reference_array: wolfhece.wolf_array.WolfArray) -> float | None

      Find the last time where the unsteady topo/bathymetry differs from the reference array.




   .. py:method:: get_times() -> list[float]

      Get the list of available times for unsteady topo/bathymetry data.




   .. py:method:: get_array_at_time(time: float) -> wolfhece.wolf_array.WolfArray | None

      Get the topo/bathymetry array at a specific time.




   .. py:method:: get_array_at_nearest_time(time: float) -> wolfhece.wolf_array.WolfArray | None

      Get the topo/bathymetry array at the nearest available time.




   .. py:method:: find_nearest_time(time: float) -> float | None

      Find the nearest available time for unsteady topo/bathymetry data.




   .. py:method:: find_nearest_time_index(time: float) -> int | None

      Find the index of the nearest available time for unsteady topo/bathymetry data.