MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
petscsolvermodule::petscsolvertype Type Referenceabstract
Inheritance diagram for petscsolvermodule::petscsolvertype:
Inheritance graph
Collaboration diagram for petscsolvermodule::petscsolvertype:
Collaboration graph

Public Member Functions

procedure initialize (this, matrix, linear_settings, convergence_summary)
 Initialize PETSc KSP solver with.
procedure solve (this, kiter, rhs, x, cnvg_summary)
procedure print_summary (this)
procedure destroy (this)
procedure create_matrix (this)
procedure(initialize_if), deferred initialize (this, matrix, linear_settings, convergence_summary)
procedure(print_summary_if), deferred print_summary (this)
procedure(solve_if), deferred solve (this, kiter, rhs, x, cnvg_summary)
procedure(destroy_if), deferred destroy (this)
procedure(create_matrix_if), deferred create_matrix (this)

Public Attributes

type(tksp) ksp_petsc
 the KSP linear solver object
class(petscmatrixtype), pointer matrix => null()
 the system matrix in PETSc compatible format
type(tmat), pointer mat_petsc => null()
 the PETSc internal matrix format
type(imslinearsettingstype), pointer linear_settings => null()
 pointer to linear settings from IMS
logical(lgp) use_ims_pc
 when true, use custom IMS-style preconditioning
logical(lgp) use_ims_cnvgopt
 when true, use IMS convergence check in PETSc solve
character(len=256) ksp_type
 the KSP solver type (CG, BCGS, ...)
class(petsccnvgctxtype), pointer petsc_ctx => null()
 context for the PETSc custom convergence check
type(pcshellctxtype), pointer pc_context => null()
 context for the custom (IMS) precondioner
type(convergencesummarytype), pointer convergence_summary => null()
 data structure wrapping the convergence data
character(len=lensolutionname+1) option_prefix
 prefix for keys in petscrc database in case there are multiple solutions
character(len=lensolutionname) name
integer(i4b) nitermax
integer(i4b) iteration_number
integer(i4b) is_converged

Private Member Functions

procedure, private petsc_check_settings (this, linear_settings)
procedure, private get_options_mf6 (this)
 Get the MODFLOW specific options from the PETSc database.
procedure, private create_ksp (this)
 Create the PETSc KSP object.
procedure, private create_convergence_check (this, convergence_summary)
 Create and assign a custom convergence.
procedure, private set_ims_pc (this)
 Set up a custom preconditioner following the ones.
procedure, private print_vec (this, vec, vec_name, kiter)
procedure, private print_petsc_version (this)
 Print PETSc version string from shared lib.

Detailed Description

Definition at line 26 of file PetscSolver.F90.

Member Function/Subroutine Documentation

◆ create_convergence_check()

procedure, private petscsolvermodule::petscsolvertype::create_convergence_check ( class(petscsolvertype) this,
type(convergencesummarytype), pointer convergence_summary )
private
Parameters
thisThis solver instance

Definition at line 50 of file PetscSolver.F90.

◆ create_ksp()

procedure, private petscsolvermodule::petscsolvertype::create_ksp ( class(petscsolvertype) this)
private
Parameters
thisThis solver instance

Definition at line 49 of file PetscSolver.F90.

◆ create_matrix() [1/2]

procedure(create_matrix_if), deferred linearsolverbasemodule::linearsolverbasetype::create_matrix ( class(linearsolverbasetype) this)
pure virtualinherited

Definition at line 28 of file LinearSolverBase.f90.

◆ create_matrix() [2/2]

procedure petscsolvermodule::petscsolvertype::create_matrix ( class(petscsolvertype) this)

Definition at line 44 of file PetscSolver.F90.

◆ destroy() [1/2]

procedure(destroy_if), deferred linearsolverbasemodule::linearsolverbasetype::destroy ( class(linearsolverbasetype) this)
pure virtualinherited

Definition at line 26 of file LinearSolverBase.f90.

◆ destroy() [2/2]

procedure petscsolvermodule::petscsolvertype::destroy ( class(petscsolvertype) this)

Definition at line 43 of file PetscSolver.F90.

◆ get_options_mf6()

procedure, private petscsolvermodule::petscsolvertype::get_options_mf6 ( class(petscsolvertype) this)
private

Definition at line 48 of file PetscSolver.F90.

◆ initialize() [1/2]

procedure(initialize_if), deferred linearsolverbasemodule::linearsolverbasetype::initialize ( class(linearsolverbasetype) this,
class(matrixbasetype), pointer matrix,
type(imslinearsettingstype), pointer linear_settings,
type(convergencesummarytype), pointer convergence_summary )
pure virtualinherited

Definition at line 23 of file LinearSolverBase.f90.

◆ initialize() [2/2]

procedure petscsolvermodule::petscsolvertype::initialize ( class(petscsolvertype) this,
class(matrixbasetype), pointer matrix,
type(imslinearsettingstype), pointer linear_settings,
type(convergencesummarytype), pointer convergence_summary )
Parameters
thisThis solver instance
matrixThe solution matrix as KSP operator
linear_settingsthe settings for the linear solver from the .ims file
convergence_summarya convergence record for diagnostics

Definition at line 40 of file PetscSolver.F90.

◆ petsc_check_settings()

