mom_interpolate module reference

This module provides added functionality to the FMS temporal and spatial interpolation routines.

More…

Functions/Subroutines

time_interp_external_0d()

Read a scalar field based on model time.

time_interp_external_2d()

Read a 2d field from an external based on model time, potentially including horizontal interpolation and rotation of the data.

time_interp_external_3d()

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

Detailed Description

This module provides added functionality to the FMS temporal and spatial interpolation routines.

Function/Subroutine Documentation

subroutine mom_interpolate/time_interp_external_0d(field_id, time, data_in, verbose)

Read a scalar field based on model time.

Parameters
  • field_id :: [in] The integer index of the external field returned from a previous call to init_external_field()

  • time :: [in] The target time for the data

  • data_in :: [inout] The interpolated value

  • verbose :: [in] If true, write verbose output for debugging

subroutine mom_interpolate/time_interp_external_2d(field_id, time, data_in, interp, verbose, horz_interp, mask_out, turns)

Read a 2d field from an external based on model time, potentially including horizontal interpolation and rotation of the data.

Parameters
  • field_id :: [in] The integer index of the external field returned from a previous call to init_external_field()

  • time :: [in] The target time for the data

  • data_in :: [inout] The array in which to store the interpolated values

  • interp :: [in] A flag indicating the temporal interpolation method

  • verbose :: [in] If true, write verbose output for debugging

  • horz_interp :: [in] A structure to control horizontal interpolation

  • mask_out :: [out] An array that is true where there is valid data

  • turns :: [in] Number of quarter turns to rotate the data

Call to

mom_error_handler::mom_error

subroutine mom_interpolate/time_interp_external_3d(field_id, time, data_in, interp, verbose, horz_interp, mask_out, turns)

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

Parameters
  • field_id :: [in] The integer index of the external field returned from a previous call to init_external_field()

  • time :: [in] The target time for the data

  • data_in :: [inout] The array in which to store the interpolated values

  • interp :: [in] A flag indicating the temporal interpolation method

  • verbose :: [in] If true, write verbose output for debugging

  • horz_interp :: [in] A structure to control horizontal interpolation

  • mask_out :: [out] An array that is true where there is valid data

  • turns :: [in] Number of quarter turns to rotate the data

Call to

mom_error_handler::mom_error