fluidsim.base.output.phys_fields3d

Physical fields output 3d

Provides:

class fluidsim.base.output.phys_fields3d.MoviesBasePhysFields3D(output, phys_fields)[source]

Bases: MoviesBasePhysFields2D

_init_labels(xlabel=None, ylabel=None)[source]

Initialize the labels.

class fluidsim.base.output.phys_fields3d.PhysFieldsBase3D(output)[source]

Bases: PhysFieldsBase2D

_cls_movies

alias of MoviesBasePhysFields3D

set_equation_crosssection(equation)[source]

Set the equation defining the cross-section.

Parameters:
equationstr

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

plot(field=None, time=None, QUIVER=True, vector='v', equation=None, nb_contours=20, type_plot='contourf', vmin=None, vmax=None, cmap=None, numfig=None, SCALED=True)[source]

Plot a field.

Parameters:
field{str, np.ndarray}, optional
timenumber, optional
QUIVERTrue
vecx‘ux’
vecy‘uy’
nb_contours20
type_plot“pcolor” or “contourf”
vminNone
vmaxNone
cmapNone (usually ‘viridis’)
numfigNone
plot_mean(field=None, tmin=None, tmax=None, QUIVER=True, vector='v', equation=None, nb_contours=20, type_plot='contourf', vmin=None, vmax=None, cmap=None, numfig=None, SCALED=True)[source]

Plot the time average of a field.

Parameters:
fieldstr, optional
tminnumber, optional
tmaxnumber, optional
QUIVERTrue
vecx‘ux’
vecy‘uy’
nb_contours20
type_plot‘contourf’
vminNone
vmaxNone
cmapNone (usually ‘viridis’)
numfigNone
SCALEDTrue

Classes

MoviesBasePhysFields3D(output, phys_fields)

PhysFieldsBase3D(output)