GwfNpfExt.f90

Go to the documentation of this file.

module gwfnpfformulationmodule
  use kindmodule, only: i4b, dp
  use matrixbasemodule, only: matrixbasetype
  implicit none
  private
 
  integer(I4B), public, parameter :: default_flow = 0
  integer(I4B), public, parameter :: uzr_flow = 1
  integer(I4B), public, parameter :: swi_flow = 2
  integer(I4B), public, parameter :: max_ext_flow_forms = 2
 
  !> @brief Abstract flow formulation that additively contributes terms
  !!
  !! A formulation owns its own traversal of cells/connections and decides,
  !! per element, whether to add terms. Phases a formulation does not
  !! implement fall back to a no-op so formulations compose additively.
  !<
  type, abstract, public :: gwfnpfformulationtype
  contains
    procedure(fc_if), deferred :: fc
    procedure :: cf => cf_noop
    procedure :: fn => fn_noop
    procedure :: cq => cq_noop
  end type gwfnpfformulationtype
 
  !> @brief Container to allow arrays of polymorphic extension pointers
  !<
  type, public :: gwfnpfformcontainertype
    class(gwfnpfformulationtype), pointer :: form => null() !< the extended flow calculator
  end type gwfnpfformcontainertype
 
  abstract interface
    !> @brief Fill coefficients: formulation loops all connections itself
    !<
    subroutine fc_if(this, kiter, matrix_sln, idxglo, rhs, hnew)
      import gwfnpfformulationtype, matrixbasetype, i4b, dp
      class(gwfnpfformulationtype), intent(inout) :: this
      integer(I4B), intent(in) :: kiter
      class(matrixbasetype), pointer, intent(inout) :: matrix_sln
      integer(I4B), dimension(:), intent(in) :: idxglo
      real(DP), dimension(:), intent(inout) :: rhs
      real(DP), dimension(:), intent(inout) :: hnew
    end subroutine
  end interface
 
contains
 
  !> @brief No-op coefficient calculation; formulation loops cells itself
  !<
  subroutine cf_noop(this, kiter)
    class(gwfnpfformulationtype), intent(inout) :: this
    integer(I4B), intent(in) :: kiter
  end subroutine cf_noop
 
  !> @brief No-op newton terms; formulation loops connections itself
  !<
  subroutine fn_noop(this, kiter, matrix_sln, idxglo, rhs, hnew)
    class(gwfnpfformulationtype), intent(inout) :: this
    integer(I4B), intent(in) :: kiter
    class(matrixbasetype), pointer, intent(inout) :: matrix_sln
    integer(I4B), dimension(:), intent(in) :: idxglo
    real(DP), dimension(:), intent(inout) :: rhs
    real(DP), dimension(:), intent(inout) :: hnew
  end subroutine fn_noop
 
  !> @brief No-op flow calculation; formulation loops connections itself
  !<
  subroutine cq_noop(this, hnew, flowja)
    class(gwfnpfformulationtype), intent(inout) :: this
    real(DP), dimension(:), intent(inout) :: hnew
    real(DP), dimension(:), intent(inout) :: flowja
  end subroutine cq_noop
 
end module gwfnpfformulationmodule