wolfhece.lagrangian.particle_system_ui

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

class wolfhece.lagrangian.particle_system_ui.Particle_system_to_draw(idx: str = '', plotted: bool = True, mapviewer=None, need_for_wx: bool = False)

Bases: wolfhece.drawing_obj.Element_To_Draw

Base class of element to add into WolfMapViewer or another GUI

property totaltime: float

Return the total time.

property dt: float

Return the time step.

property scheme: int

Return the scheme.

property blend: bool

Return the blend status.

property colors: list[tuple[float, int, tuple[float]]]

colors of particles

property nb_steps: int

Return the number of steps.

property timestep: float

Return the timestep.

property trace_size: int

Return the trace size.

property ps: wolfhece.lagrangian.particle_system.Particle_system

property keys: list[float]

Return the keys of the particles.

property current_step: float

Return the current step.

property current_step_idx: int

Return the current step index.

property list_to_plot: list[float]

Return the list of keys to plot.

property bounds: tuple[float]

Return the bounds of the object.

reset() → None

Reset the object.

show_properties() → None

Show the properties of the object.

_fill_default() → None

Fill the default properties of the object.

_fill_properties() → None

Fill the properties of the object.

update_properties() → None

Update the properties of the object.

update_properties_destroy() → None

Update the properties of the object.

get_domain(output_type: Literal[numpy, Particle_system_to_draw.get_domain.wolf] = 'wolf') → numpy.ndarray | wolfhece.wolf_array.WolfArray

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

set_domain(value: numpy.ndarray | wolfhece.wolf_array.WolfArray) → None

Set the domain.

get_u(output_type: Literal[numpy, Particle_system_to_draw.get_u.wolf] = 'wolf') → numpy.ndarray | wolfhece.wolf_array.WolfArray

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

get_v(output_type: Literal[numpy, Particle_system_to_draw.get_v.wolf] = 'wolf') → numpy.ndarray | wolfhece.wolf_array.WolfArray

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

get_uv(output_type: Literal[numpy, wolf] = 'wolf') → tuple[numpy.ndarray] | tuple[wolfhece.wolf_array.WolfArray]

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

get_uv_absolute(output_type: Literal[numpy, wolf] = 'wolf') → numpy.ndarray | wolfhece.wolf_array.WolfArray

set_uv(value: 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.

get_emitters(output_type: Literal[shapely, Particle_system_to_draw.get_emitters.wolf] = 'wolf') → list[wolfhece.lagrangian.emitter.Emitter] | wolfhece.PyVertexvectors.Zones

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

set_emitters(value: list[wolfhece.lagrangian.emitter.Emitter] | wolfhece.PyVertexvectors.Zones) → None

Set the emitters.

set_emitter(value: wolfhece.PyVertexvectors.vector) → None

Add an emitter.

get_times_vf() → list[float]

Get the times for velocity fields.

set_times_vf(times: list[float])

Set the times for velocity fields.

get_times()

Get the times.

load(f: str) → None

Load the particles from file.

save(f: str = '') → None

Save the particles to file.

plot(sx=None, sy=None, xmin=None, ymin=None, xmax=None, ymax=None, size=None)

Plot data in OpenGL context

next_step()

Go to next step.

previous_step()

Go to previous step.

find_minmax(update=False)

Generic function to find min and max spatial extent in data

check()

Check the object validity

bake() → tuple[bool, str]

Bake the object