MODFLOW 6  version 6.6.0.dev0
USGS Modular Hydrologic Model
Private Member Functions | Private Attributes | List of all members
convergencesummarymodule::convergencesummarytype Type Reference

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

Collaboration diagram for convergencesummarymodule::convergencesummarytype:
Collaboration graph

Private Member Functions

procedure init
 
procedure reinit
 
procedure destroy
 
procedure, private set_defaults
 

Private Attributes

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

Detailed Description

Definition at line 13 of file ConvergenceSummary.f90.

Member Function/Subroutine Documentation

◆ destroy()

procedure convergencesummarymodule::convergencesummarytype::destroy
private

Definition at line 31 of file ConvergenceSummary.f90.

◆ init()

procedure convergencesummarymodule::convergencesummarytype::init
private

Definition at line 29 of file ConvergenceSummary.f90.

◆ reinit()

procedure convergencesummarymodule::convergencesummarytype::reinit
private

Definition at line 30 of file ConvergenceSummary.f90.

◆ set_defaults()

procedure, private convergencesummarymodule::convergencesummarytype::set_defaults
private

Definition at line 33 of file ConvergenceSummary.f90.

Member Data Documentation

◆ convdvmax

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

Definition at line 25 of file ConvergenceSummary.f90.

25  real(DP), pointer, dimension(:, :), contiguous :: convdvmax => null() !< maximum dependent-variable change for each model in the solution

◆ convlocdv

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

Definition at line 24 of file ConvergenceSummary.f90.

24  integer(I4B), pointer, dimension(:, :), contiguous :: convlocdv => null() !< location of the maximum dependent-variable change in each model in the solution

◆ convlocr

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

Definition at line 26 of file ConvergenceSummary.f90.

26  integer(I4B), pointer, dimension(:, :), contiguous :: convlocr => null() !< location of the maximum flow change in each model in the solution

◆ convnmod

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

Definition at line 16 of file ConvergenceSummary.f90.

16  integer(I4B), pointer :: convnmod => null() !< number of models in the solution

◆ convrmax

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

Definition at line 27 of file ConvergenceSummary.f90.

27  real(DP), pointer, dimension(:, :), contiguous :: convrmax => null() !< maximum flow change in each model in the solution

◆ dvmax

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

Definition at line 21 of file ConvergenceSummary.f90.

21  real(DP), dimension(:), pointer, contiguous :: dvmax => null() !< maximum dependent-variable change in the solution

◆ iter_cnt

integer(i4b) convergencesummarymodule::convergencesummarytype::iter_cnt
private

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()
private

Definition at line 19 of file ConvergenceSummary.f90.

19  integer(I4B), dimension(:), pointer, contiguous :: itinner => null() !< inner iteration number within each picard iteration

◆ locdv

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

Definition at line 20 of file ConvergenceSummary.f90.

20  integer(I4B), dimension(:), pointer, contiguous :: locdv => null() !< location of the maximum dependent-variable change in the solution

◆ locr

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

Definition at line 22 of file ConvergenceSummary.f90.

22  integer(I4B), dimension(:), pointer, contiguous :: locr => null() !< location of the maximum flow change in the solution

◆ memory_path

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

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()
private

Definition at line 17 of file ConvergenceSummary.f90.

17  integer(I4B), dimension(:), pointer :: model_bounds => null() !< the start and stop index of the models in the solution

◆ nitermax

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

Definition at line 18 of file ConvergenceSummary.f90.

18  integer(I4B), pointer :: nitermax => null() !< max. nr. of iterations in a timestep

◆ rmax

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

Definition at line 23 of file ConvergenceSummary.f90.

23  real(DP), dimension(:), pointer, contiguous :: rmax => null() !< maximum flow change in the solution
The documentation for this type was generated from the following file: