add save_stats flag (#65)

Author: alemelis

Project.toml

@@ -1,7 +1,7 @@
 name = "openBF"
 uuid = "e815b1a4-10eb-11ea-25f1-272ff651e618"
 authors = ["alessandro <alessandro_melis@rocketmail.com>"]
-version = "2.2.0"
+version = "2.3.0"
 
 [deps]
 ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"

docs/src/man/quickstart.md

@@ -18,6 +18,7 @@ run_simulation(
         yaml_config_path::String;
         verbose::Bool = false,         # show progress bars
         out_files::Bool = false,       # save .out files with the all the cycles
+        save_stats::Bool = false,      # save .conv file with simulation stats
         )
 ```
 
@@ -27,7 +28,7 @@ Running a simulation consists in calling
 
 ```julia
 using openBF
-run_simulation("input.yml", verbose=true)
+run_simulation("input.yml", verbose=true, save_stats=true)
 ```
 
 This will create a `<project_name>_results` folder containing all the output files from the simulation.
@@ -40,6 +41,16 @@ By default only `.last` files are saved. Thes contains only the _last_ simulated
 
 You can also set `out_files = true` when calling `run_simulation`. This results in the writing of `.out` files which contain the _whole_ simulation history, i.e., all the cardiac cycles simulated.
 
-### Format
+When setting `save_stats=true`, a `<project_name>.conv` file is written in the results dolder. This reads
+
+```
+<has the simulation converged> # boolean: true or false
+<elapsed cardiac cycles> # integer
+<elapsed time> # float, seconds
+<memory allocated> # integer, bytes
+<garbace collection % time> # float, percentage
+```
+
+### `.last`/`.out` Format
 
 These files contain as many rows as defined in the config by the `jump` parameter (default `100`), and 6 columns. The first column contains the simulation time for the current cardiac cycles; column 2-6 report waveforms at five locations along the vessel, namely _inlet_, _1/4th_ of the length, _mid-point_, _3/4th_ of the length and _outlet_.

src/simulation.jl

@@ -88,6 +88,7 @@ function run_simulation(
     yaml_config::String;
     verbose::Bool = true,
     out_files::Bool = false,
+    save_stats::Bool = false,
 )
     initial_dir = pwd()
     config = preamble(yaml_config, verbose)
@@ -117,7 +118,8 @@ function run_simulation(
     prog = getprog(passed_cycles, verbose)
     counter = 1
     conv_error = floatmax()
-    @time while true
+    converged = false
+    stats = @timed while true
 
         # step
         dt = calculate_Δt(network)
@@ -166,12 +168,17 @@ function run_simulation(
            passed_cycles == config["solver"]["cycles"] ||
            conv_error < config["solver"]["convergence_tolerance"]
             verbose && finish!(prog)
+            converged = true
             break
         end
         current_time += dt
     end
     tokeep = get(config, "write_results", [])
     cleanup.(values(network.vessels), Ref(tokeep))
+
+    verbose && printstats(stats, converged, passed_cycles)
+    save_stats && savestats(stats, converged, passed_cycles, config["project_name"])
+
     cd(initial_dir)
 end
 
@@ -181,3 +188,25 @@ function cleanup(v::Vessel, tokeep)
         l ∉ tokeep && rm.(glob("$(v.label)_$l.*"), force=true)
     end
 end
+
+function printstats(s, converged, passed_cycles)
+    if converged
+        println("Simulation converged after $passed_cycles cardiac cycles")
+    else
+        println("Simulation not converged, stopping after $passed_cycles cardiac cycles")
+    end
+    @printf "Elapsed time: %5.2fs\n" s.time
+    @printf "Memory: %5.2fGB\n" s.bytes*1e-9
+    gctime = @sprintf "GC time: %5.2f" s.gctime
+    println("$(gctime)%")
+end
+
+function savestats(s, converged, passed_cycles, simulation_name)
+    open("$simulation_name.conv", "w") do io
+        println(io, "$converged")
+        println(io, "$passed_cycles")
+        println(io, "$(s.time)")
+        println(io, "$(s.bytes)")
+        println(io, "$(s.gctime)")
+    end
+end