mom_safe_alloc::safe_alloc_alloc Interface Reference

Detailed Description

Allocate a 2-d or 3-d allocatable array.

Definition at line 18 of file MOM_safe_alloc.F90.

Private functions
subroutine	safe_alloc_allocatable_3d (ptr, is, ie, js, je, nk)
	Allocate a 3-d allocatable array based on its index starting and ending values and k-index size. More...
subroutine	safe_alloc_allocatable_2d (ptr, is, ie, js, je)
	Allocate a 2-d allocatable array based on its index starting and ending values. More...
subroutine	safe_alloc_allocatable_3d_6arg (ptr, is, ie, js, je, ks, ke)
	Allocate a 3-d allocatable array based on its 6 index starting and ending values. More...

Detailed Description

Allocate a 2-d or 3-d allocatable array.

Definition at line 18 of file MOM_safe_alloc.F90.

Functions and subroutines

safe_alloc_allocatable_2d()

subroutine mom_safe_alloc::safe_alloc_alloc::safe_alloc_allocatable_2d ( real, dimension(:,:), allocatable  ptr, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je  )

private

Allocate a 2-d allocatable array based on its index starting and ending values.

Parameters

	ptr	An allocatable array to allocate
[in]	is	The start index to allocate for the 1st dimension
[in]	ie	The end index to allocate for the 1st dimension
[in]	js	The start index to allocate for the 2nd dimension
[in]	je	The end index to allocate for the 2nd dimension

Definition at line 116 of file MOM_safe_alloc.F90.

  real, dimension(:,:), allocatable :: ptr !< An allocatable array to allocate
  integer, intent(in) :: is !< The start index to allocate for the 1st dimension
  integer, intent(in) :: ie !< The end index to allocate for the 1st dimension
  integer, intent(in) :: js !< The start index to allocate for the 2nd dimension
  integer, intent(in) :: je !< The end index to allocate for the 2nd dimension
  if (.not.allocated(ptr)) then
    allocate(ptr(is:ie,js:je))
    ptr(:,:) = 0.0
  endif

safe_alloc_allocatable_3d()

subroutine mom_safe_alloc::safe_alloc_alloc::safe_alloc_allocatable_3d ( real, dimension(:,:,:), allocatable  ptr, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, integer, intent(in)  nk  )

private

Allocate a 3-d allocatable array based on its index starting and ending values and k-index size.

Parameters

	ptr	An allocatable array to allocate
[in]	is	The start index to allocate for the 1st dimension
[in]	ie	The end index to allocate for the 1st dimension
[in]	js	The start index to allocate for the 2nd dimension
[in]	je	The end index to allocate for the 2nd dimension
[in]	nk	The size to allocate for the 3rd dimension

Definition at line 130 of file MOM_safe_alloc.F90.

  real, dimension(:,:,:), allocatable :: ptr !< An allocatable array to allocate
  integer, intent(in) :: is !< The start index to allocate for the 1st dimension
  integer, intent(in) :: ie !< The end index to allocate for the 1st dimension
  integer, intent(in) :: js !< The start index to allocate for the 2nd dimension
  integer, intent(in) :: je !< The end index to allocate for the 2nd dimension
  integer, intent(in) :: nk !< The size to allocate for the 3rd dimension
  if (.not.allocated(ptr)) then
    allocate(ptr(is:ie,js:je,nk))
    ptr(:,:,:) = 0.0
  endif

safe_alloc_allocatable_3d_6arg()

subroutine mom_safe_alloc::safe_alloc_alloc::safe_alloc_allocatable_3d_6arg ( real, dimension(:,:,:), allocatable  ptr, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, integer, intent(in)  ks, integer, intent(in)  ke  )

private

Allocate a 3-d allocatable array based on its 6 index starting and ending values.

Parameters

	ptr	An allocatable array to allocate
[in]	is	The start index to allocate for the 1st dimension
[in]	ie	The end index to allocate for the 1st dimension
[in]	js	The start index to allocate for the 2nd dimension
[in]	je	The end index to allocate for the 2nd dimension
[in]	ks	The start index to allocate for the 3rd dimension
[in]	ke	The end index to allocate for the 3rd dimension

Definition at line 144 of file MOM_safe_alloc.F90.

  real, dimension(:,:,:), allocatable :: ptr !< An allocatable array to allocate
  integer, intent(in) :: is !< The start index to allocate for the 1st dimension
  integer, intent(in) :: ie !< The end index to allocate for the 1st dimension
  integer, intent(in) :: js !< The start index to allocate for the 2nd dimension
  integer, intent(in) :: je !< The end index to allocate for the 2nd dimension
  integer, intent(in) :: ks !< The start index to allocate for the 3rd dimension
  integer, intent(in) :: ke !< The end index to allocate for the 3rd dimension
  if (.not.allocated(ptr)) then
    allocate(ptr(is:ie,js:je,ks:ke))
    ptr(:,:,:) = 0.0
  endif

---

The documentation for this interface was generated from the following file:

• /home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90