fluidsim.base.output.base

Base module for the output

Provides:

class fluidsim.base.output.base.OutputBase(sim)[source]

Bases: OutputCore

Handle the output.

class SimReprMaker(sim)

Bases: SimReprMakerCore

Produce a string representing the simulation

static _complete_info_solver(info_solver)[source]: Complete the ParamContainer info_solver.

static _complete_params_with_default(params, info_solver)[source]: This static method is used to complete the params container.

_init_sim_repr_maker()[source]

Create a list of strings to make the run name.

Returns:

fluidsim_core.output.base.SimReprMakerCore

post_init()[source]: 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)[source]: Save files with information on the solver and on the run.

get_mean_values(tmin=None, tmax=None, use_cache=True, customize=None)[source]

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)

class fluidsim.base.output.base.OutputBasePseudoSpectral(sim)[source]

Bases: OutputBase

post_init()[source]: Execute once the sim object is injected with all child classes. Typically used to print descriptive initialization messages.

compute_energy_fft()[source]: Compute energy(k)

compute_energy()[source]: Compute the spatially averaged energy.

class fluidsim.base.output.base.SpecificOutput(output, period_save=0, period_plot=0, has_to_plot_saved=False, arrays_1st_time=None)[source]

Bases: object

Small class for features useful for specific outputs

_online_save()[source]: Save the values at one time.

class fluidsim.base.output.base.SimReprMaker(sim)[source]

Bases: SimReprMakerCore

Produce a string representing the simulation

Classes

`OutputBase`(sim)	Handle the output.
`OutputBasePseudoSpectral`(sim)
`SimReprMaker`(sim)	Produce a string representing the simulation
`SpecificOutput`(output[, period_save, ...])	Small class for features useful for specific outputs