fluidsimfoam.output#

Base class for the sim.output object

`base`	Base output class
`fields`	Class for the `sim.output.fields` object
`log`	Class for the `sim.output.log` object
`dataframe_from_paths`	Create a dataframe from result directories

class fluidsimfoam.output.Output(sim=None, params=None)[source]#

name_variables = ['p', 'U']#

name_constant_files = ['transportProperties', 'turbulenceProperties']#

name_system_files = ['controlDict', 'fvSchemes', 'fvSolution', 'decomposeParDict']#

classmethod get_path_solver_package()[source]#: Get the path towards the solver package.

post_init()[source]#: Logs info on instantiated classes

fluidsimfoam.output.get_dataframe_from_paths(paths, tmin=None, tmax=None, use_cache=True, customize=None)#

Produce a dataframe from a set of simulations.

Uses sim.output.get_mean_values

fluidsimfoam.output.get_mean_values_from_path(path, 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])
get_mean_values_from_path(path, customize=customize)