cleanup tidymess interface.py

Author: elkogerville

src/amuse_tidymess/interface.py

@@ -1,18 +1,15 @@
-"""
-TIdal DYnamics of Multi-body ExtraSolar Systems Interface
-Code Author : Tjarda Boekholt & Alexandre Correia (MNRAS 2023, vol. 522, pp. 2885–2900)
-Interface Author : Elko Gerville-Reache
-
-Date Created : Nov 25, 2025
-Last Updated : May 13, 2026
-"""
-
-from amuse.community.interface.gd import GravitationalDynamics
-from amuse.community.interface.gd import GravitationalDynamicsInterface
-from amuse.community.interface.gd import GravityFieldInterface
-from amuse.community.interface.gd import GravityFieldCode
-from amuse.community.interface.stopping_conditions import StoppingConditions, StoppingConditionInterface
-from amuse.rfi.core import CodeInterface, legacy_function, LegacyFunctionSpecification
+from amuse.community.interface.gd import (
+    GravitationalDynamics,
+    GravitationalDynamicsInterface,
+    GravityFieldInterface,
+    GravityFieldCode
+)
+from amuse.community.interface.stopping_conditions import (
+    StoppingConditions, StoppingConditionInterface
+)
+from amuse.rfi.core import (
+    CodeInterface, legacy_function, LegacyFunctionSpecification
+)
 from amuse.support.literature import LiteratureReferencesMixIn
 from amuse.units import units as u, nbody_system
 
@@ -1019,42 +1016,47 @@ def set_n_iter():
         return function
 
     @legacy_function
-    def set_collision_mode():
-        '''
-        '''
+    def get_collision_mode():
+        """Get collision mode Tidymess parameter."""
         function = LegacyFunctionSpecification()
         function.addParameter(
             'collision_mode',
             dtype='int32',
-            direction=function.IN,
-            description='0=off, 1=flag, 2=exception, 3=replace'
-        )
+            direction=function.OUT,
+            description='0=off, 1=flag, 2=exception, 3=replace')
         function.result_type = 'int32'
-        function.result_doc = ''''''
+        function.result_doc = """\
+        0 - OK
+            collision mode was retrieved
+        -1 - ERROR
+            Could not find collision mode
+        """
 
         return function
 
-
     @legacy_function
-    def get_collision_mode():
-        '''
-        '''
+    def set_collision_mode():
+        """Set collision mode Tidymess parameter."""
         function = LegacyFunctionSpecification()
         function.addParameter(
             'collision_mode',
             dtype='int32',
-            direction=function.OUT,
-            description='0=off, 1=flag, 2=exception, 3=replace')
+            direction=function.IN,
+            description='0=off, 1=flag, 2=exception, 3=replace'
+        )
         function.result_type = 'int32'
-        function.result_doc = ''''''
+        function.result_doc = """\
+        0 - OK
+            collision mode was set
+        -1 - ERROR
+            Could not set collision mode
+        """
 
         return function
 
-
     @legacy_function
     def set_roche_mode():
-        '''
-        '''
+        """Set roche mode."""
         function = LegacyFunctionSpecification()
         function.addParameter(
             'roche_mode',
@@ -1063,15 +1065,18 @@ def set_roche_mode():
             description='0=off, 1=flag, 2=exception'
         )
         function.result_type = 'int32'
-        function.result_doc = ''''''
+        function.result_doc = """\
+        0 - OK
+            Roche mode was set
+        -1 - ERROR
+            Could not set roche mode
+        """
 
         return function
 
-
     @legacy_function
     def get_roche_mode():
-        """
-        """
+        """Get roche mode."""
         function = LegacyFunctionSpecification()
         function.addParameter(
             'roche_mode',
@@ -1080,11 +1085,15 @@ def get_roche_mode():
             description='0=off, 1=flag, 2=exception'
         )
         function.result_type = 'int32'
-        function.result_doc = ''''''
+        function.result_doc = """\
+        0 - OK
+            roche mode was retrieved
+        -1 - ERROR
+            Could not retrieve roche mode
+        """
 
         return function
 
-
     @legacy_function
     def set_breakup_mode():
         """
@@ -1104,7 +1113,6 @@ def set_breakup_mode():
 
         return function
 
-
     @legacy_function
     def get_breakup_mode():
         """
@@ -1125,36 +1133,42 @@ def get_breakup_mode():
         return function
 
     @legacy_function
-    def set_initial_shape():
-        """
-        Set Tidymess initial shape.
-        """
+    def get_initial_shape():
+        """Get Tidymess initial shape value."""
         function = LegacyFunctionSpecification()
         function.addParameter(
             'initial_shape',
             dtype='int32',
-            direction=function.IN,
-            description='0=default'
+            direction=function.OUT,
+            description='0=sphere, 1=equilibrium'
         )
         function.result_type = 'int32'
-        function.result_doc = """"""
+        function.result_doc = """\
+        0 - OK
+            Initial shape was retrieved
+        -1 - ERROR
+            Could not retrieve initial shape
+        """
 
         return function
 
     @legacy_function
-    def get_initial_shape():
-        """
-        Get Tidymess initial shape value.
-        """
+    def set_initial_shape():
+        """Set Tidymess initial shape."""
         function = LegacyFunctionSpecification()
         function.addParameter(
             'initial_shape',
             dtype='int32',
-            direction=function.OUT,
-            description=''
+            direction=function.IN,
+            description='0=sphere, 1=equilibrium'
         )
         function.result_type = 'int32'
-        function.result_doc = """"""
+        function.result_doc = """\
+        0 - OK
+            Initial shape was set
+        -1 - ERROR
+            Could not set initial shape
+        """
 
         return function
 
@@ -1259,6 +1273,7 @@ def __init__(self, convert_nbody=None, **options):
             **options
         )
 
+
     def define_state(self, handler):
         GravitationalDynamics.define_state(self, handler)
         GravityFieldCode.define_state(self, handler)
@@ -1269,12 +1284,12 @@ def define_state(self, handler):
 
         self.stopping_conditions.define_state(handler)
 
+
     def define_methods(self, handler):
         """
         Map legacy functions in TidymessInterface into
         Tidymess user methods.
         """
-
         GravitationalDynamics.define_methods(self, handler)
 
         handler.add_method(
@@ -1564,11 +1579,13 @@ def define_parameters(self, handler):
 
         self.stopping_conditions.define_parameters(handler)
 
+
     def define_properties(self, handler):
         """Define read only properties of Tidymess"""
         GravitationalDynamics.define_properties(self, handler)
         handler.add_property('get_total_energy', public_name='total_energy')
 
+
     def define_particle_sets(self, handler):
         GravitationalDynamics.define_particle_sets(self, handler)