:py:mod:`wolfhece.lagrangian.particle_system_ui`
================================================

.. py:module:: wolfhece.lagrangian.particle_system_ui

.. 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:: Particle_system_to_draw(idx: str = '', plotted: bool = True, mapviewer=None, need_for_wx: bool = False)


   Bases: :py:obj:`wolfhece.drawing_obj.Element_To_Draw`

   .. autoapi-inheritance-diagram:: wolfhece.lagrangian.particle_system_ui.Particle_system_to_draw
      :parts: 1
      :private-bases:

   Base class of element to add into WolfMapViewer or another GUI

   .. py:property:: totaltime
      :type: float

      Return the total time.

   .. py:property:: dt
      :type: float

      Return the time step.

   .. py:property:: scheme
      :type: int

      Return the scheme.

   .. py:property:: blend
      :type: bool

      Return the blend status.

   .. py:property:: colors
      :type: list[tuple[float, int, tuple[float]]]

      colors of particles

   .. py:property:: nb_steps
      :type: int

      Return the number of steps.

   .. py:property:: timestep
      :type: float

      Return the timestep.

   .. py:property:: trace_size
      :type: int

      Return the trace size.

   .. py:property:: ps
      :type: wolfhece.lagrangian.particle_system.Particle_system


   .. py:property:: keys
      :type: list[float]

      Return the keys of the particles.

   .. py:property:: current_step
      :type: float

      Return the current step.

   .. py:property:: current_step_idx
      :type: int

      Return the current step index.

   .. py:property:: list_to_plot
      :type: list[float]

      Return the list of keys to plot.

   .. py:property:: bounds
      :type: tuple[float]

      Return the bounds of the object.

   .. py:method:: reset() -> None

      Reset the object.


   .. py:method:: show_properties() -> None

      Show the properties of the object.


   .. py:method:: _fill_default() -> None

      Fill the default properties of the object.


   .. py:method:: _fill_properties() -> None

      Fill the properties of the object.


   .. py:method:: update_properties() -> None

      Update the properties of the object.


   .. py:method:: update_properties_destroy() -> None

      Update the properties of the object.


   .. py:method:: get_domain(output_type: Literal[numpy, Particle_system_to_draw.get_domain.wolf] = 'wolf') -> Union[numpy.ndarray, wolfhece.wolf_array.WolfArray]

      Return the domain as Numpy array or WolfArray to put in the UI.


   .. py:method:: set_domain(value: Union[numpy.ndarray, wolfhece.wolf_array.WolfArray]) -> None

      Set the domain.


   .. py:method:: get_u(output_type: Literal[numpy, Particle_system_to_draw.get_u.wolf] = 'wolf') -> Union[numpy.ndarray, wolfhece.wolf_array.WolfArray]

      Return the u as Numpy array or WolfArray to put in the UI.


   .. py:method:: get_v(output_type: Literal[numpy, Particle_system_to_draw.get_v.wolf] = 'wolf') -> Union[numpy.ndarray, wolfhece.wolf_array.WolfArray]

      Return the v as Numpy array or WolfArray to put in the UI.


   .. py:method:: get_uv(output_type: Literal[numpy, wolf] = 'wolf') -> Union[tuple[numpy.ndarray], tuple[wolfhece.wolf_array.WolfArray]]

      Return the uv as Numpy array or WolfArray to put in the UI.


   .. py:method:: get_uv_absolute(output_type: Literal[numpy, wolf] = 'wolf') -> Union[numpy.ndarray, wolfhece.wolf_array.WolfArray]


   .. py:method:: set_uv(value: Union[tuple[numpy.ndarray], tuple[wolfhece.wolf_array.WolfArray]], header: tuple[float] = (0.0, 0.0, 1.0, 1.0), time: float = 0.0) -> None

      Set the uv.


   .. py:method:: get_emitters(output_type: Literal[shapely, Particle_system_to_draw.get_emitters.wolf] = 'wolf') -> Union[list[wolfhece.lagrangian.emitter.Emitter], wolfhece.PyVertexvectors.Zones]

      Return the emitters as Shapely array or Zones to put in the UI.


   .. py:method:: set_emitters(value: Union[list[wolfhece.lagrangian.emitter.Emitter], wolfhece.PyVertexvectors.Zones]) -> None

      Set the emitters.


   .. py:method:: set_emitter(value: wolfhece.PyVertexvectors.vector) -> None

      Add an emitter.


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

      Get the times for velocity fields.


   .. py:method:: set_times_vf(times: list[float])

      Set the times for velocity fields.


   .. py:method:: get_times()

      Get the times.


   .. py:method:: load(f: str) -> None

      Load the particles from file.


   .. py:method:: save(f: str = '') -> None

      Save the particles to file.


   .. py:method:: plot(sx=None, sy=None, xmin=None, ymin=None, xmax=None, ymax=None, size=None)

      Plot data in OpenGL context


   .. py:method:: next_step()

      Go to next step.


   .. py:method:: previous_step()

      Go to previous step.


   .. py:method:: find_minmax(update=False)

      Generic function to find min and max spatial extent in data


   .. py:method:: check()

      Check the object validity


   .. py:method:: bake() -> tuple[bool, str]

      Bake the object