MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
petscconvergencemodule::petsccnvgctxtype Type Reference

x vector from the previous iteration More...

Collaboration diagram for petscconvergencemodule::petsccnvgctxtype:
Collaboration graph

Public Member Functions

procedure create
 
procedure destroy
 

Public Attributes

integer(i4b) icnvg_ims
 IMS convergence number: 1 => converged, -1 => forces next Picard iter. More...
 
integer(i4b) icnvgopt
 convergence option from IMS settings More...
 
real(dp) dvclose
 dep. variable closure criterion More...
 
real(dp) rclose
 residual closure criterion More...
 
integer(i4b) max_its
 maximum number of inner iterations More...
 
real(dp) rnorm_l2_init
 the initial L2 norm for (b - Ax) More...
 
type(convergencesummarytype), pointer cnvg_summary => null()
 detailed convergence information More...
 
real(dp) t_convergence_check
 the time spent convergence checking More...
 

Detailed Description

delta in x w.r.t. previous iteration the unpreconditoned residual vector (a la IMS)

Definition at line 19 of file PetscConvergence.F90.

Member Function/Subroutine Documentation

◆ create()

procedure petscconvergencemodule::petsccnvgctxtype::create

Definition at line 32 of file PetscConvergence.F90.

◆ destroy()

procedure petscconvergencemodule::petsccnvgctxtype::destroy

Definition at line 33 of file PetscConvergence.F90.

Member Data Documentation

◆ cnvg_summary

type(convergencesummarytype), pointer petscconvergencemodule::petsccnvgctxtype::cnvg_summary => null()

Definition at line 29 of file PetscConvergence.F90.

29  type(ConvergenceSummaryType), pointer :: cnvg_summary => null() !< detailed convergence information

◆ dvclose

real(dp) petscconvergencemodule::petsccnvgctxtype::dvclose

Definition at line 25 of file PetscConvergence.F90.

25  real(DP) :: dvclose !< dep. variable closure criterion

◆ icnvg_ims

integer(i4b) petscconvergencemodule::petsccnvgctxtype::icnvg_ims

Definition at line 23 of file PetscConvergence.F90.

23  integer(I4B) :: icnvg_ims !< IMS convergence number: 1 => converged, -1 => forces next Picard iter

◆ icnvgopt

integer(i4b) petscconvergencemodule::petsccnvgctxtype::icnvgopt

Definition at line 24 of file PetscConvergence.F90.

24  integer(I4B) :: icnvgopt !< convergence option from IMS settings

◆ max_its

integer(i4b) petscconvergencemodule::petsccnvgctxtype::max_its

Definition at line 27 of file PetscConvergence.F90.

27  integer(I4B) :: max_its !< maximum number of inner iterations

◆ rclose

real(dp) petscconvergencemodule::petsccnvgctxtype::rclose

Definition at line 26 of file PetscConvergence.F90.

26  real(DP) :: rclose !< residual closure criterion

◆ rnorm_l2_init

real(dp) petscconvergencemodule::petsccnvgctxtype::rnorm_l2_init

Definition at line 28 of file PetscConvergence.F90.

28  real(DP) :: rnorm_L2_init !< the initial L2 norm for (b - Ax)

◆ t_convergence_check

real(dp) petscconvergencemodule::petsccnvgctxtype::t_convergence_check

Definition at line 30 of file PetscConvergence.F90.

30  real(DP) :: t_convergence_check !< the time spent convergence checking

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