fms_diag_check_out_of_bounds Interface Reference

Public 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.
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.

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
	)

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]	ofb	The output field buffer to check
[in,out]	bounds	The bounding box to check against
[in]	output_name	output name for placing in error message
[in]	module_name	module name for placing in error message
[in,out]	err_msg	Return 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
	)

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]	ofb	The output field buffer to check
[in,out]	bounds	The bounding box to check against
[in]	output_name	output name for placing in error message
[in]	module_name	module name for placing in error message
[out]	err_msg	Return 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:

• diag_manager/diag_util.F90 (e2e918950c7c3e4e94b1f05743a54a51955657b1)