procedure, private petscsolvermodule::petscsolvertype::petsc_check_settings ( class(petscsolvertype) this,
type(imslinearsettingstype), pointer linear_settings )
private

Definition at line 47 of file PetscSolver.F90.

◆ print_petsc_version()

procedure, private petscsolvermodule::petscsolvertype::print_petsc_version ( class(petscsolvertype) this)
private

Definition at line 53 of file PetscSolver.F90.

◆ print_summary() [1/2]

procedure(print_summary_if), deferred linearsolverbasemodule::linearsolverbasetype::print_summary ( class(linearsolverbasetype) this)
pure virtualinherited

Definition at line 24 of file LinearSolverBase.f90.

◆ print_summary() [2/2]

procedure petscsolvermodule::petscsolvertype::print_summary ( class(petscsolvertype) this)

Definition at line 42 of file PetscSolver.F90.

◆ print_vec()

procedure, private petscsolvermodule::petscsolvertype::print_vec ( class(petscsolvertype) this,
class(petscvectortype) vec,
character(len=*) vec_name,
integer(i4b) kiter )
private

Definition at line 52 of file PetscSolver.F90.

◆ set_ims_pc()

procedure, private petscsolvermodule::petscsolvertype::set_ims_pc ( class(petscsolvertype) this)
private
Parameters
thisThis solver instance

Definition at line 51 of file PetscSolver.F90.

◆ solve() [1/2]

procedure(solve_if), deferred linearsolverbasemodule::linearsolverbasetype::solve ( class(linearsolverbasetype) this,
integer(i4b) kiter,
class(vectorbasetype), pointer rhs,
class(vectorbasetype), pointer x,
type(convergencesummarytype) cnvg_summary )
pure virtualinherited

Definition at line 25 of file LinearSolverBase.f90.

◆ solve() [2/2]

procedure petscsolvermodule::petscsolvertype::solve ( class(petscsolvertype) this,
integer(i4b) kiter,
class(vectorbasetype), pointer rhs,
class(vectorbasetype), pointer x,
type(convergencesummarytype) cnvg_summary )

Definition at line 41 of file PetscSolver.F90.

Member Data Documentation

◆ convergence_summary

type(convergencesummarytype), pointer petscsolvermodule::petscsolvertype::convergence_summary => null()

Definition at line 37 of file PetscSolver.F90.

◆ is_converged

integer(i4b) linearsolverbasemodule::linearsolverbasetype::is_converged
inherited

Definition at line 21 of file LinearSolverBase.f90.

21 integer(I4B) :: is_converged

◆ iteration_number

integer(i4b) linearsolverbasemodule::linearsolverbasetype::iteration_number
inherited

Definition at line 20 of file LinearSolverBase.f90.

20 integer(I4B) :: iteration_number

◆ ksp_petsc

type(tksp) petscsolvermodule::petscsolvertype::ksp_petsc

Definition at line 27 of file PetscSolver.F90.

27 ksp :: ksp_petsc !< the KSP linear solver object

◆ ksp_type

character(len=256) petscsolvermodule::petscsolvertype::ksp_type

Definition at line 34 of file PetscSolver.F90.

34 ksptype :: ksp_type !< the KSP solver type (CG, BCGS, ...)

◆ linear_settings

type(imslinearsettingstype), pointer petscsolvermodule::petscsolvertype::linear_settings => null()

Definition at line 31 of file PetscSolver.F90.

◆ mat_petsc

type(tmat), pointer petscsolvermodule::petscsolvertype::mat_petsc => null()

Definition at line 29 of file PetscSolver.F90.

◆ matrix

class(petscmatrixtype), pointer petscsolvermodule::petscsolvertype::matrix => null()

Definition at line 28 of file PetscSolver.F90.

◆ name

character(len=lensolutionname) linearsolverbasemodule::linearsolverbasetype::name
inherited

Definition at line 18 of file LinearSolverBase.f90.

18 character(len=LENSOLUTIONNAME) :: name

◆ nitermax

integer(i4b) linearsolverbasemodule::linearsolverbasetype::nitermax
inherited

Definition at line 19 of file LinearSolverBase.f90.

19 integer(I4B) :: nitermax

◆ option_prefix

character(len=lensolutionname + 1) petscsolvermodule::petscsolvertype::option_prefix

Definition at line 38 of file PetscSolver.F90.

38 character(len=LENSOLUTIONNAME + 1) :: option_prefix !< prefix for keys in petscrc database in case there are multiple solutions

◆ pc_context

type(pcshellctxtype), pointer petscsolvermodule::petscsolvertype::pc_context => null()

Definition at line 36 of file PetscSolver.F90.

◆ petsc_ctx

class(petsccnvgctxtype), pointer petscsolvermodule::petscsolvertype::petsc_ctx => null()

Definition at line 35 of file PetscSolver.F90.

◆ use_ims_cnvgopt

logical(lgp) petscsolvermodule::petscsolvertype::use_ims_cnvgopt

Definition at line 33 of file PetscSolver.F90.

33 logical(LGP) :: use_ims_cnvgopt !< when true, use IMS convergence check in PETSc solve

◆ use_ims_pc

logical(lgp) petscsolvermodule::petscsolvertype::use_ims_pc

Definition at line 32 of file PetscSolver.F90.

32 logical(LGP) :: use_ims_pc !< when true, use custom IMS-style preconditioning

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