GwfStoExt.f90

Go to the documentation of this file.

module gwfstoextmodule
  use kindmodule, only: i4b, lgp, dp
  use matrixbasemodule, only: matrixbasetype
  use budgetmodule, only: budgettype
  implicit none
  private
 
  integer(I4B), public, parameter :: default_storage = 0
  integer(I4B), public, parameter :: uzr_storage = 1
  integer(I4B), public, parameter :: swi_storage = 2
  integer(I4B), public, parameter :: max_ext_sto_forms = 2 !< 'cause default is not part of the (external) storage formulations
 
  type, abstract, public :: gwfstoformulationtype
  contains
    procedure(is_active_if), deferred :: is_active
    procedure(fc_if), deferred :: fc
    procedure(fn_if), deferred :: fn
    procedure(cq_if), deferred :: cq
    procedure(bd_if), deferred :: bd
    procedure(save_flows_if), deferred :: save_flows
  end type gwfstoformulationtype
 
  !> @brief Container to allow arrays of polymorphic extension pointers
  !<
  type, public :: gwfstoformcontainertype
    logical(LGP) :: is_active = .false.
    class(gwfstoformulationtype), pointer :: form => null() !< the extended flow calculator
  end type gwfstoformcontainertype
 
  abstract interface
    function is_active_if(this, n) result(is_active)
      import gwfstoformulationtype, i4b, lgp
      class(gwfstoformulationtype), intent(inout) :: this
      integer(I4B), intent(in) :: n
      logical(LGP) :: is_active
    end function
    subroutine fc_if(this, kiter, matrix_sln, rhs, idxglo, h_old, h_new)
      import gwfstoformulationtype, matrixbasetype, i4b, dp
      class(gwfstoformulationtype), intent(inout) :: this
      integer(I4B), intent(in) :: kiter
      class(matrixbasetype), pointer, intent(inout) :: matrix_sln
      real(DP), dimension(:), intent(inout) :: rhs
      integer(I4B), dimension(:), intent(in) :: idxglo
      real(DP), dimension(:), intent(in) :: h_old
      real(DP), dimension(:), intent(in) :: h_new
    end subroutine
    subroutine fn_if(this, kiter, matrix_sln, rhs, idxglo, h_old, h_new)
      import gwfstoformulationtype, matrixbasetype, i4b, dp
      class(gwfstoformulationtype), intent(inout) :: this
      integer(I4B), intent(in) :: kiter
      class(matrixbasetype), pointer, intent(inout) :: matrix_sln
      real(DP), dimension(:), intent(inout) :: rhs
      integer(I4B), dimension(:), intent(in) :: idxglo
      real(DP), dimension(:), intent(in) :: h_old
      real(DP), dimension(:), intent(in) :: h_new
    end subroutine
    subroutine cq_if(this, flowja, h_new, h_old)
      import gwfstoformulationtype, i4b, dp
      class(gwfstoformulationtype), intent(inout) :: this
      real(DP), dimension(:), intent(inout) :: flowja
      real(DP), dimension(:), intent(in) :: h_new
      real(DP), dimension(:), intent(in) :: h_old
    end subroutine
    subroutine bd_if(this, isuppress_output, model_budget)
      import gwfstoformulationtype, budgettype, i4b
      class(gwfstoformulationtype), intent(inout) :: this
      integer(I4B), intent(in) :: isuppress_output
      type(budgettype), intent(inout) :: model_budget
    end subroutine bd_if
    subroutine save_flows_if(this, iprint, ibinun)
      import gwfstoformulationtype, i4b
      class(gwfstoformulationtype), intent(inout) :: this
      integer(I4B), intent(in) :: iprint
      integer(I4B), intent(in) :: ibinun
    end subroutine save_flows_if
  end interface
 
end module gwfstoextmodule