Skip to content

Commit

Permalink
minor doc correction
Browse files Browse the repository at this point in the history
  • Loading branch information
CyrilleBonamy committed Dec 15, 2021
1 parent 76571ba commit dbf14a4
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions fluidfoam/openfoamsimu.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down

0 comments on commit dbf14a4

Please sign in to comment.