convergencesummarymodule Module Reference

Data Types
type	convergencesummarytype
	This structure stores the generic convergence info for a solution. More...

Functions/Subroutines
subroutine	init (this, nr_models, model_bounds, mem_path)
	Initialize the convergence summary for a solution. More...
subroutine	reinit (this, niter_max)
subroutine	set_defaults (this)
subroutine	destroy (this)
	Cleanup. More...

Function/Subroutine Documentation

destroy()

subroutine convergencesummarymodule::destroy ( class(convergencesummarytype)  this )

private

Definition at line 117 of file ConvergenceSummary.f90.

    class(ConvergenceSummaryType) :: this
 
    ! scalars
    call mem_deallocate(this%convnmod)
    call mem_deallocate(this%nitermax)
 
    call mem_deallocate(this%locr)
    call mem_deallocate(this%rmax)
    call mem_deallocate(this%locdv)
    call mem_deallocate(this%dvmax)
 
    ! arrays
    call mem_deallocate(this%itinner)
    call mem_deallocate(this%convdvmax)
    call mem_deallocate(this%convlocdv)
    call mem_deallocate(this%convrmax)
    call mem_deallocate(this%convlocr)
 

init()

subroutine convergencesummarymodule::init ( class(convergencesummarytype)  this, integer(i4b)  nr_models, integer(i4b), dimension(:), pointer  model_bounds, character(len=*)  mem_path  )

private

Parameters

nr_models	the number of models in the solution
model_bounds	the start and stop index of the models
mem_path	the memory path of the owning solution

Definition at line 39 of file ConvergenceSummary.f90.

    class(ConvergenceSummaryType) :: this
    integer(I4B) :: nr_models !< the number of models in the solution
    integer(I4B), dimension(:), pointer :: model_bounds !< the start and stop index of the models
    character(len=*) :: mem_path !< the memory path of the owning solution
 
    this%memory_path = 'TMP'//mem_path
    this%iter_cnt = 0
    this%model_bounds => model_bounds
 
    call mem_allocate(this%convnmod, 'CONVNMOD', this%memory_path)
    call mem_allocate(this%nitermax, 'NITERMAX', this%memory_path)
    this%convnmod = nr_models
    this%nitermax = 0
 
    call mem_allocate(this%itinner, 0, 'ITINNER', this%memory_path)
    call mem_allocate(this%locdv, this%convnmod, 'LOCDV', this%memory_path)
    call mem_allocate(this%dvmax, this%convnmod, 'DVMAX', this%memory_path)
    call mem_allocate(this%locr, this%convnmod, 'LOCDR', this%memory_path)
    call mem_allocate(this%rmax, this%convnmod, 'DRMAX', this%memory_path)
    call mem_allocate(this%convdvmax, this%convnmod, 0, 'CONVDVMAX', &
                      this%memory_path)
    call mem_allocate(this%convlocdv, this%convnmod, 0, 'CONVLOCDV', &
                      this%memory_path)
    call mem_allocate(this%convrmax, this%convnmod, 0, 'CONVDRMAX', &
                      this%memory_path)
    call mem_allocate(this%convlocr, this%convnmod, 0, 'CONVLOCDR', &
                      this%memory_path)
 
    call this%set_defaults()
 

reinit()

subroutine convergencesummarymodule::reinit ( class(convergencesummarytype)  this, integer(i4b)  niter_max  )

private

Parameters

niter_max

max. nr. of iterations in a timestep

Definition at line 72 of file ConvergenceSummary.f90.

    class(ConvergenceSummaryType) :: this
    integer(I4B) :: niter_max !< max. nr. of iterations in a timestep
 
    this%nitermax = niter_max
    call mem_reallocate(this%itinner, niter_max, 'ITINNER', this%memory_path)
    call mem_reallocate(this%convdvmax, this%convnmod, niter_max, 'CONVDVMAX', &
                        this%memory_path)
    call mem_reallocate(this%convlocdv, this%convnmod, niter_max, 'CONVLOCDV', &
                        this%memory_path)
    call mem_reallocate(this%convrmax, this%convnmod, niter_max, 'CONVDRMAX', &
                        this%memory_path)
    call mem_reallocate(this%convlocr, this%convnmod, niter_max, 'CONVLOCDR', &
                        this%memory_path)
 
    call this%set_defaults()
 

set_defaults()

subroutine convergencesummarymodule::set_defaults ( class(convergencesummarytype)  this )

private

Definition at line 91 of file ConvergenceSummary.f90.

    class(ConvergenceSummaryType) :: this
    ! local
    integer(I4B) :: i, j
 
    do i = 1, this%convnmod
      this%locr(i) = 0
      this%dvmax(i) = dzero
      this%locdv(i) = 0
      this%rmax(i) = dzero
    end do
 
    do i = 1, this%nitermax
      this%itinner(i) = 0
      do j = 1, this%convnmod
        this%convdvmax(j, i) = dzero
        this%convlocdv(j, i) = 0
        this%convrmax(j, i) = dzero
        this%convlocr(j, i) = 0
      end do
    end do