Merge pull request #160 from milankl/return_time

return time instead of progn vars

Author: milankl

src/default_parameters.jl

@@ -108,6 +108,7 @@
     output_dt::Real=24                  # output time step [hours]
     outpath::String=pwd()               # path to output folder
     compression_level::Int=3            # compression level
+    return_time::Bool=false             # return time of simulation of progn vars?
 
     # INITIAL CONDITIONS
     initial_cond::String="rest"         # "rest" or "ncfile" for restart from file

src/feedback.jl

@@ -1,6 +1,7 @@
 @with_kw mutable struct Feedback
     t0::Float64=time()                      # start time
     t1::Float64=time()                      # time for duration estimation
+    tend::Float64=t0                        # end time
     nans_detected::Bool=false               # did NaNs occur in the simulation?
     progress_txt::Union{IOStream,Nothing}   # txt is a Nothing in case of no output
     output::Bool                            # output to netCDF?
@@ -161,7 +162,11 @@ end
 function feedback_end!(feedback::Feedback)
     @unpack output,t0,progress_txt = feedback
 
-    s = " Integration done in "*readable_secs(time()-t0)*"."
+    # time when the simulation ends
+    tend = time()
+    feedback.tend = tend  # store in struct
+
+    s = " Integration done in "*readable_secs(tend-t0)*"."
     println(s)
     if output
         write(progress_txt,"\n"*s[2:end]*"\n")  # close txt file with last output

src/time_integration.jl

@@ -292,7 +292,11 @@ function time_integration(  Prog::PrognosticVars{Tprog},
     feedback_end!(feedback)
     output_close!(netCDFfiles,feedback,S)
 
-    return PrognosticVars{Tprog}(remove_halo(u,v,η,sst,S)...)
+    if S.parameters.return_time
+        return feedback.tend - feedback.t0
+    else
+        return PrognosticVars{Tprog}(remove_halo(u,v,η,sst,S)...)
+    end
 end
 
 """Add to a x multiplied with b. a += x*b """