Detailed Description

A wrapper for register_diag_field_array()

Definition at line 12 of file MOM_diag_manager_wrapper.F90.

Public functions
integer function	register_diag_field_array_fms (module_name, field_name, axes, init_time, long_name, units, missing_value, range, mask_variant, standard_name, verbose, do_not_log, err_msg, interp_method, tile_count, area)
	An integer handle for a diagnostic array returned by register_diag_field() More...

integer function	register_diag_field_scalar_fms (module_name, field_name, init_time, long_name, units, missing_value, range, mask_variant, standard_name, verbose, do_not_log, err_msg, interp_method, tile_count, area)
	An integer handle for a diagnostic scalar array returned by register_diag_field() More...

Functions and subroutines

◆ register_diag_field_array_fms()

integer function mom_diag_manager_wrapper::register_diag_field_fms::register_diag_field_array_fms	(	character(len=*), intent(in)	module_name,
		character(len=*), intent(in)	field_name,
		integer, dimension(:), intent(in)	axes,
		type(time_type), intent(in)	init_time,
		character(len=*), intent(in), optional	long_name,
		character(len=*), intent(in), optional	units,
		real, intent(in), optional	missing_value,
		real, dimension(2), intent(in), optional	range,
		logical, intent(in), optional	mask_variant,
		character(len=*), intent(in), optional	standard_name,
		logical, intent(in), optional	verbose,
		logical, intent(in), optional	do_not_log,
		character(len=*), intent(out), optional	err_msg,
		character(len=*), intent(in), optional	interp_method,
		integer, intent(in), optional	tile_count,
		integer, intent(in), optional	area
	)

An integer handle for a diagnostic array returned by register_diag_field()

Parameters

[in]	module_name	Name of this module, usually "ocean_model" or "ice_shelf_model"
[in]	field_name	Name of the diagnostic field
[in]	axes	Container w/ up to 3 integer handles that indicates axes for this field
[in]	init_time	Time at which a field is first available?
[in]	long_name	Long name of a field.
[in]	units	Units of a field.
[in]	standard_name	Standardized name associated with a field
[in]	missing_value	A value that indicates missing values.
[in]	range	Valid range of a variable (not used in MOM?)
[in]	mask_variant	If true a logical mask must be provided with post_data calls (not used in MOM?)
[in]	verbose	If true, FMS is verbose (not used in MOM?)
[in]	do_not_log	If true, do not log something (not used in MOM?)
[out]	err_msg	String into which an error message might be placed (not used in MOM?)
[in]	interp_method	If 'none' indicates the field should not be interpolated as a scalar
[in]	tile_count	no clue (not used in MOM?)
[in]	area	The FMS id of cell area

Definition at line 22 of file MOM_diag_manager_wrapper.F90.

   character(len=*), intent(in) :: module_name             !< Name of this module, usually "ocean_model" or "ice_shelf_model"
   character(len=*), intent(in) :: field_name              !< Name of the diagnostic field
   integer,          intent(in) :: axes(:)                 !< Container w/ up to 3 integer handles that indicates axes for this field
   type(time_type),  intent(in) :: init_time               !< Time at which a field is first available?
   character(len=*), optional, intent(in) :: long_name     !< Long name of a field.
   character(len=*), optional, intent(in) :: units         !< Units of a field.
   character(len=*), optional, intent(in) :: standard_name !< Standardized name associated with a field
   real,             optional, intent(in) :: missing_value !< A value that indicates missing values.
   real,             optional, intent(in) :: range(2)      !< Valid range of a variable (not used in MOM?)
   logical,          optional, intent(in) :: mask_variant  !< If true a logical mask must be provided with post_data calls (not used in MOM?)
   logical,          optional, intent(in) :: verbose       !< If true, FMS is verbose (not used in MOM?)
   logical,          optional, intent(in) :: do_not_log    !< If true, do not log something (not used in MOM?)
   character(len=*), optional, intent(out):: err_msg       !< String into which an error message might be placed (not used in MOM?)
   character(len=*), optional, intent(in) :: interp_method !< If 'none' indicates the field should not be interpolated as a scalar
   integer,          optional, intent(in) :: tile_count    !< no clue (not used in MOM?)
   integer,          optional, intent(in) :: area          !< The FMS id of cell area
   ! Local variables
 
   register_diag_field_array_fms = register_diag_field(module_name, field_name, axes,   &
              init_time, long_name=long_name, units=units, missing_value=missing_value, &
              mask_variant=mask_variant, standard_name=standard_name,                   &
              verbose=verbose, do_not_log=do_not_log, err_msg=err_msg,                  &
              interp_method=interp_method)
 

