SpdisWorkArray.f90

Go to the documentation of this file.

module spdisworkarraymodule
  use constantsmodule, only: dzero
  use kindmodule, only: i4b, dp, lgp
  implicit none
  private
 
  !> Helper class with work arrays for the SPDIS calculation in NPF
  !<
  type, public :: spdisworkarraytype
    real(dp), allocatable, dimension(:) :: vi
    real(dp), allocatable, dimension(:) :: di
    real(dp), allocatable, dimension(:) :: viz
    real(dp), allocatable, dimension(:) :: diz
    real(dp), allocatable, dimension(:) :: nix
    real(dp), allocatable, dimension(:) :: niy
    real(dp), allocatable, dimension(:) :: wix
    real(dp), allocatable, dimension(:) :: wiy
    real(dp), allocatable, dimension(:) :: wiz
    real(dp), allocatable, dimension(:) :: bix
    real(dp), allocatable, dimension(:) :: biy
  contains
    procedure :: create
    procedure :: is_created
    procedure :: reset
    procedure :: destroy
  end type spdisworkarraytype
 
contains
 
  !< @brief Create the worker arrays
  !<
  subroutine create(this, nr_conns)
    class(spdisworkarraytype) :: this
    integer(I4B) :: nr_conns
 
    allocate (this%vi(nr_conns))
    allocate (this%di(nr_conns))
    allocate (this%viz(nr_conns))
    allocate (this%diz(nr_conns))
    allocate (this%nix(nr_conns))
    allocate (this%niy(nr_conns))
    allocate (this%wix(nr_conns))
    allocate (this%wiy(nr_conns))
    allocate (this%wiz(nr_conns))
    allocate (this%bix(nr_conns))
    allocate (this%biy(nr_conns))
 
  end subroutine create
 
  !< @brief True when created (= allocated)
  !<
  function is_created(this) result(created)
    class(spdisworkarraytype) :: this
    logical(LGP) :: created
 
    created = allocated(this%vi)
 
  end function is_created
 
  !< @brief Sets all arrays to zero
  !<
  subroutine reset(this)
    class(spdisworkarraytype) :: this
 
    this%vi(:) = dzero
    this%di(:) = dzero
    this%viz(:) = dzero
    this%diz(:) = dzero
    this%nix(:) = dzero
    this%niy(:) = dzero
    this%wix(:) = dzero
    this%wiy(:) = dzero
    this%wiz(:) = dzero
    this%bix(:) = dzero
    this%biy(:) = dzero
 
  end subroutine reset
 
  !< @brief Clean up memory (only when create has been called)
  !<
  subroutine destroy(this)
    class(spdisworkarraytype) :: this
 
    deallocate (this%vi)
    deallocate (this%di)
    deallocate (this%viz)
    deallocate (this%diz)
    deallocate (this%nix)
    deallocate (this%niy)
    deallocate (this%wix)
    deallocate (this%wiy)
    deallocate (this%wiz)
    deallocate (this%bix)
    deallocate (this%biy)
 
  end subroutine destroy
 
end module spdisworkarraymodule