admin/navaltoolbox-lib
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Rename functions in HydrostaticsCalculator

Browse Source
This commit is contained in:
Antoine Anceau committed 2026-01-22 21:54:54 +01:00
1 parent 57a726c9c3
commit bba599d1e3
17 files changed
+222 -70
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/source/api/python/hydrostatics.rst
+2 -2
View File
@@ -13,7 +13,7 @@ HydrostaticsCalculator
:param vessel: The vessel to calculate hydrostatics for
:param water_density: Water density in kg/m³ (default: 1025.0 for seawater)
.. py:method:: calculate_at_draft(draft, trim=0.0, heel=0.0, vcg=None)
.. py:method:: from_draft(draft, trim=0.0, heel=0.0, vcg=None)
Calculates hydrostatics at a given draft, trim, and heel.
@@ -24,7 +24,7 @@ HydrostaticsCalculator
:type vcg: float or None
:returns: HydrostaticState with all properties
.. py:method:: calculate_at_displacement(displacement_mass, vcg=None, cog=None, trim=None, heel=None)
.. py:method:: from_displacement(displacement_mass, vcg=None, cog=None, trim=None, heel=None)
Calculates hydrostatics for a given displacement, finding the required draft.