fluidsim.base.output.horiz_means

Horizontal means

Provides:

class fluidsim.base.output.horiz_means.HorizontalMeans(output)

Bases: SpecificOutput, SimulExtender

Horizontal means as functions of the z coordinate

Examples

This is an output class to compute/save/load/plot horizontally averaged quantities. Since this is useful only for particular simulations, it is a SimulExtender, meaning that it should be used this way:

from fluidsim.solvers.ns3d.solver import Simul
from fluidsim.base.output.horiz_means import HorizontalMeans, extend_simul_class

Simul = extend_simul_class(Simul, HorizontalMeans)

params = Simul.create_default_params()

...

params.output.periods_save.horiz_means = 0.1

sim = Simul(params)

Then, during or after the simulation:

sim.output.horiz_means.plot(tmin=10)
data = sim.output.horiz_means.load(tmin=10)

_tag = 'horiz_means'

_module_name = 'fluidsim.base.output.horiz_means'

_name_file = 'horiz_means.h5'

classmethod get_modif_info_solver()

Create a function to modify info_solver.

Note that this function is called when the object info_solver has not yet been created (and cannot yet be modified)! This is why one needs to create a function that will be called later to modify info_solver.

classmethod complete_params_with_default(params)

Should complete the simul parameters

_compute_hmean(arr3d)

_hmean_to_3d_local(profile)

compute()

load(tmin=None, tmax=None, verbose=False)

plot(tmin=None, tmax=None, verbose=False)

_abc_impl = <_abc._abc_data object>

Classes

HorizontalMeans(output)

Horizontal means as functions of the z coordinate