Export processing function now takes reference results as arg

src/auxiliary/process_each_export.jl

@@ -1,6 +1,7 @@
 function process_each_export(f::F, vtk_path::AbstractString; kwargs...) where {F<:Function}
     o = Dict{Symbol,Any}(kwargs)
     check_kwargs(o, PROCESS_EACH_EXPORT_KWARGS)
+    check_process_function(f)
     serial = get_process_each_export_options(o)
     vtk_files = find_vtk_files(vtk_path)
     if serial
@@ -27,6 +28,20 @@ function get_process_each_export_options(o::Dict{Symbol,Any})
     return serial
 end
 
+function check_process_function(f::F) where {F<:Function}
+    func_method = get_method_of_function(f)
+    args = get_argument_names_of_function(func_method)
+    if length(args) != 3
+        msg = "wrong arguments for processing function!\n"
+        msg *= "The processing function needs 3 args:\n"
+        msg *= "  - ref_result::Dict{Symbol,VecOrMat}: results of the initial export\n"
+        msg *= "  - result::Dict{Symbol,VecOrMat}: results of the processed time step\n"
+        msg *= "  - file_id::Int: number / id of the processed export\n"
+        throw(ArgumentError(msg))
+    end
+    return nothing
+end
+
 function find_vtk_files(path::AbstractString)
     isdir(path) || throw(ArgumentError("invalid path $path specified!\n"))
     all_files = readdir(path; join=true)
@@ -35,49 +50,53 @@ function find_vtk_files(path::AbstractString)
     return pvtu_files
 end
 
-function process_step(f::F, file::AbstractString, file_id::Int) where {F<:Function}
+function process_step(f::F, ref_result::Dict{Symbol,T}, file::AbstractString,
+                      file_id::Int) where {F<:Function,T}
     result = read_vtk(file)
     try
-        f(result, file_id)
+        f(ref_result, result, file_id)
     catch err
         @error "something wrong while processing file $(basename(file))" error=err
     end
     return nothing
 end
 
 function process_each_export_serial(f::F, vtk_files::Vector{String}) where {F<:Function}
+    ref_result = read_vtk(first(vtk_files))
     p = Progress(length(vtk_files); dt=1, color=:normal, barlen=20,
                  enabled=progress_enabled())
     for (file_id, file) in enumerate(vtk_files)
-        process_step(f, file, file_id)
+        process_step(f, ref_result, file, file_id)
         next!(p)
     end
     finish!(p)
     return nothing
 end
 
 function process_each_export_threads(f::F, vtk_files::Vector{String}) where {F<:Function}
+    ref_result = read_vtk(first(vtk_files))
     p = Progress(length(vtk_files); dt=1, color=:normal, barlen=20,
                  enabled=progress_enabled())
     @threads for file_id in eachindex(vtk_files)
-        process_step(f, vtk_files[file_id], file_id)
+        process_step(f, ref_result, vtk_files[file_id], file_id)
         next!(p)
     end
     finish!(p)
     return nothing
 end
 
 function process_each_export_mpi(f::F, vtk_files::Vector{String}) where {F<:Function}
+    ref_result = read_vtk(first(vtk_files))
     file_dist = distribute_equally(length(vtk_files), mpi_nranks())
-    loc_file_ids = file_dist[mpi_rank()+1]
-    if mpi_rank() == 0
+    loc_file_ids = file_dist[mpi_chunk_id()]
+    if mpi_isroot()
         p = Progress(length(vtk_files); dt=1, color=:normal, barlen=20,
                      enabled=progress_enabled())
     end
     for file_id in loc_file_ids
-        process_step(f, vtk_files[file_id], file_id)
-        mpi_rank() == 0 && next!(p)
+        process_step(f, ref_result, vtk_files[file_id], file_id)
+        mpi_isroot() && next!(p)
     end
-    mpi_rank() == 0 && finish!(p)
+    mpi_isroot() && finish!(p)
     return nothing
 end

test/auxiliary/test_process_each_export.jl

@@ -19,11 +19,11 @@
     vv = VelocityVerlet(steps=2)
     job = Job(b1, vv; path=root, freq=1)
 
-    @test_throws ArgumentError process_each_export((r, id) -> nothing, job)
+    @test_throws ArgumentError process_each_export((r0, r, id) -> nothing, job)
 
     submit(job)
 
-    process_each_export(job) do result, file_id
+    process_each_export(job) do result0, result, file_id
         filename = string("max_displacement_", file_id, ".txt")
         open(joinpath(root_post_threads, filename), "w+") do io
             maxdisp = maximum(result[:displacement][1,:])
@@ -42,7 +42,7 @@
     @test isfile(file_3_threads)
     @test contains(read(file_3_threads, String), "maximum displacement x: 2.4")
 
-    process_each_export(job; serial=true) do result, file_id
+    process_each_export(job; serial=true) do result0, result, file_id
         filename = string("max_displacement_", file_id, ".txt")
         open(joinpath(root_post_serial, filename), "w+") do io
             msg = string("maximum displacement x: ", maximum(result[:displacement][1,:]))
@@ -63,7 +63,7 @@
     mpi_cmd = """
     using Peridynamics
     files = "$(joinpath(root, "vtk"))"
-    process_each_export(files) do result, file_id
+    process_each_export(files) do result0, result, file_id
         filename = string("max_displacement_", file_id, ".txt")
         open(joinpath("$(root_post_mpi)", filename), "w+") do io
             maxdisp = maximum(result[:displacement][1,:])