mom_transform_fms module reference

Support functions and interfaces to permit transformed model domains to interact with FMS operations registered on the non-transformed domains.

More…

Functions/Subroutines

rotated_mpp_chksum_real_0d()	Compute the FMS (mpp) checksum of a scalar.
rotated_mpp_chksum_real_1d()	Compute the FMS (mpp) checksum of a 1d field.
rotated_mpp_chksum_real_2d()	Compute the FMS (mpp) checksum of a rotated 2d field.
rotated_mpp_chksum_real_3d()	Compute the FMS (mpp) checksum of a rotated 3d field.
rotated_mpp_chksum_real_4d()	Compute the FMS (mpp) checksum of a rotated 4d field.
rotated_write_field_real_0d()	Write the rotation of a 1d field to an FMS output file This function is provided to support the full FMS write_field interface.
rotated_write_field_real_1d()	Write the rotation of a 1d field to an FMS output file This function is provided to support the full FMS write_field interface.
rotated_write_field_real_2d()	Write the rotation of a 2d field to an FMS output file.
rotated_write_field_real_3d()	Write the rotation of a 3d field to an FMS output file.
rotated_write_field_real_4d()	Write the rotation of a 4d field to an FMS output file.
rotated_time_interp_external_0d()	Read a scalar field based on model time This function is provided to support the full FMS time_interp_external interface.
rotated_time_interp_external_2d()	Read a 2d field based on model time, and rotate to the model grid.
rotated_time_interp_external_3d()	Read a 3d field based on model time, and rotate to the model grid.

Detailed Description

Support functions and interfaces to permit transformed model domains to interact with FMS operations registered on the non-transformed domains.

Function/Subroutine Documentation

function mom_transform_fms/rotated_mpp_chksum_real_0d(field, pelist, mask_val, turns) [integer]

Compute the FMS (mpp) checksum of a scalar. This function is provided to support the full FMS mpp_chksum interface.

Call to

mom_error_handler::mom_error

function mom_transform_fms/rotated_mpp_chksum_real_1d(field, pelist, mask_val, turns) [integer]

Compute the FMS (mpp) checksum of a 1d field. This function is provided to support the full FMS mpp_chksum interface.

Call to

mom_error_handler::mom_error

function mom_transform_fms/rotated_mpp_chksum_real_2d(field, pelist, mask_val, turns) [integer]

Compute the FMS (mpp) checksum of a rotated 2d field.

function mom_transform_fms/rotated_mpp_chksum_real_3d(field, pelist, mask_val, turns) [integer]

Compute the FMS (mpp) checksum of a rotated 3d field.

function mom_transform_fms/rotated_mpp_chksum_real_4d(field, pelist, mask_val, turns) [integer]

Compute the FMS (mpp) checksum of a rotated 4d field.

subroutine mom_transform_fms/rotated_write_field_real_0d(io_unit, field_md, field, tstamp, turns)

Write the rotation of a 1d field to an FMS output file This function is provided to support the full FMS write_field interface.

Call to

mom_error_handler::mom_error

subroutine mom_transform_fms/rotated_write_field_real_1d(io_unit, field_md, field, tstamp, turns)

Write the rotation of a 1d field to an FMS output file This function is provided to support the full FMS write_field interface.

Call to

mom_error_handler::mom_error

subroutine mom_transform_fms/rotated_write_field_real_2d(io_unit, field_md, domain, field, tstamp, tile_count, default_data, turns)

Write the rotation of a 2d field to an FMS output file.

subroutine mom_transform_fms/rotated_write_field_real_3d(io_unit, field_md, domain, field, tstamp, tile_count, default_data, turns)

Write the rotation of a 3d field to an FMS output file.

subroutine mom_transform_fms/rotated_write_field_real_4d(io_unit, field_md, domain, field, tstamp, tile_count, default_data, turns)

Write the rotation of a 4d field to an FMS output file.

subroutine mom_transform_fms/rotated_time_interp_external_0d(fms_id, time, data_in, verbose, turns)

Read a scalar field based on model time This function is provided to support the full FMS time_interp_external interface.

Parameters

• fms_id :: [in] FMS field ID

• time :: [in] Model time

• data_in :: [inout] field to write data

• verbose :: [in] Verbose output

• turns :: [in] Number of quarter turns

Call to

mom_error_handler::mom_error

subroutine mom_transform_fms/rotated_time_interp_external_2d(fms_id, time, data_in, interp, verbose, horz_interp, mask_out, is_in, ie_in, js_in, je_in, window_id, turns)

Read a 2d field based on model time, and rotate to the model grid.

Call to

mom_error_handler::mom_error

subroutine mom_transform_fms/rotated_time_interp_external_3d(fms_id, time, data_in, interp, verbose, horz_interp, mask_out, is_in, ie_in, js_in, je_in, window_id, turns)

Read a 3d field based on model time, and rotate to the model grid.

Call to

mom_error_handler::mom_error