Document function (just to get started with git)

sintefmath · Feb 19, 2024 · de6710b · de6710b
1 parent be9e227
commit de6710b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/timesteps.jl b/src/timesteps.jl
@@ -58,6 +58,13 @@ struct IterationTimestepSelector <: AbstractTimestepSelector
     end
 end
 
+"""
+    pick_next_timestep(sel::IterationTimestepSelector, sim, config, dt_prev, dT, forces, reports, current_reports, step_index, new_step)
+
+Pick the next time-step for `IterationTimestepSelector`. This function uses the
+number of iterations from previous timesteps to estimate the relationship
+between the last and the new time step.
+"""
 function pick_next_timestep(sel::IterationTimestepSelector, sim, config, dt_prev, dT, forces, reports, current_reports, step_index, new_step)
     R = successful_reports(reports, current_reports, step_index, 2)
     if length(R) == 0