docs: add FSM configuration methods to python type stubs and documentation

This commit is contained in:
Antoine Anceau committed 2026-02-09 18:41:38 +01:00
1 parent 8a32e3b669
commit 5ecd1fb91a
2 files changed
+30

No files matched your search

+15
View File
@@ -99,6 +99,21 @@ Tank
Longitudinal free surface moment (m⁴).
**FSM Configuration**
.. py:attribute:: fsm_mode
:type: str
Current FSM calculation mode ('actual', 'maximum', 'fixed').
.. py:method:: set_fsm_mode(mode, t=None, l=None)
Sets the free surface moment calculation mode.
:param mode: Mode string ('actual', 'maximum', 'fixed')
:param t: Transverse FSM (m^4), required if mode is 'fixed'
:param l: Longitudinal FSM (m^4), required if mode is 'fixed'
**Geometry**
.. py:method:: get_vertices()