From 9c319e94ad0c6e2f221a15d795e796e9fc674d2d Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <matthieu.schaller@durham.ac.uk>
Date: Wed, 26 Oct 2016 16:04:01 +0200
Subject: [PATCH] Added documentation of new potential to the main YAML example
 file.

---
 examples/parameter_example.yml | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/examples/parameter_example.yml b/examples/parameter_example.yml
index fb193a81ba..aee868f216 100644
--- a/examples/parameter_example.yml
+++ b/examples/parameter_example.yml
@@ -76,12 +76,21 @@ PointMassPotential:
 
 # Isothermal potential parameters
 IsothermalPotential:
-  position_x:      100.     # Location of centre of isothermal potential (internal units)
+  position_x:      100.     # Location of centre of isothermal potential with respect to centre of the box (internal units)
   position_y:      100.
   position_z:      100.
   vrot:            200.     # Rotation speed of isothermal potential (internal units)
   timestep_mult:   0.03     # Dimensionless pre-factor for the time-step condition
 
+# External potential parameters
+SoftenedIsothermalPotential:
+  position_x:      0.       # Location of centre of isothermal potential with respect to centre of the box (internal units)
+  position_y:      0.
+  position_z:      0.	
+  vrot:            200.     # rotation speed of isothermal potential (internal units)
+  epsilon:         0.1      # Softening size (internal units)
+  timestep_mult:   0.03     # controls time step
+  
 # Disk-patch potential parameters
 DiscPatchPotential:
   surface_density: 10.      # Surface density of the disc (internal units)
-- 
GitLab