MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
petscconvergencemodule::petsccnvgctxtype Type Reference
Collaboration diagram for petscconvergencemodule::petsccnvgctxtype:
Collaboration graph

Public Member Functions

procedure create (this, mat, settings, summary)
procedure destroy (this)

Public Attributes

type(tvec) x_old
 x vector from the previous iteration
type(tvec) delta_x
 delta in x w.r.t. previous iteration
type(tvec) residual
 the unpreconditoned residual vector (a la IMS)
integer(i4b) icnvg_ims
 IMS convergence number: 1 => converged, -1 => forces next Picard iter.
integer(i4b) icnvgopt
 convergence option: 0,1,2,3,4,.. for equivalent IMS settings
real(dp) dvclose
 dep. variable closure criterion
real(dp) rclose
 residual closure criterion
integer(i4b) max_its
 maximum number of inner iterations
real(dp) rnorm_l2_init
 the initial L2 norm for (b - Ax)
type(convergencesummarytype), pointer cnvg_summary => null()
 detailed convergence information
real(dp) t_convergence_check
 the time spent convergence checking

Detailed Description

Definition at line 21 of file PetscConvergence.F90.

Member Function/Subroutine Documentation

◆ create()

procedure petscconvergencemodule::petsccnvgctxtype::create ( class(petsccnvgctxtype) this,
type(tmat), pointer mat,
type(imslinearsettingstype), pointer settings,
type(convergencesummarytype), pointer summary )

Definition at line 35 of file PetscConvergence.F90.

◆ destroy()

procedure petscconvergencemodule::petsccnvgctxtype::destroy ( class(petsccnvgctxtype) this)

Definition at line 36 of file PetscConvergence.F90.

Member Data Documentation

◆ cnvg_summary

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

Definition at line 32 of file PetscConvergence.F90.

◆ delta_x

type(tvec) petscconvergencemodule::petsccnvgctxtype::delta_x

Definition at line 23 of file PetscConvergence.F90.

23 vec :: delta_x !< delta in x w.r.t. previous iteration

◆ dvclose

real(dp) petscconvergencemodule::petsccnvgctxtype::dvclose

Definition at line 28 of file PetscConvergence.F90.

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

◆ icnvg_ims

integer(i4b) petscconvergencemodule::petsccnvgctxtype::icnvg_ims

Definition at line 25 of file PetscConvergence.F90.

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

◆ icnvgopt

integer(i4b) petscconvergencemodule::petsccnvgctxtype::icnvgopt

Definition at line 26 of file PetscConvergence.F90.

26 integer(I4B) :: icnvgopt !< convergence option:

◆ max_its

integer(i4b) petscconvergencemodule::petsccnvgctxtype::max_its

Definition at line 30 of file PetscConvergence.F90.

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

◆ rclose

real(dp) petscconvergencemodule::petsccnvgctxtype::rclose

Definition at line 29 of file PetscConvergence.F90.

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

◆ residual

type(tvec) petscconvergencemodule::petsccnvgctxtype::residual

Definition at line 24 of file PetscConvergence.F90.

24 vec :: residual !< the unpreconditoned residual vector (a la IMS)

◆ rnorm_l2_init

real(dp) petscconvergencemodule::petsccnvgctxtype::rnorm_l2_init

Definition at line 31 of file PetscConvergence.F90.

31 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 33 of file PetscConvergence.F90.

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

◆ x_old

type(tvec) petscconvergencemodule::petsccnvgctxtype::x_old

Definition at line 22 of file PetscConvergence.F90.

22 vec :: x_old !< x vector from the previous iteration

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