Merge pull request #188 from OpenTerrace/development

Development
OpenTerrace · May 30, 2024 · e821e69 · e821e69
2 parents f3386e0 + 5a26dc9
commit e821e69
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/openterrace/openterrace.py b/openterrace/openterrace.py
@@ -72,7 +72,8 @@ def _coupling(self):
             self.Phase.instances[couple['fluid_phase']].h[0] = self.Phase.instances[couple['fluid_phase']].h[0] - n_bed * Q/(self.Phase.instances[couple['fluid_phase']].rho*self.Phase.instances[couple['fluid_phase']].domain.V) #ok
 
     def run_simulation(self):
-        """This is the function full of magic."""
+        """If you want to run the simulation, you need to call this function. If data output is specified using the select_output function, the data will live in that specific phase instance. For more details on how to access the data, please refer to the tutorials."""
+
 
         for t in tqdm.tqdm(np.arange(self.t_start, self.t_end+self.dt, self.dt)):