Interface Function PE_minval

[ c_92_rp1 release ]

Description:

PE_minval returns the smallest value of a scalar or array on a set of PEs. If the input is a scalar, the result is obviously the smallest number on all PEs, but when a vector or array is passed, special care must be exercised: All PEs must have the same shape and rank. The result has the same shape and rank as the imput. Each element of the result array is the min of the corresponding element of the input array over all the PEs.

Do not use this routine in 2-d array form to find a global minimum of an array decomposed onto a number of PEs, because it is likely that PEs will have different sizes. Instead, find the local minima on each PE and use the scalar form.

In a GCM, a vector form might be used to get a minimum for each layer of a state: For an array A(i,j,k), let temp(k) = MINVAL(A(:,:,k)), then use PE_minval on temp(:)

Overloaded Syntax:

REAL(REALSHORT) :: array

LOGICAL :: mask

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALSHORT) :: RESULT

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALSHORT) :: array(:)

LOGICAL :: mask(:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALSHORT) :: RESULT(SIZE(ARRAY,1))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALSHORT) :: array(:,:)

LOGICAL :: mask(:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALSHORT) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALSHORT) :: array(:,:,:)

LOGICAL :: mask(:,:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALSHORT) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2),SIZE(ARRAY,3))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALSHORT) :: array(:,:,:,:)

LOGICAL :: mask(:,:,:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALSHORT) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2),SIZE(ARRAY,3),SIZE(ARRAY,4))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

INTEGER(INTSHORT) :: array

LOGICAL :: mask

INTEGER :: PE(0:)

INTEGER :: communicator

INTEGER(INTSHORT) :: RESULT

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

INTEGER(INTSHORT) :: array(:)

LOGICAL :: mask(:)

INTEGER :: PE(0:)

INTEGER :: communicator

INTEGER(INTSHORT) :: RESULT(SIZE(ARRAY,1))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

INTEGER(INTSHORT) :: array(:,:)

LOGICAL :: mask(:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

INTEGER(INTSHORT) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

INTEGER(INTSHORT) :: array(:,:,:)

LOGICAL :: mask(:,:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

INTEGER(INTSHORT) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2),SIZE(ARRAY,3))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

INTEGER(INTSHORT) :: array(:,:,:,:)

LOGICAL :: mask(:,:,:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

INTEGER(INTSHORT) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2),SIZE(ARRAY,3),SIZE(ARRAY,4))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALHIGH) :: array

LOGICAL :: mask

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALHIGH) :: RESULT

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALHIGH) :: array(:)

LOGICAL :: mask(:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALHIGH) :: RESULT(SIZE(ARRAY,1))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALHIGH) :: array(:,:)

LOGICAL :: mask(:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALHIGH) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALHIGH) :: array(:,:,:)

LOGICAL :: mask(:,:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALHIGH) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2),SIZE(ARRAY,3))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

REAL(REALHIGH) :: array(:,:,:,:)

LOGICAL :: mask(:,:,:,:)

INTEGER :: PE(0:)

INTEGER :: communicator

REAL(REALHIGH) :: RESULT(SIZE(ARRAY,1),SIZE(ARRAY,2),SIZE(ARRAY,3),SIZE(ARRAY,4))

RESULT = PE_minval(array, [mask], [PE], [communicator])

INTENT(IN) :: array,mask,PE,communicator

Legend:

INTENT(INOUT)

INTENT(IN)

INTENT(OUT)

[OPTIONAL]

Poseidon Ocean Model (Release: c_92_rp1 )

Documentation automation by Paul Schopf's DocFort Perl scripts.