fluidsim.base.output

Output (fluidsim.base.output)

Provides:

base	Base module for the output
cross_corr3d	Cross correlations
horiz_means	Horizontal means
increments	Increments
phys_fields	Physical fields output
phys_fields1d	Physical fields output 1d
phys_fields2d	Physical fields output 2d
phys_fields3d	Physical fields output 3d
print_stdout	Standard output saving
prob_dens_func	Probability density functions
spatial_means	Spatial means
spatiotemporal_spectra	Spatiotemporal Spectra
spect_energy_budget	Spectral energy budget
spectra_multidim	Spectral multidimensional
spectra	Spectra
spectra3d	Spectra 3d
temporal_spectra	Temporal spectra
time_signals_fft	Old spatio-temporal spectra

class fluidsim.base.output.OutputBase(sim)

Bases: OutputCore

Handle the output.

class SimReprMaker(sim)

Bases: SimReprMakerCore

Produce a string representing the simulation

get_time_as_str()

static _complete_info_solver(info_solver)

Complete the ParamContainer info_solver.

static _complete_params_with_default(params, info_solver)

This static method is used to complete the params container.

_init_sim_repr_maker()

Create a list of strings to make the run name.

Returns:

fluidsim_core.output.base.SimReprMakerCore

init_with_oper_and_state()

post_init()

Execute once the sim object is injected with all child classes. Typically used to print descriptive initialization messages.

_save_info_solver_params_xml(replace=False)

Save files with information on the solver and on the run.

init_with_initialized_state()

one_time_step()

figure_axe(numfig=None, size_axe=None)

close_files()

end_of_simul(total_time)

compute_energy()

print_size_in_Mo(arr, string=None)

get_mean_values(tmin=None, tmax=None, use_cache=True, customize=None)

Get a dict of scalar values characterizing the simulation

Parameters:

tmin: float

Minimum time

tmax: float

Maximum time

use_cache: bool

If True, return the cached result

customize: callable

If not None, called as customize(result, self.sim) to modify the returned dict.

Examples

def customize(result, sim):
    result["Rb"] = float(sim.params.short_name_type_run.split("_Rb")[-1])
sim.output.get_mean_values(customize=customize)

_compute_mean_values(tmin, tmax)

_abc_impl = <_abc._abc_data object>

class fluidsim.base.output.OutputBasePseudoSpectral(sim)

Bases: OutputBase

post_init()

Execute once the sim object is injected with all child classes. Typically used to print descriptive initialization messages.

compute_energy_fft()

Compute energy(k)

compute_energy()

Compute the spatially averaged energy.

_abc_impl = <_abc._abc_data object>

Functions

create_description_xmf_file([path])	Create description xmf file for Paraview
create_description_xmf_files([path])	Create description xmf files for Paraview
run()