mom_safe_alloc module reference

Convenience functions for safely allocating memory without accidentally reallocating pointer and causing memory leaks.

Functions/Subroutines

`safe_alloc_ptr_1d()`	Allocate a pointer to a 1-d array.
`safe_alloc_ptr_2d_2arg()`	Allocate a pointer to a 2-d array based on its dimension sizes.
`safe_alloc_ptr_3d_3arg()`	Allocate a pointer to a 3-d array based on its dimension sizes.
`safe_alloc_ptr_2d()`	Allocate a pointer to a 2-d array based on its index starting and ending values.
`safe_alloc_ptr_3d()`	Allocate a pointer to a 3-d array based on its index starting and ending values.
`safe_alloc_ptr_3d_6arg()`	Allocate a pointer to a 3-d array based on its index starting and ending values.
`safe_alloc_allocatable_2d()`	Allocate a 2-d allocatable array based on its index starting and ending values.
`safe_alloc_allocatable_3d()`	Allocate a 3-d allocatable array based on its index starting and ending values and k-index size.
`safe_alloc_allocatable_3d_6arg()`	Allocate a 3-d allocatable array based on its 6 index starting and ending values.

Detailed Description

Convenience functions for safely allocating memory without accidentally reallocating pointer and causing memory leaks.

Function/Subroutine Documentation

subroutine mom_safe_alloc/safe_alloc_ptr_1d(ptr, i1, i2)

Allocate a pointer to a 1-d array.

Parameters:

ptr :: ptr A pointer to allocate
i1 :: i1 [in] The size of the array, or its starting index if i2 is present
i2 :: i2 [in] The ending index of the array

[source]

subroutine mom_safe_alloc/safe_alloc_ptr_2d_2arg(ptr, ni, nj)

Allocate a pointer to a 2-d array based on its dimension sizes.

Parameters:

ptr :: ptr A pointer to allocate
ni :: ni [in] The size of the 1st dimension of the array
nj :: nj [in] The size of the 2nd dimension of the array

[source]

subroutine mom_safe_alloc/safe_alloc_ptr_3d_3arg(ptr, ni, nj, nk)

Allocate a pointer to a 3-d array based on its dimension sizes.

Parameters:

ptr :: ptr A pointer to allocate
ni :: ni [in] The size of the 1st dimension of the array
nj :: nj [in] The size of the 2nd dimension of the array
nk :: nk [in] The size of the 3rd dimension of the array

[source]

subroutine mom_safe_alloc/safe_alloc_ptr_2d(ptr, is, ie, js, je)

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

Parameters:

ptr :: ptr A pointer to allocate
is :: is [in] The start index to allocate for the 1st dimension
ie :: ie [in] The end index to allocate for the 1st dimension
js :: js [in] The start index to allocate for the 2nd dimension
je :: je [in] The end index to allocate for the 2nd dimension

[source]

subroutine mom_safe_alloc/safe_alloc_ptr_3d(ptr, is, ie, js, je, nk)

Allocate a pointer to a 3-d array based on its index starting and ending values.

Parameters:

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

[source]

subroutine mom_safe_alloc/safe_alloc_ptr_3d_6arg(ptr, is, ie, js, je, ks, ke)

Allocate a pointer to a 3-d array based on its index starting and ending values.

Parameters:

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

[source]

subroutine mom_safe_alloc/safe_alloc_allocatable_2d(ptr, is, ie, js, je)

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

Parameters:

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

[source]

subroutine mom_safe_alloc/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.

Parameters:

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

[source]

subroutine mom_safe_alloc/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.

Parameters:

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

[source]