LinearSolverBase.f90

Go to the documentation of this file.

module linearsolverbasemodule
  use kindmodule, only: i4b, dp
  use constantsmodule, only: lensolutionname
  use matrixbasemodule
  use vectorbasemodule
  use imslinearsettingsmodule
  use convergencesummarymodule
 
  implicit none
  private
 
  !> @brief Abstract type for linear solver
  !!
  !! This serves as the base type for our solvers:
  !! sequential, parallel, petsc, block solver, ...
  !<
  type, public, abstract :: linearsolverbasetype
    character(len=LENSOLUTIONNAME) :: name
    integer(I4B) :: nitermax
    integer(I4B) :: iteration_number
    integer(I4B) :: is_converged
  contains
    procedure(initialize_if), deferred :: initialize
    procedure(print_summary_if), deferred :: print_summary
    procedure(solve_if), deferred :: solve
    procedure(destroy_if), deferred :: destroy
 
    procedure(create_matrix_if), deferred :: create_matrix
  end type linearsolverbasetype
 
  abstract interface
    subroutine initialize_if(this, matrix, linear_settings, convergence_summary)
      import linearsolverbasetype, matrixbasetype, &
        imslinearsettingstype, convergencesummarytype
      class(linearsolverbasetype) :: this
      class(matrixbasetype), pointer :: matrix
      type(imslinearsettingstype), pointer :: linear_settings
      type(convergencesummarytype), pointer :: convergence_summary
    end subroutine
    subroutine print_summary_if(this)
      import linearsolverbasetype
      class(linearsolverbasetype) :: this
    end subroutine
    subroutine solve_if(this, kiter, rhs, x, cnvg_summary)
      import linearsolverbasetype, i4b, vectorbasetype, convergencesummarytype
      class(linearsolverbasetype) :: this
      integer(I4B) :: kiter
      class(vectorbasetype), pointer :: rhs
      class(vectorbasetype), pointer :: x
      type(convergencesummarytype) :: cnvg_summary
    end subroutine
    subroutine destroy_if(this)
      import linearsolverbasetype
      class(linearsolverbasetype) :: this
    end subroutine
    function create_matrix_if(this) result(matrix)
      import linearsolverbasetype, matrixbasetype
      class(linearsolverbasetype) :: this
      class(matrixbasetype), pointer :: matrix
    end function
  end interface
 
end module linearsolverbasemodule