MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
linearsolverbasemodule::linearsolverbasetype Type Referenceabstract

Abstract type for linear solver. More...

Inheritance diagram for linearsolverbasemodule::linearsolverbasetype:
Inheritance graph
Collaboration diagram for linearsolverbasemodule::linearsolverbasetype:
Collaboration graph

Public Member Functions

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

character(len=lensolutionname) name
integer(i4b) nitermax
integer(i4b) iteration_number
integer(i4b) is_converged

Detailed Description

This serves as the base type for our solvers: sequential, parallel, petsc, block solver, ...

Definition at line 17 of file LinearSolverBase.f90.

Member Function/Subroutine Documentation

◆ create_matrix()

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

Definition at line 28 of file LinearSolverBase.f90.

◆ destroy()

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

Definition at line 26 of file LinearSolverBase.f90.

◆ initialize()

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 virtual

Definition at line 23 of file LinearSolverBase.f90.

◆ print_summary()

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

Definition at line 24 of file LinearSolverBase.f90.

◆ solve()

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 virtual

Definition at line 25 of file LinearSolverBase.f90.

Member Data Documentation

◆ is_converged

integer(i4b) linearsolverbasemodule::linearsolverbasetype::is_converged

Definition at line 21 of file LinearSolverBase.f90.

21 integer(I4B) :: is_converged

◆ iteration_number

integer(i4b) linearsolverbasemodule::linearsolverbasetype::iteration_number

Definition at line 20 of file LinearSolverBase.f90.

20 integer(I4B) :: iteration_number

◆ name

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

Definition at line 18 of file LinearSolverBase.f90.

18 character(len=LENSOLUTIONNAME) :: name

◆ nitermax

integer(i4b) linearsolverbasemodule::linearsolverbasetype::nitermax

Definition at line 19 of file LinearSolverBase.f90.

19 integer(I4B) :: nitermax

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