◆ register_diag_field_scalar_fms()

integer function mom_diag_manager_wrapper::register_diag_field_fms::register_diag_field_scalar_fms	(	character(len=*), intent(in)	module_name,
		character(len=*), intent(in)	field_name,
		type(time_type), intent(in)	init_time,
		character(len=*), intent(in), optional	long_name,
		character(len=*), intent(in), optional	units,
		real, intent(in), optional	missing_value,
		real, dimension(2), intent(in), optional	range,
		logical, intent(in), optional	mask_variant,
		character(len=*), intent(in), optional	standard_name,
		logical, intent(in), optional	verbose,
		logical, intent(in), optional	do_not_log,
		character(len=*), intent(out), optional	err_msg,
		character(len=*), intent(in), optional	interp_method,
		integer, intent(in), optional	tile_count,
		integer, intent(in), optional	area
	)

An integer handle for a diagnostic scalar array returned by register_diag_field()

Parameters

[in]	module_name	Name of this module, usually "ocean_model" or "ice_shelf_model"
[in]	field_name	Name of the diagnostic field
[in]	init_time	Time at which a field is first available?
[in]	long_name	Long name of a field.
[in]	units	Units of a field.
[in]	standard_name	Standardized name associated with a field
[in]	missing_value	A value that indicates missing values.
[in]	range	Valid range of a variable (not used in MOM?)
[in]	mask_variant	If true a logical mask must be provided with post_data calls (not used in MOM?)
[in]	verbose	If true, FMS is verbose (not used in MOM?)
[in]	do_not_log	If true, do not log something (not used in MOM?)
[out]	err_msg	String into which an error message might be placed (not used in MOM?)
[in]	interp_method	If 'none' indicates the field should not be interpolated as a scalar
[in]	tile_count	no clue (not used in MOM?)
[in]	area	The FMS id of cell area (not used for scalars)

Definition at line 52 of file MOM_diag_manager_wrapper.F90.

   character(len=*), intent(in) :: module_name             !< Name of this module, usually "ocean_model" or "ice_shelf_model"
   character(len=*), intent(in) :: field_name              !< Name of the diagnostic field
   type(time_type),  intent(in) :: init_time               !< Time at which a field is first available?
   character(len=*), optional, intent(in) :: long_name     !< Long name of a field.
   character(len=*), optional, intent(in) :: units         !< Units of a field.
   character(len=*), optional, intent(in) :: standard_name !< Standardized name associated with a field
   real,             optional, intent(in) :: missing_value !< A value that indicates missing values.
   real,             optional, intent(in) :: range(2)      !< Valid range of a variable (not used in MOM?)
   logical,          optional, intent(in) :: mask_variant  !< If true a logical mask must be provided with post_data calls (not used in MOM?)
   logical,          optional, intent(in) :: verbose       !< If true, FMS is verbose (not used in MOM?)
   logical,          optional, intent(in) :: do_not_log    !< If true, do not log something (not used in MOM?)
   character(len=*), optional, intent(out):: err_msg       !< String into which an error message might be placed (not used in MOM?)
   character(len=*), optional, intent(in) :: interp_method !< If 'none' indicates the field should not be interpolated as a scalar
   integer,          optional, intent(in) :: tile_count    !< no clue (not used in MOM?)
   integer,          optional, intent(in) :: area          !< The FMS id of cell area (not used for scalars)
   ! Local variables
 
   register_diag_field_scalar_fms = register_diag_field(module_name, field_name,        &
              init_time, long_name=long_name, units=units, missing_value=missing_value, &
              standard_name=standard_name, do_not_log=do_not_log, err_msg=err_msg)
 

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

/home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/framework/MOM_diag_manager_wrapper.F90

Detailed Description

Public functions

Functions and subroutines

◆ register_diag_field_array_fms()

◆ register_diag_field_scalar_fms()