fluidsimfoam

Fluidsimfoam API reference

Sub-packages

foam_input_files	OpenFOAM input files
solvers	Define and use solvers
output	Base class for the sim.output object
util	Utilities for Fluidsimfoam
resources	Subpackage containing potential templates (actually empty for now)
invoke	Invoke utilities and tasks

Modules

info	Base class for Simul.InfoSolver
make	Base class for the sim.make object
init_fields	Base class for the sim.init_fields object
operators	Base class for the sim.oper object
log	Fluidsimfoam logging
testing	Testing utilities
params	Base class for the params object

Functions

load([path_dir, hide_stdout])	Loads a simulation
load_params([path_dir])	Load a fluidsim_core.params.Parameters instance from path_dir
load_simul([path_dir, hide_stdout])	Loads a simulation

fluidsimfoam.load(path_dir='.', hide_stdout=False)

Loads a simulation

Parameters:

path_dir (str or path-like) – Path to a directory containing a simulation. If not provided the current directory is used.

fluidsimfoam.load_simul(path_dir='.', hide_stdout=False)

Loads a simulation

Parameters:

path_dir (str or path-like) – Path to a directory containing a simulation. If not provided the current directory is used.

fluidsimfoam.load_params(path_dir='.')

Load a fluidsim_core.params.Parameters instance from path_dir

Parameters:

path_dir (str or path-like) – Path to a simulation directory.

Returns:

params

Return type:

fluidsim_core.params.Parameters