feat(par): add Newton underrelaxation convergence check for parallel (#…

…1296)

* feat(par): add Newton underrelaxation convergence check for parallel

* call base method

src/Solution/NumericalSolution.f90

@@ -160,6 +160,7 @@ module NumericalSolutionModule
 
     ! 'protected' (this can be overridden)
     procedure :: sln_has_converged
+    procedure :: sln_nur_has_converged
     procedure :: sln_calc_ptc
     procedure :: sln_underrelax
 
@@ -1526,7 +1527,7 @@ subroutine solve(this, kiter)
     integer(I4B) :: ipos0
     integer(I4B) :: ipos1
     real(DP) :: dxmax_nur
-    real(DP) :: dxmax
+    real(DP) :: dxold_max
     real(DP) :: ptcf
     real(DP) :: ttform
     real(DP) :: ttsoln
@@ -1754,12 +1755,12 @@ subroutine solve(this, kiter)
         !
         ! -- calculate maximum change in heads in cells that have
         !    not been adjusted by newton under-relxation
-        call this%sln_maxval(this%neq, this%dxold, dxmax)
+        call this%sln_maxval(this%neq, this%dxold, dxold_max)
         !
         ! -- evaluate convergence
-        if (abs(dxmax) <= this%dvclose .and. &
-            abs(this%hncg(kiter)) <= this%dvclose .and. &
-            abs(dpak) <= this%dvclose) then
+        if (this%sln_nur_has_converged(dxold_max, this%hncg(kiter), dpak)) then
+          !
+          ! -- converged
           this%icnvg = 1
           !
           ! -- reset outer dependent-variable change and location for output
@@ -3139,6 +3140,25 @@ function sln_has_converged(this, max_dvc) result(has_converged)
 
   end function sln_has_converged
 
+  !> @brief Custom convergence check for when Newton UR has been applied
+  !<
+  function sln_nur_has_converged(this, dxold_max, hncg, dpak) &
+    result(has_converged)
+    class(NumericalSolutionType) :: this !< NumericalSolutionType instance
+    real(DP) :: dxold_max !< the maximum dependent variable change for unrelaxed cells
+    real(DP) :: hncg !< largest dep. var. change at end of Picard iteration
+    real(DP) :: dpak !< largest change in advanced packages
+    logical(LGP) :: has_converged !< True, when converged
+
+    has_converged = .false.
+    if (abs(dxold_max) <= this%dvclose .and. &
+        abs(hncg) <= this%dvclose .and. &
+        abs(dpak) <= this%dvclose) then
+      has_converged = .true.
+    end if
+
+  end function sln_nur_has_converged
+
   !> @ brief Get cell location string
   !!
   !!  Get the cell location string for the provided solution node number.

src/Solution/ParallelSolution.f90

@@ -13,6 +13,7 @@ module ParallelSolutionModule
   contains
     ! override
     procedure :: sln_has_converged => par_has_converged
+    procedure :: sln_nur_has_converged => par_nur_has_converged
     procedure :: sln_calc_ptc => par_calc_ptc
     procedure :: sln_underrelax => par_underrelax
   end type ParallelSolutionType
@@ -44,6 +45,33 @@ function par_has_converged(this, max_dvc) result(has_converged)
 
   end function par_has_converged
 
+  function par_nur_has_converged(this, dxold_max, hncg, dpak) &
+    result(has_converged)
+    class(ParallelSolutionType) :: this !< parallel solution instance
+    real(DP) :: dxold_max !< the maximum dependent variable change for cells not adjusted by NUR
+    real(DP) :: hncg !< largest dep. var. change at end of Picard iter.
+    real(DP) :: dpak !< largest change in advanced packages
+    logical(LGP) :: has_converged !< True, when converged
+    ! local
+    integer(I4B) :: icnvg_local, icnvg_global
+    integer :: ierr
+    type(MpiWorldType), pointer :: mpi_world
+
+    has_converged = .false.
+
+    icnvg_local = 0
+    if (this%NumericalSolutionType%sln_nur_has_converged( &
+        dxold_max, hncg, dpak)) then
+      icnvg_local = 1
+    end if
+
+    call MPI_Allreduce(icnvg_local, icnvg_global, 1, MPI_INTEGER, &
+                       MPI_MIN, mpi_world%comm, ierr)
+
+    has_converged = (icnvg_global == 1)
+
+  end function par_nur_has_converged
+
   !> @brief Calculate pseudo-transient continuation factor
   !< for the parallel case
   subroutine par_calc_ptc(this, iptc, ptcf)