From dbf14a4ea5f581f4b20f14bf965da8731a9f8950 Mon Sep 17 00:00:00 2001 From: Cyrille Bonamy Date: Wed, 15 Dec 2021 13:59:03 +0100 Subject: [PATCH] minor doc correction --- fluidfoam/openfoamsimu.py | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/fluidfoam/openfoamsimu.py b/fluidfoam/openfoamsimu.py index 34189df..12abf5d 100644 --- a/fluidfoam/openfoamsimu.py +++ b/fluidfoam/openfoamsimu.py @@ -22,19 +22,20 @@ def __init__(self, simu): "No directory found for simulation named {}".format(simu)) class OpenFoamSimu(object): - """Class to load all data saved at timeStep of an openFoam simulation + """ + Class to load all data saved at timeStep of an openFoam simulation Args: - path : str, reference path where simulations are stored. You may want to - provide path if all your simulations are located inside path and - subfolders of path. You can do it by modifying in the __init__ - path='/path/to/the/simulations/'\n - simu : str, name of the simu that has to be loaded. If None, it will - lists all existing simulation names in path and ask you to choose\n - timeStep : str, timeStep to load. If None, load the last time step\n - structured : bool, true if the mesh is structured - - """ + path: str, reference path where simulations are stored.\n + You may want to provide path if all your simulations are located + inside path and subfolders of path. You can do it by modifying + in the __init__ path='/path/to/the/simulations/'\n + simu: str, name of the simu that has to be loaded.\n + If simu=None, it will lists all existing simulation names in path + and ask you to choose.\n + timeStep: str, timeStep to load. If None, load the last time step\n + structured: bool, true if the mesh is structured + """ def __init__(self, path, simu=None, timeStep=None, structured=False):