fluidsim_core.output.phys_fields

Abstract base classes for Physical fields output

These classes can be used to define classes working together with fluidsim_core.output.movies.MoviesBasePhysFields.

class fluidsim_core.output.phys_fields.PhysFieldsABC

Bases: object

_equation: str | None

_can_plot_quiver: bool | None

set_of_phys_files: SetOfPhysFieldFilesABC

abstract get_key_field_to_plot(forbid_compute=False, key_prefered=None)

Get the key corresponding to the field to be plotted

abstract get_field_to_plot(key=None, time=None, idx_time=None, equation=None, interpolate_time=True, skip_vars=())

Get the field to be plotted in process 0.

abstract get_vector_for_plot(from_state=False, time=None, interpolate_time=True)

Get the vector components

_set_title(ax, key, time, vmax=None)

abstract _get_axis_data()

Get x and y axes data

set_equation_crosssection(equation)

Set the equation defining the cross-section.

Parameters:

equationstr

The equation can be of the shape ‘iz=2’, ‘z=1’, …

_init_skip_quiver()

_abc_impl = <_abc._abc_data object>

class fluidsim_core.output.phys_fields.SetOfPhysFieldFilesABC

Bases: object

times: list

abstract update_times()

Update the times of the files

abstract get_min_time()

Get minimum time

_abc_impl = <_abc._abc_data object>

Classes

PhysFieldsABC()
SetOfPhysFieldFilesABC()
SetOfPhysFieldFilesBase([path_dir, output])