update docs

cselab · Jan 19, 2023 · f3fb1a9 · f3fb1a9
1 parent 2196411
commit f3fb1a9
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/docs/source/mmirheo/Plugins/__init__.py b/docs/source/mmirheo/Plugins/__init__.py
@@ -48,7 +48,10 @@ def createAddFourRollMillForce():
     pass
 
 def createAddPotentialForce():
-    r"""createAddPotentialForce(state: MirState, name: str, pv: ParticleVectors.ParticleVector, potential_field: Callable[[real3], float], h: real3) -> Tuple[Plugins.SimulationPlugin, Plugins.PostprocessPlugin]
+    r"""createAddPotentialForce(*args, **kwargs)
+Overloaded function.
+
+1. createAddPotentialForce(state: MirState, name: str, pv: ParticleVectors.ParticleVector, potential_field: Callable[[real3], float], h: real3) -> Tuple[Plugins.SimulationPlugin, Plugins.PostprocessPlugin]
 
 
         Add a force :math:`\mathbf{F}_{extra}` to each particle of a specific PV every time-step.
@@ -61,6 +64,19 @@ def createAddPotentialForce():
             h: grid spacing used to discretize the potential field
     
 
+2. createAddPotentialForce(state: MirState, name: str, pv: ParticleVectors.ParticleVector, potential_field_filename: str, h: real3) -> Tuple[Plugins.SimulationPlugin, Plugins.PostprocessPlugin]
+
+
+        Add a force :math:`\mathbf{F}_{extra}` to each particle of a specific PV every time-step.
+        The force is the negative gradient of a potential field at the particle position.
+
+        Args:
+            name: name of the plugin
+            pv: :any:`ParticleVector` that we'll work with
+            potential_field_filename: file that contains the potential field on a cartesian grid. Same format as Sdf for walls.
+            h: grid spacing used to discretize the potential field
+    
+
     """
     pass