MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
convergencesummarymodule::convergencesummarytype Type Reference

This structure stores the generic convergence info for a solution. More...

Collaboration diagram for convergencesummarymodule::convergencesummarytype:
Collaboration graph

Public Member Functions

procedure init (this, nr_models, model_bounds, mem_path)
 Initialize the convergence summary for a solution.
procedure reinit (this, niter_max)
procedure destroy (this)
 Cleanup.

Public Attributes

character(len=lenmempath) memory_path
 the path for storing solution variables in the memory manager
integer(i4b) iter_cnt
 tracks the iteration number within the timestep
integer(i4b), pointer convnmod => null()
 number of models in the solution
integer(i4b), dimension(:), pointer model_bounds => null()
 the start and stop index of the models in the solution
integer(i4b), pointer nitermax => null()
 max. nr. of iterations in a timestep
integer(i4b), dimension(:), pointer, contiguous itinner => null()
 inner iteration number within each picard iteration
integer(i4b), dimension(:), pointer, contiguous locdv => null()
 location of the maximum dependent-variable change in the solution
real(dp), dimension(:), pointer, contiguous dvmax => null()
 maximum dependent-variable change in the solution
integer(i4b), dimension(:), pointer, contiguous locr => null()
 location of the maximum flow change in the solution
real(dp), dimension(:), pointer, contiguous rmax => null()
 maximum flow change in the solution
integer(i4b), dimension(:, :), pointer, contiguous convlocdv => null()
 location of the maximum dependent-variable change in each model in the solution
real(dp), dimension(:, :), pointer, contiguous convdvmax => null()
 maximum dependent-variable change for each model in the solution
integer(i4b), dimension(:, :), pointer, contiguous convlocr => null()
 location of the maximum flow change in each model in the solution
real(dp), dimension(:, :), pointer, contiguous convrmax => null()
 maximum flow change in each model in the solution

Private Member Functions

procedure, private set_defaults (this)

Detailed Description

Definition at line 13 of file ConvergenceSummary.f90.

Member Function/Subroutine Documentation

◆ destroy()

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

Definition at line 31 of file ConvergenceSummary.f90.

◆ init()

procedure convergencesummarymodule::convergencesummarytype::init ( class(convergencesummarytype) this,
integer(i4b) nr_models,
integer(i4b), dimension(:), pointer model_bounds,
character(len=*) mem_path )
Parameters
nr_modelsthe number of models in the solution
model_boundsthe start and stop index of the models
mem_paththe memory path of the owning solution

Definition at line 29 of file ConvergenceSummary.f90.

◆ reinit()

procedure convergencesummarymodule::convergencesummarytype::reinit ( class(convergencesummarytype) this,
integer(i4b) niter_max )
Parameters
niter_maxmax. nr. of iterations in a timestep

Definition at line 30 of file ConvergenceSummary.f90.

◆ set_defaults()

procedure, private convergencesummarymodule::convergencesummarytype::set_defaults ( class(convergencesummarytype) this)
private

Definition at line 33 of file ConvergenceSummary.f90.

Member Data Documentation

◆ convdvmax

real(dp), dimension(:, :), pointer, contiguous convergencesummarymodule::convergencesummarytype::convdvmax => null()

Definition at line 25 of file ConvergenceSummary.f90.

◆ convlocdv

integer(i4b), dimension(:, :), pointer, contiguous convergencesummarymodule::convergencesummarytype::convlocdv => null()

Definition at line 24 of file ConvergenceSummary.f90.

◆ convlocr

integer(i4b), dimension(:, :), pointer, contiguous convergencesummarymodule::convergencesummarytype::convlocr => null()

Definition at line 26 of file ConvergenceSummary.f90.

◆ convnmod

integer(i4b), pointer convergencesummarymodule::convergencesummarytype::convnmod => null()

Definition at line 16 of file ConvergenceSummary.f90.

◆ convrmax

real(dp), dimension(:, :), pointer, contiguous convergencesummarymodule::convergencesummarytype::convrmax => null()

Definition at line 27 of file ConvergenceSummary.f90.

◆ dvmax

real(dp), dimension(:), pointer, contiguous convergencesummarymodule::convergencesummarytype::dvmax => null()

Definition at line 21 of file ConvergenceSummary.f90.

◆ iter_cnt

integer(i4b) convergencesummarymodule::convergencesummarytype::iter_cnt

Definition at line 15 of file ConvergenceSummary.f90.

15 integer(I4B) :: iter_cnt !< tracks the iteration number within the timestep

◆ itinner

integer(i4b), dimension(:), pointer, contiguous convergencesummarymodule::convergencesummarytype::itinner => null()

Definition at line 19 of file ConvergenceSummary.f90.

◆ locdv

integer(i4b), dimension(:), pointer, contiguous convergencesummarymodule::convergencesummarytype::locdv => null()

Definition at line 20 of file ConvergenceSummary.f90.

◆ locr

integer(i4b), dimension(:), pointer, contiguous convergencesummarymodule::convergencesummarytype::locr => null()

Definition at line 22 of file ConvergenceSummary.f90.

◆ memory_path

character(len=lenmempath) convergencesummarymodule::convergencesummarytype::memory_path

Definition at line 14 of file ConvergenceSummary.f90.

14 character(len=LENMEMPATH) :: memory_path !< the path for storing solution variables in the memory manager

◆ model_bounds

integer(i4b), dimension(:), pointer convergencesummarymodule::convergencesummarytype::model_bounds => null()

Definition at line 17 of file ConvergenceSummary.f90.

◆ nitermax

integer(i4b), pointer convergencesummarymodule::convergencesummarytype::nitermax => null()

Definition at line 18 of file ConvergenceSummary.f90.

◆ rmax

real(dp), dimension(:), pointer, contiguous convergencesummarymodule::convergencesummarytype::rmax => null()

Definition at line 23 of file ConvergenceSummary.f90.


The documentation for this type was generated from the following file: