FMS  2024.03
Flexible Modeling System
fms_diag_check_out_of_bounds Interface Reference

Private Member Functions

subroutine fms_diag_check_out_of_bounds_r4 (ofb, bounds, output_name, module_name, err_msg)
 Checks if the array indices for output_fields(out_num) are outside the output_fields(out_num)buffer upper and lower bounds. If there is an error then error message will be filled. More...
 
subroutine fms_diag_check_out_of_bounds_r8 (ofb, bounds, output_name, module_name, err_msg)
 Checks if the array indices for output_field buffer (ofb) are outside the are outside the bounding box (bounds). If there is an error then error message will be filled. More...
 

Detailed Description

Definition at line 103 of file diag_util.F90.

Member Function/Subroutine Documentation

◆ fms_diag_check_out_of_bounds_r4()

subroutine fms_diag_check_out_of_bounds_r4 ( real(kind=r4_kind), dimension(:,:,:,:,:), intent(in)  ofb,
type (fmsdiagibounds_type), intent(inout)  bounds,
character(:), intent(in), allocatable  output_name,
character(:), intent(in), allocatable  module_name,
character(len=*), intent(inout)  err_msg 
)
private

Checks if the array indices for output_fields(out_num) are outside the output_fields(out_num)buffer upper and lower bounds. If there is an error then error message will be filled.

Parameters
[in]ofbThe output field buffer to check
[in,out]boundsThe bounding box to check against
[in]output_nameoutput name for placing in error message
[in]module_namemodule name for placing in error message
[in,out]err_msgReturn status of check_out_of_bounds. An empty error string indicates the x, y, and z indices are not outside the

Definition at line 874 of file diag_util.F90.

◆ fms_diag_check_out_of_bounds_r8()

subroutine fms_diag_check_out_of_bounds_r8 ( real(kind=r8_kind), dimension(:,:,:,:,:), intent(in)  ofb,
type (fmsdiagibounds_type), intent(inout)  bounds,
character(:), intent(in), allocatable  output_name,
character(:), intent(in), allocatable  module_name,
character(len=*), intent(out)  err_msg 
)
private

Checks if the array indices for output_field buffer (ofb) are outside the are outside the bounding box (bounds). If there is an error then error message will be filled.

Parameters
[in]ofbThe output field buffer to check
[in,out]boundsThe bounding box to check against
[in]output_nameoutput name for placing in error message
[in]module_namemodule name for placing in error message
[out]err_msgReturn status of check_out_of_bounds. An empty error string indicates the x, y, and z indices are not outside the

Definition at line 906 of file diag_util.F90.


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