m_allocate.f90 – Fortran Program

This File Depends On

Help
Files Dependent On This One

Help
Modules

m_allocate
Source Code

m_allocate.f90
Source Code

module m_allocate
  !! Contains fundamental interface to allocate allocatable arrays of different types and shapes
  !!
  !! See [[allocate]] for more information.

  use variableKind
  use m_unitTester, only: tester
  use m_errors, only: eMsg, mErr, msg

  implicit none

  private

  public :: allocate

  interface allocate
    !! Allocate an allocatable array. If the array is already allocated, memory is reallocated to the given size, unless no size change will occur.
    !! The allocated memory is NOT initialized to any value, so be sure to do so afterwards if you call allocate.
    !!
    !! Does not overload the intrinsic allocate function. This way, calling allocate makes the user aware that checks are being made, 
    !! and memory will be re-allocated.
    !!
    !! Checks for an error during allocation, and will stop the code if there is one.
    !!
    !! The allocate interface can be given the size of the new array only. e.g. call allocate(array1D, 10)
    !! Or the lower bound and the size can be given. e.g. call allocate(array1D, 0, 12) is akin to allocate(array1D(0:11)).
    !!
    !! Example usage
    !!```fortran
    !!use variableKind
    !!use m_allocate, only: allocate
    !!real(r64),allocatable :: a1D(:), a2D(:,:), a3D(:,:,:)
    !!call allocate(a1D, 20)
    !!call allocate(a2D, [20,20])
    !!call allocate(a3D, [20,20,20])
    !!write(*,'(a)') 'Shape of a3D is [20,20,20]? '//all(shape(a3D) == [20,20,20])
    !!call allocate(a1D, -10, 20)
    !!call allocate(a2D, [-10,-10], [20,20])
    !!call allocate(a3D, [-10,-10,-10], [20,20,20])
    !!write(*,'(a)') 'Lower bound of a3D is [-10,-10,-10]? '//all(lbound(a3D) == [-10,-10,-10])
    !!write(*,'(a)') 'Shape of a3D is [20,20,20]? '//all(shape(a3D) == [20,20,20])
    !!```
    !====================================================================!
    module subroutine allocate_r1D(this, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      real(r32), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_r2D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r32), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_r3D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r32), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_r1D(this, lb, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      real(r32), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: lb 
        !! Lower index
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_r2D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r32), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: lb(2)
        !! Lower index
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_r3D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r32), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: lb(3)
        !! Lower index
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!

    !====================================================================!
    module subroutine allocate_d1D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r64), allocatable, intent(inout) :: this(:) !! 1D array
      integer(i32), intent(in) :: n !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_d2D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r64), allocatable, intent(inout) :: this(:,:) !! 2D array
      integer(i32), intent(in) :: n(2) !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_d3D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r64), allocatable, intent(inout) :: this(:,:,:) !! 3D array
      integer(i32), intent(in) :: n(3) !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_d1D(this, lb, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      real(r64), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: lb 
        !! Lower index
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_d2D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r64), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: lb(2)
        !! Lower index
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_d3D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      real(r64), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: lb(3)
        !! Lower index
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!

    !====================================================================!
    module subroutine allocate_i1D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i32), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_i2D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i32), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_i3D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i32), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_i1D(this, lb, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      integer(i32), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: lb 
        !! Lower index
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_i2D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i32), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: lb(2)
        !! Lower index
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_i3D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i32), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: lb(3)
        !! Lower index
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!

    !====================================================================!
    module subroutine allocate_id1D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i64), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_id2D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i64), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_id3D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i64), allocatable, intent(inout) :: this(:,:,:)
        !! 3D array
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_id1D(this, lb, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      integer(i64), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: lb 
        !! Lower index
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_id2D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i64), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: lb(2)
        !! Lower index
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_id3D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      integer(i64), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: lb(3)
        !! Lower index
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!

    !====================================================================!
    module subroutine allocate_c1D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r32), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_c2D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r32), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_c3D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r32), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_c1D(this, lb, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      complex(r32), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: lb 
        !! Lower index
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_c2D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r32), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: lb(2)
        !! Lower index
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_c3D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r32), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: lb(3)
        !! Lower index
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!

    !====================================================================!
    module subroutine allocate_z1D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r64), allocatable, intent(inout) :: this(:) !! 1D array
      integer(i32), intent(in) :: n !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_z2D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r64), allocatable, intent(inout) :: this(:,:) !! 2D array
      integer(i32), intent(in) :: n(2) !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_z3D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r64), allocatable, intent(inout) :: this(:,:,:) !! 3D array
      integer(i32), intent(in) :: n(3) !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_z1D(this, lb, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      complex(r64), allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: lb 
        !! Lower index
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_z2D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r64), allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: lb(2)
        !! Lower index
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_z3D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      complex(r64), allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: lb(3)
        !! Lower index
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!

    !====================================================================!
    module subroutine allocate_l1D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      logical, allocatable, intent(inout) :: this(:) !! 1D array
      integer(i32), intent(in) :: n !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_l2D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      logical, allocatable, intent(inout) :: this(:,:) !! 2D array
      integer(i32), intent(in) :: n(2) !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_l3D(this, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      logical, allocatable, intent(inout) :: this(:,:,:) !! 3D array
      integer(i32), intent(in) :: n(3) !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_l1D(this, lb, n)
    !====================================================================!
      !!Interfaced with [[allocate]]
      logical, allocatable, intent(inout) :: this(:) 
        !! 1D array
      integer(i32), intent(in) :: lb 
        !! Lower index
      integer(i32), intent(in) :: n 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_l2D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      logical, allocatable, intent(inout) :: this(:,:) 
        !! 2D array
      integer(i32), intent(in) :: lb(2)
        !! Lower index
      integer(i32), intent(in) :: n(2) 
        !! Allocation size
    end subroutine
    !====================================================================!
    !====================================================================!
    module subroutine allocate_lb_l3D(this, lb, n)
    !====================================================================!
      !!Interfaced with  [[allocate]]
      logical, allocatable, intent(inout) :: this(:,:,:) 
        !! 3D array
      integer(i32), intent(in) :: lb(3)
        !! Lower index
      integer(i32), intent(in) :: n(3) 
        !! Allocation size
    end subroutine
    !====================================================================!
  end interface

  contains

  !====================================================================!
  module subroutine allocate_r1D(this, n)
    !!Interfaced with  [[allocate]]
  !====================================================================!
  real(r32), allocatable, intent(inout) :: this(:) !! 1D array
  integer(i32), intent(in) :: n !! Allocation size
  integer(i32) :: istat

  if(allocated(this)) then
    if (n == size(this)) then
      return ! Don't need to allocate the same size
    else
      deallocate(this) ! No need to duplicate memory
    end if
  end if
  allocate(this(n), stat=istat); call mErr(istat,'allocate_r1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_r2D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r32), allocatable, intent(inout) :: this(:,:) !! 2D array
    integer(i32), intent(in) :: n(2) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2)), stat=istat); call mErr(istat,'allocate_r2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_r3D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r32), allocatable, intent(inout) :: this(:,:,:) !! 3D array
    integer(i32), intent(in) :: n(3) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2),n(3)), stat=istat); call mErr(istat,'allocate_r3D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_r1D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r32), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: lb !! Lower index, default = 1.
    integer(i32), intent(in) :: n !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        if (lbound(this, 1) == lb) then
          return ! Don't need to allocate the same size
        else
          deallocate(this) ! No need to duplicate memory
        end if
      end if
    end if

    allocate(this(lb:lb+n-1), stat=istat); call mErr(istat,'allocate_r1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_r2D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r32), allocatable, intent(inout) :: this(:,:) !! 1D array
    integer(i32), intent(in) :: lb(2) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(2) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this)
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1), stat=istat); call mErr(istat,'allocate_r2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_r3D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r32), allocatable, intent(inout) :: this(:,:,:) !! 1D array
    integer(i32), intent(in) :: lb(3) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(3) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this)
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1, lb(3):lb(3)+n(3)-1), stat=istat); call mErr(istat,'allocate_r3D:this',1)
  end subroutine
  !====================================================================!

  !====================================================================!
  module subroutine allocate_d1D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r64), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: n !! Allocation size
    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        return ! Don't need to allocate the same size
      else
        deallocate(this) ! No need to duplicate memory
      end if
    end if
    allocate(this(n), stat=istat); call mErr(istat,'allocate_d1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_d2D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r64), allocatable, intent(inout) :: this(:,:) !! 2D array
    integer(i32), intent(in) :: n(2) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2)), stat=istat); call mErr(istat,'allocate_d2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_d3D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r64), allocatable, intent(inout) :: this(:,:,:) !! 3D array
    integer(i32), intent(in) :: n(3) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2),n(3)), stat=istat); call mErr(istat,'allocate_d3D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_d1D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r64), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: lb !! Lower index, default = 1.
    integer(i32), intent(in) :: n !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        if (lbound(this, 1) == lb) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this)
    end if

    allocate(this(lb:lb+n-1), stat=istat); call mErr(istat,'allocate_d1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_d2D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r64), allocatable, intent(inout) :: this(:,:) !! 1D array
    integer(i32), intent(in) :: lb(2) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(2) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this)
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1), stat=istat); call mErr(istat,'allocate_d2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_d3D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    real(r64), allocatable, intent(inout) :: this(:,:,:) !! 1D array
    integer(i32), intent(in) :: lb(3) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(3) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        else
          deallocate(this) ! No need to duplicate memory
        end if
      end if
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1, lb(3):lb(3)+n(3)-1), stat=istat); call mErr(istat,'allocate_d3D:this',1)
  end subroutine
  !====================================================================!

  !====================================================================!
  module subroutine allocate_i1D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i32), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: n !! Allocation size
    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        return ! Don't need to allocate the same size
      else
        deallocate(this) ! No need to duplicate memory
      end if
    end if
    allocate(this(n), stat=istat); call mErr(istat,'allocate_i1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_i2D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i32), allocatable, intent(inout) :: this(:,:) !! 2D array
    integer(i32), intent(in) :: n(2) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2)), stat=istat); call mErr(istat,'allocate_i2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_i3D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i32), allocatable, intent(inout) :: this(:,:,:) !! 3D array
    integer(i32), intent(in) :: n(3) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2),n(3)), stat=istat); call mErr(istat,'allocate_i3D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_i1D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i32), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: lb !! Lower index, default = 1.
    integer(i32), intent(in) :: n !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        if (lbound(this, 1) == lb) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this)
    end if

    allocate(this(lb:lb+n-1), stat=istat); call mErr(istat,'allocate_i1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_i2D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i32), allocatable, intent(inout) :: this(:,:) !! 1D array
    integer(i32), intent(in) :: lb(2) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(2) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this)
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1), stat=istat); call mErr(istat,'allocate_i2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_i3D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i32), allocatable, intent(inout) :: this(:,:,:) !! 1D array
    integer(i32), intent(in) :: lb(3) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(3) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        else
          deallocate(this) ! No need to duplicate memory
        end if
      end if
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1, lb(3):lb(3)+n(3)-1), stat=istat); call mErr(istat,'allocateid3D:this',1)
  end subroutine
  !====================================================================!

  !====================================================================!
  module subroutine allocate_id1D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i64), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: n !! Allocation size
    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        return ! Don't need to allocate the same size
      else
        deallocate(this) ! No need to duplicate memory
      end if
    end if
    allocate(this(n), stat=istat); call mErr(istat,'allocate_id1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_id2D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i64), allocatable, intent(inout) :: this(:,:) !! 2D array
    integer(i32), intent(in) :: n(2) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2)), stat=istat); call mErr(istat,'allocate_id2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_id3D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i64), allocatable, intent(inout) :: this(:,:,:) !! 3D array
    integer(i32), intent(in) :: n(3) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2),n(3)), stat=istat); call mErr(istat,'allocate_id3D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_id1D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i64), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: lb !! Lower index, default = 1.
    integer(i32), intent(in) :: n !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        if (lbound(this, 1) == lb) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if

    allocate(this(lb:lb+n-1), stat=istat); call mErr(istat,'allocate_id1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_id2D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i64), allocatable, intent(inout) :: this(:,:) !! 1D array
    integer(i32), intent(in) :: lb(2) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(2) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1), stat=istat); call mErr(istat,'allocate_id1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_id3D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    integer(i64), allocatable, intent(inout) :: this(:,:,:) !! 1D array
    integer(i32), intent(in) :: lb(3) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(3) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1, lb(3):lb(3)+n(3)-1), stat=istat); call mErr(istat,'allocate_id1D:this',1)
  end subroutine
  !====================================================================!

  !====================================================================!
  module subroutine allocate_c1D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r32), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: n !! Allocation size
    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        return ! Don't need to allocate the same size
      else
        deallocate(this) ! No need to duplicate memory
      end if
    end if
    allocate(this(n), stat=istat); call mErr(istat,'allocate_c1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_c2D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r32), allocatable, intent(inout) :: this(:,:) !! 2D array
    integer(i32), intent(in) :: n(2) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2)), stat=istat); call mErr(istat,'allocate_c2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_c3D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r32), allocatable, intent(inout) :: this(:,:,:) !! 3D array
    integer(i32), intent(in) :: n(3) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2),n(3)), stat=istat); call mErr(istat,'allocate_c3D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_c1D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r32), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: lb !! Lower index, default = 1.
    integer(i32), intent(in) :: n !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        if (lbound(this, 1) == lb) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if

    allocate(this(lb:lb+n-1), stat=istat); call mErr(istat,'allocate_c1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_c2D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r32), allocatable, intent(inout) :: this(:,:) !! 1D array
    integer(i32), intent(in) :: lb(2) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(2) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1), stat=istat); call mErr(istat,'allocate_c2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_c3D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r32), allocatable, intent(inout) :: this(:,:,:) !! 1D array
    integer(i32), intent(in) :: lb(3) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(3) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1, lb(3):lb(3)+n(3)-1), stat=istat); call mErr(istat,'allocate_c3D:this',1)
  end subroutine
  !====================================================================!

  !====================================================================!
  module subroutine allocate_z1D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r64), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: n !! Allocation size
    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        return ! Don't need to allocate the same size
      else
        deallocate(this) ! No need to duplicate memory
      end if
    end if
    allocate(this(n), stat=istat); call mErr(istat,'allocate_z1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_z2D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r64), allocatable, intent(inout) :: this(:,:) !! 2D array
    integer(i32), intent(in) :: n(2) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2)), stat=istat); call mErr(istat,'allocate_z2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_z3D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r64), allocatable, intent(inout) :: this(:,:,:) !! 3D array
    integer(i32), intent(in) :: n(3) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2),n(3)), stat=istat); call mErr(istat,'allocate_z3D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_z1D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r64), allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: lb !! Lower index, default = 1.
    integer(i32), intent(in) :: n !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        if (lbound(this, 1) == lb) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if

    allocate(this(lb:lb+n-1), stat=istat); call mErr(istat,'allocate_z1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_z2D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r64), allocatable, intent(inout) :: this(:,:) !! 1D array
    integer(i32), intent(in) :: lb(2) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(2) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1), stat=istat); call mErr(istat,'allocate_z2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_z3D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    complex(r64), allocatable, intent(inout) :: this(:,:,:) !! 1D array
    integer(i32), intent(in) :: lb(3) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(3) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1, lb(3):lb(3)+n(3)-1), stat=istat); call mErr(istat,'allocate_z3D:this',1)
  end subroutine
  !====================================================================!

  !====================================================================!
  module subroutine allocate_l1D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    logical, allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: n !! Allocation size
    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        return ! Don't need to allocate the same size
      else
        deallocate(this) ! No need to duplicate memory
      end if
    end if
    allocate(this(n), stat=istat); call mErr(istat,'allocate_l1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_l2D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    logical, allocatable, intent(inout) :: this(:,:) !! 2D array
    integer(i32), intent(in) :: n(2) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2)), stat=istat); call mErr(istat,'allocate_l2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_l3D(this, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    logical, allocatable, intent(inout) :: this(:,:,:) !! 3D array
    integer(i32), intent(in) :: n(3) !! New allocation shape
    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        return ! Don't need to allocate the same size
      else
        deallocate(this)
      end if
    end if
    allocate(this(n(1),n(2),n(3)), stat=istat); call mErr(istat,'allocate_l3D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_l1D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    logical, allocatable, intent(inout) :: this(:) !! 1D array
    integer(i32), intent(in) :: lb !! Lower index, default = 1.
    integer(i32), intent(in) :: n !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (n == size(this)) then
        if (lbound(this, 1) == lb) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if

    allocate(this(lb:lb+n-1), stat=istat); call mErr(istat,'allocate_l1D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_l2D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    logical, allocatable, intent(inout) :: this(:,:) !! 1D array
    integer(i32), intent(in) :: lb(2) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(2) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1), stat=istat); call mErr(istat,'allocate_l2D:this',1)
  end subroutine
  !====================================================================!
  !====================================================================!
  module subroutine allocate_lb_l3D(this, lb, n)
    !! Interfaced with [[allocate]]
  !====================================================================!
    logical, allocatable, intent(inout) :: this(:,:,:) !! 1D array
    integer(i32), intent(in) :: lb(3) !! Lower index, default = 1.
    integer(i32), intent(in) :: n(3) !! Allocation size

    integer(i32) :: istat

    if(allocated(this)) then
      if (all(n == shape(this))) then
        if (all(lbound(this) == lb)) then
          return ! Don't need to allocate the same size
        end if
      end if
      deallocate(this) ! No need to duplicate memory
    end if
    allocate(this(lb(1):lb(1)+n(1)-1, lb(2):lb(2)+n(2)-1, lb(3):lb(3)+n(3)-1), stat=istat); call mErr(istat,'allocate_l3D:this',1)
  end subroutine
  !====================================================================!
end module
m_allocate.f90 Source File

Modules

Source Code

All Source Files

This File Depends On

Files Dependent On This One

Modules

Source Code

Source Code

All Source Files
