Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
RHammond2 committed Nov 21, 2023
1 parent fc90d5c commit 77a0690
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions floris/simulation/turbine_multi_dim.py
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,15 @@ class TurbineMultiDimensional(Turbine):
the width/height of the grid of points on the rotor as a ratio of
the rotor radius.
Defaults to 0.5.
power_thrust_data_file (:py:obj:`str`): The path and name of the file containing the
multidimensional power thrust curve. The path may be an absolute location or a relative
path to where FLORIS is being run.
multi_dimensional_cp_ct (:py:obj:`bool`, optional): Indicates if the turbine definition is
single dimensional (False) or multidimensional (True).
turbine_library_path (:py:obj:`pathlib.Path`, optional): The
:py:attr:`Farm.turbine_library_path` or :py:attr:`Farm.internal_turbine_library_path`,
whichever is being used to load turbine definitions.
Defaults to the current file location.
"""
power_thrust_data_file: str = field(default=None)
multi_dimensional_cp_ct: bool = field(default=False)
Expand Down

0 comments on commit 77a0690

Please sign in to comment.