mom_io module reference

This module contains I/O framework code.

Data Types

`axis_info`	Type that stores information that can be used to create a non-decomposed axis.
`vardesc`	Type for describing a 3-d variable for output.
`attribute_info`	Type that stores for a global file attribute.

Functions/Subroutines

`create_file()`	`create_MOM_file` wrapper for the legacy file handle, `file_type`. NOTE: This function may be removed in a future release.
`create_mom_file()`
`reopen_file()`	`reopen_MOM_file` wrapper for the legacy file handle, `file_type`. NOTE: This function may be removed in a future release.
`reopen_mom_file()`	This routine opens an existing NetCDF file for output.
`stdout_if_root()`	Return the index of sdtout if called from the root PE, or 0 for other PEs.
`num_timelevels()`	This function determines how many time levels a variable has in a file.
`get_var_sizes()`	get_var_sizes returns the number and size of dimensions associate with a variable in a file. Usually only the root PE does the read, and then the information is broadcast
`read_var_sizes()`	read_var_sizes returns the number and size of dimensions associated with a variable in a file. If the variable is not in the file the returned sizes are all 0 and ndims is -1. Every processor for which this is called does the reading.
`read_variable_0d()`	Read a real scalar variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.
`read_variable_1d()`	Read a 1-d real variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.
`read_variable_0d_int()`	Read a integer scalar variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.
`read_variable_1d_int()`	Read a 1-d integer variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.
`read_variable_2d()`	Read a 2d array from a netCDF input file and save to a variable.
`read_variable_3d()`
`read_attribute_str()`	Read a character-string global or variable attribute.
`read_attribute_int32()`	Read a 32-bit integer global or variable attribute.
`read_attribute_int64()`	Read a 64-bit integer global or variable attribute.
`read_attribute_real()`	Read a real global or variable attribute.
`open_file_to_read()`	Open a netcdf file for reading, with error handling.
`close_file_to_read()`	Close a netcdf file that had been opened for reading, with error handling.
`get_varid()`	get_varid finds the netcdf handle for the potentially case-insensitive variable name in a file
`verify_variable_units()`	Verify that a file contains a named variable with the expected units.
`var_desc()`	Returns a vardesc type whose elements have been filled with the provided fields.
`modify_vardesc()`	This routine modifies the named elements of a vardesc type.
`position_from_horgrid()`
`set_axis_info()`	Store information that can be used to create an axis in a subsequent call to create_file.
`delete_axis_info()`	Delete the information in an array of `axis_info()` types and deallocate memory in them.
`get_axis_info()`	Retrieve the information from an `axis_info()` type.
`set_attribute_info()`	Store information that can be used to create an attribute in a subsequent call to create_file.
`delete_attribute_info()`	Delete the information in an array of `attribute_info()` types and deallocate memory in them.
`cmor_long_std()`	This function returns the CMOR standard name given a CMOR longname, based on the standard pattern of character conversions.
`query_vardesc()`	This routine queries vardesc.
`mom_read_data_0d()`	Read a scalar from file using infrastructure I/O.
`mom_read_data_0d_int()`	Read a scalar integer from file using infrastructure I/O.
`mom_read_data_1d()`	Read a 1d array from file using infrastructure I/O.
`mom_read_data_1d_int()`	Read a 1d integer array from file using infrastructure I/O.
`mom_read_data_2d()`	Read a 2d array from file using infrastructure I/O.
`read_netcdf_data_2d()`	Read a 2d array (which might have halos) from a file using native netCDF I/O.
`mom_read_data_2d_region()`	Read a 2d region array from file using infrastructure I/O.
`mom_read_data_3d()`	Read a 3d array from file using infrastructure I/O.
`mom_read_data_3d_region()`	Read a 3d region array from file using infrastructure I/O.
`mom_read_data_4d()`	Read a 4d array from file using infrastructure I/O.
`mom_read_vector_2d()`	Read a 2d vector tuple from file using infrastructure I/O.
`mom_read_vector_3d()`	Read a 3d vector tuple from file using infrastructure I/O.
`mom_write_field_legacy_4d()`	Write a 4d field to an output file, potentially with rotation.
`mom_write_field_legacy_3d()`	Write a 3d field to an output file, potentially with rotation.
`mom_write_field_legacy_2d()`	Write a 2d field to an output file, potentially with rotation.
`mom_write_field_legacy_1d()`	Write a 1d field to an output file.
`mom_write_field_legacy_0d()`	Write a 0d field to an output file.
`mom_write_field_4d()`	Write a 4d field to an output file, potentially with rotation.
`mom_write_field_3d()`	Write a 3d field to an output file, potentially with rotation.
`mom_write_field_2d()`	Write a 2d field to an output file, potentially with rotation.
`mom_write_field_1d()`	Write a 1d field to an output file.
`mom_write_field_0d()`	Write a 0d field to an output file.
`field_size()`	Given filename and fieldname, this subroutine returns the size of the field in the file.
`safe_string_copy()`	Copies a string.
`ensembler()`	Returns a name with "%#E" or "%E" replaced with the ensemble member number.
`get_filename_appendix()`	Provide a string to append to filenames, to differentiate ensemble members, for example.
`write_version_number()`	Write a file version number to the log file or other output file.
`open_namelist_file()`	Open a single namelist file that is potentially readable by all PEs.
`check_nml_error()`	Checks the iostat argument that is returned after reading a namelist variable and writes a message if there is an error.
`mom_io_init()`	Initialize the MOM_io module.
`get_var_axes_info()`	Returns the dimension variable information for a netCDF variable.

Detailed Description

This file contains a number of subroutines that manipulate NetCDF files and handle input and output of fields. These subroutines, along with their purpose, are:

create_file: create a new file and set up structures that are needed for subsequent output and write out the coordinates.
reopen_file: reopen an existing file for writing and set up structures that are needed for subsequent output.
open_input_file: open the indicated file for reading only.
close_file: close an open file.
synch_file: flush the buffers, completing all pending output.
write_field: write a field to an open file.
write_time: write a value of the time axis to an open file.
read_data: read a variable from an open file.
read_time: read a time from an open file.
name_output_file: provide a name for an output file based on a name root and the time of the output.
find_input_file: find a file that has been previously written by MOM and named by name_output_file and open it for reading.
handle_error: write an error code and quit.

Type Documentation

type mom_io/axis_info

Type that stores information that can be used to create a non-decomposed axis.

Type fields:

% name :: character(len=32), private The name of this axis for use in files.
% longname :: character(len=256), private A longer name describing this axis.
% units :: character(len=48), private The units of the axis labels.
% cartesian :: character(len=8), private A variable indicating which direction this axis corresponds with. Valid values include ‘X’, ‘Y’, ‘Z’, ‘T’, and ‘N’ for none.
% sense :: integer, private This is 1 for axes whose values increase upward, or -1 if they increase downward. The default, 0, is ignored.
% ax_size :: integer, private The number of elements in this axis.
% ax_data :: real, dimension(:), allocatable, private The values of the data on the axis [arbitrary].

[source]

type mom_io/vardesc

Type for describing a 3-d variable for output.

Type fields:

% name :: character(len=64) Variable name in a NetCDF file.
% units :: character(len=48) Physical dimensions of the variable.
% longname :: character(len=240) Long name of the variable.
% hor_grid :: character(len=8) Horizontal grid: u, v, h, q, Cu, Cv, T, Bu, or 1.
% z_grid :: character(len=8) Vertical grid: L, i, or 1.
% t_grid :: character(len=8) Time description: s, p, or 1.
% cmor_field_name :: character(len=64) CMOR name.
% cmor_units :: character(len=64) CMOR physical dimensions of the variable.
% cmor_longname :: character(len=240) CMOR long name of the variable.
% conversion :: real for unit conversions, such as needed to convert from intensive to extensive [various] or [a A-1 ~> 1] to undo internal dimensional rescaling
% dim_names :: character(len=32), dimension(5) The names in the file of the axes for this variable.
% position :: integer An integer encoding the horizontal position, it may CENTER, CORNER, EAST_FACE, NORTH_FACE, or 0.
% extra_axes :: type(axis_info), dimension(5) dimensions other than space-time

[source]

type mom_io/attribute_info

Type that stores for a global file attribute.

Type fields:

% name :: character(len=:), allocatable, private The name of this attribute.
% att_val :: character(len=:), allocatable, private The values of this attribute.

[source]

Function/Subroutine Documentation

subroutine mom_io/create_file(IO_handle, filename, vars, novars, fields, threading, timeunit, G, dG, GV, checksums, extra_axes, global_atts)

create_MOM_file wrapper for the legacy file handle, file_type. NOTE: This function may be removed in a future release.

Parameters:

io_handle :: [inout] Handle for a files or fileset that is to be opened or reopened for writing
filename :: filename [in] full path to the file to create
vars :: vars [in] structures describing fields written to filename
novars :: novars [in] number of fields written to filename
fields :: fields [inout] array of fieldtypes for each variable
threading :: threading [in] SINGLE_FILE or MULTIPLE
timeunit :: timeunit [in] length of the units for time [s]. The default value is 86400.0, for 1 day.
g :: [in] ocean horizontal grid structure; G or dG is required if the new file uses any horizontal grid axes.
dg :: [in] dynamic horizontal grid structure; G or dG is required if the new file uses any horizontal grid axes.
gv :: [in] ocean vertical grid structure, which is ! required if the new file uses any vertical grid axes.
checksums :: checksums [in] checksums of vars
extra_axes :: extra_axes [in] Types with information about some axes that might be used in this file
global_atts :: global_atts [in] Global attributes to write to this file

Call to:

create_mom_file

[source]

subroutine mom_io/create_mom_file(IO_handle, filename, vars, novars, fields, threading, timeunit, G, dG, GV, checksums, extra_axes, global_atts)

Parameters:

io_handle :: [inout] Handle for a files or fileset that is to be opened or reopened for writing
filename :: filename [in] full path to the file to create
vars :: vars [in] structures describing fields written to filename
novars :: novars [in] number of fields written to filename
fields :: fields [inout] array of fieldtypes for each variable
threading :: threading [in] SINGLE_FILE or MULTIPLE
timeunit :: timeunit [in] length of the units for time [s]. The default value is 86400.0, for 1 day.
g :: [in] ocean horizontal grid structure; G or dG is required if the new file uses any horizontal grid axes.
dg :: [in] dynamic horizontal grid structure; G or dG is required if the new file uses any horizontal grid axes.
gv :: [in] ocean vertical grid structure, which is required if the new file uses any vertical grid axes.
checksums :: checksums [in] checksums of vars
extra_axes :: extra_axes [in] Types with information about
global_atts :: global_atts [in] Global attributes to write to this file

Call to:

mom_string_functions::lowercase mom_error_handler::mom_error position_from_horgrid

Called from:

create_file mom_harmonic_analysis::ha_write reopen_mom_file mom_self_attr_load::sal_init

[source]

subroutine mom_io/reopen_file(IO_handle, filename, vars, novars, fields, threading, timeunit, G, dG, GV, extra_axes, global_atts)

reopen_MOM_file wrapper for the legacy file handle, file_type. NOTE: This function may be removed in a future release.

Parameters:

io_handle :: [inout] Handle for a file or fileset that is to be opened or reopened for writing
filename :: filename [in] full path to the file to create
vars :: vars [in] structures describing fields written to filename
novars :: novars [in] number of fields written to filename
fields :: fields [inout] array of fieldtypes for each variable
threading :: threading [in] SINGLE_FILE or MULTIPLE
timeunit :: timeunit [in] length of the units for time [s]. The default value is 86400.0, for 1 day.
g :: [in] ocean horizontal grid structure; G or dG is required if a new file uses any horizontal grid axes.
dg :: [in] dynamic horizontal grid structure; G or dG is required if a new file uses any horizontal grid axes.
gv :: [in] ocean vertical grid structure, which is required if a new file uses any vertical grid axes.
extra_axes :: extra_axes [in] Types with information about some axes that might be used in this file
global_atts :: global_atts [in] Global attributes to write to this file

Call to:

reopen_mom_file

[source]

subroutine mom_io/reopen_mom_file(IO_handle, filename, vars, novars, fields, threading, timeunit, G, dG, GV, extra_axes, global_atts)

This routine opens an existing NetCDF file for output. If it does not find the file, a new file is created. It also sets up structures that describe this file and the variables that will later be written to this file.

Parameters:

io_handle :: [inout] Handle for a file or fileset that is to be opened or reopened for writing
filename :: filename [in] full path to the file to create
vars :: vars [in] structures describing fields written to filename
novars :: novars [in] number of fields written to filename
fields :: fields [inout] array of fieldtypes for each variable
threading :: threading [in] SINGLE_FILE or MULTIPLE
timeunit :: timeunit [in] length of the units for time [s]. The default value is 86400.0, for 1 day.
g :: [in] ocean horizontal grid structure; G or dG is required if a new file uses any horizontal grid axes.
dg :: [in] dynamic horizontal grid structure; G or dG is required if a new file uses any horizontal grid axes.
gv :: [in] ocean vertical grid structure, which is required if a new file uses any vertical grid axes.
extra_axes :: extra_axes [in] Types with information about some axes that might be used in this file
global_atts :: global_atts [in] Global attributes to write to this file

Call to:

create_mom_file mom_error_handler::mom_error

Called from:

reopen_file

[source]

function mom_io/stdout_if_root()

Return the index of sdtout if called from the root PE, or 0 for other PEs.

Call to:: stdout
Called from:: mom_surface_forcing_gfdl::ice_ocn_bnd_type_chksum ocean_model_mod::ocean_public_type_chksum

[source]

function mom_io/num_timelevels(filename, varname, min_dims)

This function determines how many time levels a variable has in a file.

Parameters:

filename :: filename [in] name of the file to read
varname :: varname [in] variable whose number of time levels are to be returned
min_dims :: min_dims [in] The minimum number of dimensions a variable must have if it has a time dimension. If the variable has 1 less dimension than this, then 0 is returned.

Return:

undefined :: number of time levels varname has in filename

Call to:

get_var_sizes mom_error_handler::mom_error

Called from:

mom_surface_forcing::surface_forcing_init

[source]

subroutine mom_io/get_var_sizes(filename, varname, ndims, sizes, match_case, caller, all_read, dim_names, ncid_in)

get_var_sizes returns the number and size of dimensions associate with a variable in a file. Usually only the root PE does the read, and then the information is broadcast

Parameters:

filename :: filename [in] Name of the file to read, used here in messages
varname :: varname [in] The variable name, used here for messages
ndims :: ndims [out] The number of dimensions to the variable
sizes :: sizes [out] The dimension sizes, or 0 for extra values
match_case :: match_case [in] If false, allow for variables name matches to be case insensitive, but take a perfect match if found. The default is true.
caller :: caller [in] The name of a calling routine for use in error messages
all_read :: all_read [in] If present and true, all PEs that call this routine actually do the read, otherwise only root PE reads and then it broadcasts the results.
dim_names :: dim_names [out] The names of the dimensions for this variable
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

Call to:

read_var_sizes

Called from:

field_size num_timelevels

[source]

subroutine mom_io/read_var_sizes(filename, varname, ndims, sizes, match_case, caller, dim_names, ncid_in)

read_var_sizes returns the number and size of dimensions associated with a variable in a file. If the variable is not in the file the returned sizes are all 0 and ndims is -1. Every processor for which this is called does the reading.

Parameters:

filename :: filename [in] Name of the file to read, used here in messages
varname :: varname [in] The variable name, used here for messages
ndims :: ndims [out] The number of dimensions to the variable
sizes :: sizes [out] The dimension sizes, or 0 for extra values
match_case :: match_case [in] If false, allow for variables name matches to be case insensitive, but take a perfect match if found. The default is true.
caller :: caller [in] The name of a calling routine for use in error messages
dim_names :: dim_names [out] The names of the dimensions for this variable
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

Call to:

close_file_to_read get_varid mom_error_handler::mom_error open_file_to_read

Called from:

get_var_sizes

[source]

subroutine mom_io/read_variable_0d(filename, varname, var, ncid_in, scale)

Read a real scalar variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.

Parameters:

filename :: filename [in] The name of the file to read
varname :: varname [in] The variable name of the data in the file
var :: var [inout] The scalar into which to read the data in arbitrary units [A ~> a]
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]

[source]

subroutine mom_io/read_variable_1d(filename, varname, var, ncid_in, scale)

Read a 1-d real variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.

Parameters:

filename :: filename [in] The name of the file to read
varname :: varname [in] The variable name of the data in the file
var :: var [inout] The 1-d array into which to read the data in arbitrary units [A ~> a]
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]

[source]

subroutine mom_io/read_variable_0d_int(filename, varname, var, ncid_in)

Read a integer scalar variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.

Parameters:

filename :: filename [in] The name of the file to read
varname :: varname [in] The variable name of the data in the file
var :: var [inout] The scalar into which to read the data
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/read_variable_1d_int(filename, varname, var, ncid_in)

Read a 1-d integer variable from a netCDF file with the root PE, and broadcast the results to all the other PEs.

Parameters:

filename :: filename [in] The name of the file to read
varname :: varname [in] The variable name of the data in the file
var :: var [inout] The 1-d array into which to read the data
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/read_variable_2d(filename, varname, var, start, nread, ncid_in)

Read a 2d array from a netCDF input file and save to a variable.

Start and nread lenths may exceed var rank. This allows for reading slices of larger arrays.

Previous versions of the model required a time axis on IO fields. This constraint was dropped in later versions. As a result, versions both with and without a time axis now exist. In order to support all such versions, we use a reshaped version of start and nread in order to read the variable as it exists in the file.

Certain constraints are still applied to start and nread in order to ensure that varname is a valid 2d array, or contains valid 2d slices.

I/O occurs only on the root PE, and data is broadcast to other ranks. Due to potentially large memory communication and storage, this subroutine should only be used when domain-decomposition is unavaialable.

Parameters:

filename :: filename [in] Name of file to be read
varname :: varname [in] Name of variable to be read
var :: var [out] Output array of variable [arbitrary]
start :: start [in] Starting index on each axis.
nread :: nread [in] Number of values to be read along each axis
ncid_in :: ncid_in [in] netCDF ID of an opened file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/read_variable_3d(filename, varname, var, start, nread, ncid_in)

Parameters:

filename :: filename [in] Name of file to be read
varname :: varname [in] Name of variable to be read
var :: var [out] Output array of variable [arbitrary]
start :: start [in] Starting index on each axis.
nread :: nread [in] Number of values to be read along each axis
ncid_in :: ncid_in [in] netCDF ID of an opened file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/read_attribute_str(filename, attname, att_val, varname, found, all_read, ncid_in)

Read a character-string global or variable attribute.

Parameters:

filename :: filename [in] Name of the file to read
attname :: attname [in] Name of the attribute to read
att_val :: att_val [out] The value of the attribute
varname :: varname [in] The name of the variable whose attribute will be read. If missing, read a global attribute.
found :: found [out] Returns true if the attribute is found
all_read :: all_read [in] If present and true, all PEs that call this routine actually do the read, otherwise only root PE reads and then broadcasts the results.
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/read_attribute_int32(filename, attname, att_val, varname, found, all_read, ncid_in)

Read a 32-bit integer global or variable attribute.

Parameters:

filename :: filename [in] Name of the file to read
attname :: attname [in] Name of the attribute to read
att_val :: att_val [out] The value of the attribute
varname :: varname [in] The name of the variable whose attribute will be read. If missing, read a global attribute.
found :: found [out] Returns true if the attribute is found
all_read :: all_read [in] If present and true, all PEs that call this routine actually do the read, otherwise only root PE reads and then broadcasts the results.
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/read_attribute_int64(filename, attname, att_val, varname, found, all_read, ncid_in)

Read a 64-bit integer global or variable attribute.

Parameters:

filename :: filename [in] Name of the file to read
attname :: attname [in] Name of the attribute to read
att_val :: att_val [out] The value of the attribute
varname :: varname [in] The name of the variable whose attribute will be read. If missing, read a global attribute.
found :: found [out] Returns true if the attribute is found
all_read :: all_read [in] If present and true, all PEs that call this routine actually do the read, otherwise only root PE reads and then broadcasts the results.
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/read_attribute_real(filename, attname, att_val, varname, found, all_read, ncid_in)

Read a real global or variable attribute.

Parameters:

filename :: filename [in] Name of the file to read
attname :: attname [in] Name of the attribute to read
att_val :: att_val [out] The value of the attribute [arbitrary]
varname :: varname [in] The name of the variable whose attribute will be read. If missing, read a global attribute.
found :: found [out] Returns true if the attribute is found
all_read :: all_read [in] If present and true, all PEs that call this routine actually do the read, otherwise only root PE reads and then broadcasts the results.
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

[source]

subroutine mom_io/open_file_to_read(filename, ncid, success)

Open a netcdf file for reading, with error handling.

Parameters:

filename :: filename [in] path and name of the file to open for reading
ncid :: ncid [out] The netcdf handle for the file
success :: success [out] Returns true if the file was opened, or if this argument is not present, failure is fatal error.

Call to:

mom_error_handler::mom_error

Called from:

get_var_axes_info mom_io::read_attribute::read_attribute_int32 mom_io::read_attribute::read_attribute_int64 mom_io::read_attribute::read_attribute_real mom_io::read_attribute::read_attribute_str read_var_sizes mom_io::read_variable::read_variable_0d mom_io::read_variable::read_variable_0d_int mom_io::read_variable::read_variable_1d mom_io::read_variable::read_variable_1d_int mom_io::read_variable::read_variable_2d mom_io::read_variable::read_variable_3d mom_tracer_z_init::read_z_edges verify_variable_units

[source]

subroutine mom_io/close_file_to_read(ncid, filename)

Close a netcdf file that had been opened for reading, with error handling.

Parameters:

ncid :: ncid [inout] The netcdf handle for the file to close
filename :: filename [in] path and name of the file to close

Call to:

mom_error_handler::mom_error

Called from:

get_var_axes_info mom_io::read_attribute::read_attribute_int32 mom_io::read_attribute::read_attribute_real mom_io::read_attribute::read_attribute_str read_var_sizes mom_io::read_variable::read_variable_0d mom_io::read_variable::read_variable_0d_int mom_io::read_variable::read_variable_1d mom_io::read_variable::read_variable_1d_int mom_io::read_variable::read_variable_2d mom_io::read_variable::read_variable_3d mom_tracer_z_init::read_z_edges

[source]

subroutine mom_io/get_varid(varname, ncid, filename, varid, match_case, found)

get_varid finds the netcdf handle for the potentially case-insensitive variable name in a file

Parameters:

varname :: varname [in] The name of the variable that is being sought
ncid :: ncid [in] The open netcdf handle for the file
filename :: filename [in] name of the file to read, used here in messages
varid :: varid [out] The netcdf handle for the variable
match_case :: match_case [in] If false, allow for variables name matches to be case insensitive, but take a perfect match if found. The default is true.
found :: found [out] Returns true if the attribute is found

Call to:

mom_string_functions::lowercase mom_error_handler::mom_error

Called from:

mom_io::read_attribute::read_attribute_int32 mom_io::read_attribute::read_attribute_int64 mom_io::read_attribute::read_attribute_real mom_io::read_attribute::read_attribute_str read_var_sizes mom_io::read_variable::read_variable_0d mom_io::read_variable::read_variable_0d_int mom_io::read_variable::read_variable_1d mom_io::read_variable::read_variable_1d_int mom_io::read_variable::read_variable_2d mom_io::read_variable::read_variable_3d

[source]

subroutine mom_io/verify_variable_units(filename, varname, expected_units, msg, ierr, alt_units)

Verify that a file contains a named variable with the expected units.

Parameters:

filename :: filename [in] File name
varname :: varname [in] Variable name
expected_units :: expected_units [in] Expected units of variable
msg :: msg [inout] Message to use for errors
ierr :: ierr [out] True if an error occurs
alt_units :: alt_units [in] Alterate acceptable units of variable

Call to:

open_file_to_read

Called from:

mom_regridding::initialize_regridding

[source]

function mom_io/var_desc(name, units, longname, hor_grid, z_grid, t_grid, cmor_field_name, cmor_units, cmor_longname, conversion, caller, position, dim_names, extra_axes, fixed)

Returns a vardesc type whose elements have been filled with the provided fields. The argument name is required, while the others are optional and have default values that are empty strings or are appropriate for a 3-d tracer field at the tracer cell centers.

Parameters:

name :: name [in] variable name
units :: units [in] variable units
longname :: longname [in] variable long name
hor_grid :: hor_grid [in] A character string indicating the horizontal position of this variable
z_grid :: z_grid [in] variable vertical staggering
t_grid :: t_grid [in] time description: s, p, or 1
cmor_field_name :: cmor_field_name [in] CMOR name
cmor_units :: cmor_units [in] CMOR physical dimensions of variable
cmor_longname :: cmor_longname [in] CMOR long name
conversion :: conversion [in] for unit conversions, such as needed to convert from intensive to extensive [various] or [a A-1 ~> 1]
caller :: caller [in] The calling routine for error messages
position :: position [in] A coded integer indicating the horizontal position of this variable if it has such dimensions. Valid values include CORNER, CENTER, EAST_FACE NORTH_FACE, and 0 for no horizontal dimensions.
dim_names :: dim_names [in] The names of the dimensions of this variable
extra_axes :: extra_axes [in] dimensions other than space-time
fixed :: fixed [in] If true, this does not evolve with time

Return:

undefined :: vardesc type that is created

Call to:

modify_vardesc safe_string_copy

Called from:

mom_harmonic_analysis::ha_write mom_oda_incupd::output_oda_incupd_inc advection_test_tracer::register_advection_test_tracer mom_barotropic::register_barotropic_restarts boundary_impulse_tracer::register_boundary_impulse_tracer mom_cfc_cap::register_cfc_cap dome_tracer::register_dome_tracer regional_dyes::register_dye_tracer dyed_obc_tracer::register_dyed_obc_tracer ideal_age_example::register_ideal_age_tracer isomip_tracer::register_isomip_tracer marbl_tracers::register_marbl_tracers nw2_tracers::register_nw2_tracers mom_ocmip2_cfc::register_ocmip2_cfc oil_tracer::register_oil_tracer pseudo_salt_tracer::register_pseudo_salt_tracer mom_dynamics_split_rk2::register_restarts_dyn_split_rk2 mom_dynamics_split_rk2b::register_restarts_dyn_split_rk2b rgc_tracer::register_rgc_tracer mom_self_attr_load::sal_init mom_set_visc::set_visc_register_restarts user_tracer_example::user_register_tracer_example mom_wave_interface::waves_register_restarts mom_hybgen_regrid::write_hybgen_coord_file mom_coord_initialization::write_vertgrid_file

[source]

subroutine mom_io/modify_vardesc(vd, name, units, longname, hor_grid, z_grid, t_grid, cmor_field_name, cmor_units, cmor_longname, conversion, caller, position, dim_names, extra_axes)

This routine modifies the named elements of a vardesc type. All arguments are optional, except the vardesc type to be modified.

Parameters:

vd :: vd [inout] vardesc type that is modified
name :: name [in] name of variable
units :: units [in] units of variable
longname :: longname [in] long name of variable
hor_grid :: hor_grid [in] horizontal staggering of variable
z_grid :: z_grid [in] vertical staggering of variable
t_grid :: t_grid [in] time description: s, p, or 1
cmor_field_name :: cmor_field_name [in] CMOR name
cmor_units :: cmor_units [in] CMOR physical dimensions of variable
cmor_longname :: cmor_longname [in] CMOR long name
conversion :: conversion [in] A multiplicative factor for unit conversions, such as needed to convert from intensive to extensive or dimensional consistency testing [various] or [a A-1 ~> 1]
caller :: caller [in] The calling routine for error messages
position :: position [in] A coded integer indicating the horizontal position of this variable if it has such dimensions. Valid values include CORNER, CENTER, EAST_FACE NORTH_FACE, and 0 for no horizontal dimensions.
dim_names :: dim_names [in] The names of the dimensions of this variable
extra_axes :: extra_axes [in] dimensions other than space-time

Call to:

mom_error_handler::mom_error position_from_horgrid safe_string_copy

Called from:

var_desc

[source]

function mom_io/position_from_horgrid(hor_grid)

Parameters:: hor_grid :: hor_grid [in] horizontal staggering of variable
Called from:: create_mom_file modify_vardesc query_vardesc

[source]

subroutine mom_io/set_axis_info(axis, name, units, longname, ax_size, ax_data, cartesian, sense)

Store information that can be used to create an axis in a subsequent call to create_file.

Parameters:

axis :: axis [inout] A type with information about a named axis
name :: name [in] The name of this axis for use in files
units :: units [in] The units of the axis labels
longname :: longname [in] Long name of the axis variable
ax_size :: ax_size [in] The number of elements in this axis
ax_data :: ax_data [in] The values of the data on the axis [arbitrary]
cartesian :: cartesian [in] A variable indicating which direction this axis axis corresponds with. Valid values include ‘X’, ‘Y’, ‘Z’, ‘T’, and ‘N’ (the default) for none.
sense :: sense [in] This is 1 for axes whose values increase upward, or -1 if they increase downward. The default, 0, is ignored.

Call to:

mom_error_handler::mom_error safe_string_copy

Called from:

mom_streaming_filter::filt_register mom_interpolate::get_external_field_info get_var_axes_info query_vardesc mom_internal_tides::register_int_tide_restarts

[source]

subroutine mom_io/delete_axis_info(axes)

Delete the information in an array of axis_info() types and deallocate memory in them. types and deallocate memory in them.

Parameters:: axes :: axes [inout] An array with information about named axes

[source]

subroutine mom_io/get_axis_info(axis, name, longname, units, cartesian, ax_size, ax_data)

Retrieve the information from an axis_info() type. type.

Parameters:

axis :: axis [in] An axis type
name :: name [out] The axis name.
longname :: longname [out] The axis longname.
units :: units [out] The axis units.
cartesian :: cartesian [out] The cartesian attribute of the axis [X,Y,Z,T].
ax_size :: ax_size [out] The size of the axis.
ax_data :: ax_data [out] The axis label data [arbitrary]

[source]

subroutine mom_io/set_attribute_info(attribute, name, str_value)

Store information that can be used to create an attribute in a subsequent call to create_file.

Parameters:

attribute :: attribute [inout] A type with information about a named attribute
name :: name [in] The name of this attribute for use in files
str_value :: str_value [in] The value of this attribute

[source]

subroutine mom_io/delete_attribute_info(atts)

Delete the information in an array of attribute_info() types and deallocate memory in them. types and deallocate memory in them.

Parameters:: atts :: atts [inout] An array of global attributes

[source]

function mom_io/cmor_long_std(longname)

This function returns the CMOR standard name given a CMOR longname, based on the standard pattern of character conversions.

Parameters:: longname :: longname [in] The CMOR longname being converted
Return:: undefined :: The CMOR standard name generated from longname
Call to:: mom_string_functions::lowercase
Called from:: mom_tracer_registry::register_tracer_diagnostics

[source]

subroutine mom_io/query_vardesc(vd, name, units, longname, hor_grid, z_grid, t_grid, cmor_field_name, cmor_units, cmor_longname, conversion, caller, extra_axes, position, dim_names)

This routine queries vardesc.

Parameters:

vd :: vd [in] vardesc type that is queried
name :: name [out] name of variable
units :: units [out] units of variable
longname :: longname [out] long name of variable
hor_grid :: hor_grid [out] horizontal staggering of variable
z_grid :: z_grid [out] verticle staggering of variable
t_grid :: t_grid [out] time description: s, p, or 1
cmor_field_name :: cmor_field_name [out] CMOR name
cmor_units :: cmor_units [out] CMOR physical dimensions of variable
cmor_longname :: cmor_longname [out] CMOR long name
conversion :: conversion [out] for unit conversions, such as needed to convert from intensive to extensive [various] or [a A-1 ~> 1]
caller :: caller [in] calling routine?
extra_axes :: extra_axes [out] dimensions other than space-time
position :: position [out] A coded integer indicating the horizontal position of this variable if it has such dimensions. Valid values include CORNER, CENTER, EAST_FACE NORTH_FACE, and 0 for no horizontal dimensions.
dim_names :: dim_names [out] The names of the dimensions of this variable

Call to:

position_from_horgrid safe_string_copy set_axis_info

Called from:

advection_test_tracer::advection_test_stock boundary_impulse_tracer::boundary_impulse_stock mom_cfc_cap::cfc_cap_stock regional_dyes::dye_stock ideal_age_example::ideal_age_stock advection_test_tracer::initialize_advection_test_tracer boundary_impulse_tracer::initialize_boundary_impulse_tracer dome_tracer::initialize_dome_tracer dyed_obc_tracer::initialize_dyed_obc_tracer ideal_age_example::initialize_ideal_age_tracer isomip_tracer::initialize_isomip_tracer marbl_tracers::initialize_marbl_tracers oil_tracer::initialize_oil_tracer pseudo_salt_tracer::initialize_pseudo_salt_tracer rgc_tracer::initialize_rgc_tracer marbl_tracers::marbl_tracers_stock mom_ocmip2_cfc::ocmip2_cfc_stock oil_tracer::oil_stock pseudo_salt_tracer::pseudo_salt_stock boundary_impulse_tracer::register_boundary_impulse_tracer regional_dyes::register_dye_tracer ideal_age_example::register_ideal_age_tracer marbl_tracers::register_marbl_tracers oil_tracer::register_oil_tracer pseudo_salt_tracer::register_pseudo_salt_tracer mom_tracer_registry::register_tracer user_tracer_example::user_initialize_tracer user_tracer_example::user_tracer_stock

[source]

subroutine mom_io/mom_read_data_0d(filename, fieldname, data, timelevel, scale, MOM_Domain, global_file, file_may_be_4d)

Read a scalar from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value in arbitrary units [A ~> a]
timelevel :: timelevel [in] Time level to read in file
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
mom_domain :: [in] Model domain decomposition
global_file :: global_file [in] If true, read from a single file
file_may_be_4d :: file_may_be_4d [in] If true, fields may be stored as 4d arrays in the file.

[source]

subroutine mom_io/mom_read_data_0d_int(filename, fieldname, data, timelevel)

Read a scalar integer from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value
timelevel :: timelevel [in] Time level to read in file

[source]

subroutine mom_io/mom_read_data_1d(filename, fieldname, data, timelevel, scale, MOM_Domain, global_file, file_may_be_4d)

Read a 1d array from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value in arbitrary units [A ~> a]
timelevel :: timelevel [in] Time level to read in file
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
mom_domain :: [in] Model domain decomposition
global_file :: global_file [in] If true, read from a single file
file_may_be_4d :: file_may_be_4d [in] If true, fields may be stored as 4d arrays in the file.

[source]

subroutine mom_io/mom_read_data_1d_int(filename, fieldname, data, timelevel)

Read a 1d integer array from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value
timelevel :: timelevel [in] Time level to read in file

[source]

subroutine mom_io/mom_read_data_2d(filename, fieldname, data, MOM_Domain, timelevel, position, scale, global_file, file_may_be_4d, turns)

Read a 2d array from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value in arbitrary units [A ~> a]
mom_domain :: [in] Model domain decomposition
timelevel :: timelevel [in] Time level to read in file
position :: position [in] Grid positioning flag
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
global_file :: global_file [in] If true, read from a single file
file_may_be_4d :: file_may_be_4d [in] If true, fields may be stored as 4d arrays in the file.
turns :: turns [in] Number of quarter-turns to rotate the data. If absent the number of turns is taken from MOM_Domain.

[source]

subroutine mom_io/read_netcdf_data_2d(filename, fieldname, values, MOM_Domain, timelevel, position, rescale, turns)

Read a 2d array (which might have halos) from a file using native netCDF I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
values :: values [inout] Field values read from the file. It would be intent(out) but for the need to preserve any initialized values in the halo regions.
mom_domain :: [in] Model domain decomposition
timelevel :: timelevel [in] Time level to read in file
position :: position [in] Grid positioning flag
rescale :: rescale [in] Rescale factor, omitting this is the same as setting it to 1.
turns :: turns [in] Number of quarter-turns to rotate the data. If absent the number of turns is taken from MOM_Domain.

[source]

subroutine mom_io/mom_read_data_2d_region(filename, fieldname, data, start, nread, MOM_domain, no_domain, scale, turns)

Read a 2d region array from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value in arbitrary units [A ~> a]
start :: start [in] Starting index for each axis. In 2d, start(3:4) must be 1.
nread :: nread [in] Number of values to read along each axis. In 2d, nread(3:4) must be 1.
mom_domain :: [in] Model domain decomposition
no_domain :: no_domain [in] If true, field does not use domain decomposion.
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
turns :: turns [in] Number of quarter turns from input to model grid

[source]

subroutine mom_io/mom_read_data_3d(filename, fieldname, data, MOM_Domain, timelevel, position, scale, global_file, file_may_be_4d, turns)

Read a 3d array from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value in arbitrary units [A ~> a]
mom_domain :: [in] Model domain decomposition
timelevel :: timelevel [in] Time level to read in file
position :: position [in] Grid positioning flag
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
global_file :: global_file [in] If true, read from a single file
file_may_be_4d :: file_may_be_4d [in] If true, fields may be stored as 4d arrays in the file.
turns :: turns [in] Number of quarter-turns to rotate the data. If absent the number of turns is taken from MOM_Domain.

[source]

subroutine mom_io/mom_read_data_3d_region(filename, fieldname, data, start, nread, MOM_domain, no_domain, scale, turns)

Read a 3d region array from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value in arbitrary units [A ~> a]
start :: start [in] Starting index for each axis.
nread :: nread [in] Number of values to read along each axis.
mom_domain :: [in] Model domain decomposition
no_domain :: no_domain [in] If true, field does not use domain decomposion.
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
turns :: turns [in] Number of quarter turns from input to model grid

[source]

subroutine mom_io/mom_read_data_4d(filename, fieldname, data, MOM_Domain, timelevel, position, scale, global_file, turns)

Read a 4d array from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
fieldname :: fieldname [in] Field variable name
data :: data [inout] Field value in arbitrary units [A ~> a]
mom_domain :: [in] Model domain decomposition
timelevel :: timelevel [in] Time level to read in file
position :: position [in] Grid positioning flag
scale :: scale [in] A scaling factor that the variable is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
global_file :: global_file [in] If true, read from a single file
turns :: turns [in] Number of quarter-turns to rotate the data. If absent the number of turns is taken from MOM_Domain.

[source]

subroutine mom_io/mom_read_vector_2d(filename, u_fieldname, v_fieldname, u_data, v_data, MOM_Domain, timelevel, stagger, scalar_pair, scale, turns)

Read a 2d vector tuple from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
u_fieldname :: u_fieldname [in] Field variable name in u
v_fieldname :: v_fieldname [in] Field variable name in v
u_data :: u_data [inout] Field value at u points in arbitrary units [A ~> a]
v_data :: v_data [inout] Field value at v points in arbitrary units [A ~> a]
mom_domain :: [in] Model domain decomposition
timelevel :: timelevel [in] Time level to read in file
stagger :: stagger [in] Grid staggering flag
scalar_pair :: scalar_pair [in] True if tuple is not a vector
scale :: scale [in] A scaling factor that the vector is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
turns :: turns [in] Number of quarter-turns to rotate the data. If absent the number of turns is taken from MOM_Domain.

[source]

subroutine mom_io/mom_read_vector_3d(filename, u_fieldname, v_fieldname, u_data, v_data, MOM_Domain, timelevel, stagger, scalar_pair, scale, turns)

Read a 3d vector tuple from file using infrastructure I/O.

Parameters:

filename :: filename [in] Input filename
u_fieldname :: u_fieldname [in] Field variable name in u
v_fieldname :: v_fieldname [in] Field variable name in v
u_data :: u_data [inout] Field value in u in arbitrary units [A ~> a]
v_data :: v_data [inout] Field value in v in arbitrary units [A ~> a]
mom_domain :: [in] Model domain decomposition
timelevel :: timelevel [in] Time level to read in file
stagger :: stagger [in] Grid staggering flag
scalar_pair :: scalar_pair [in] True if tuple is not a vector
scale :: scale [in] A scaling factor that the vector is multiplied by before it is returned to convert from the units in the file to the internal units for this variable [A a-1 ~> 1]
turns :: turns [in] Number of quarter-turns to rotate the data. If absent the number of turns is taken from MOM_Domain.

[source]

subroutine mom_io/mom_write_field_legacy_4d(IO_handle, field_md, MOM_domain, field, tstamp, tile_count, fill_value, turns, scale, unscale, zero_zeros)

Write a 4d field to an output file, potentially with rotation.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
mom_domain :: [in] The MOM_Domain that describes the decomposition
field :: field [inout] Unrotated field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
tile_count :: tile_count [in] PEs per tile (default: 1)
fill_value :: fill_value [in] Missing data fill value in the units used in the file [a]
turns :: turns [in] Number of quarter-turns to rotate the data
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_legacy_3d(IO_handle, field_md, MOM_domain, field, tstamp, tile_count, fill_value, turns, scale, unscale, zero_zeros)

Write a 3d field to an output file, potentially with rotation.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
mom_domain :: [in] The MOM_Domain that describes the decomposition
field :: field [inout] Unrotated field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
tile_count :: tile_count [in] PEs per tile (default: 1)
fill_value :: fill_value [in] Missing data fill value in the units used in the file [a]
turns :: turns [in] Number of quarter-turns to rotate the data
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_legacy_2d(IO_handle, field_md, MOM_domain, field, tstamp, tile_count, fill_value, turns, scale, unscale, zero_zeros)

Write a 2d field to an output file, potentially with rotation.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
mom_domain :: [in] The MOM_Domain that describes the decomposition
field :: field [inout] Unrotated field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
tile_count :: tile_count [in] PEs per tile (default: 1)
fill_value :: fill_value [in] Missing data fill value
turns :: turns [in] Number of quarter-turns to rotate the data
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_legacy_1d(IO_handle, field_md, field, tstamp, fill_value, scale, unscale, zero_zeros)

Write a 1d field to an output file.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
field :: field [in] Field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
fill_value :: fill_value [in] Missing data fill value [a]
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_legacy_0d(IO_handle, field_md, field, tstamp, fill_value, scale, unscale, zero_zeros)

Write a 0d field to an output file.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
field :: field [in] Field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
fill_value :: fill_value [in] Missing data fill value [a]
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_4d(IO_handle, field_md, MOM_domain, field, tstamp, tile_count, fill_value, turns, scale, unscale, zero_zeros)

Write a 4d field to an output file, potentially with rotation.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
mom_domain :: [in] The MOM_Domain that describes the decomposition
field :: field [inout] Unrotated field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
tile_count :: tile_count [in] PEs per tile (default: 1)
fill_value :: fill_value [in] Missing data fill value [a]
turns :: turns [in] Number of quarter-turns to rotate the data
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_3d(IO_handle, field_md, MOM_domain, field, tstamp, tile_count, fill_value, turns, scale, unscale, zero_zeros)

Write a 3d field to an output file, potentially with rotation.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
mom_domain :: [in] The MOM_Domain that describes the decomposition
field :: field [inout] Unrotated field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
tile_count :: tile_count [in] PEs per tile (default: 1)
fill_value :: fill_value [in] Missing data fill value [a]
turns :: turns [in] Number of quarter-turns to rotate the data
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_2d(IO_handle, field_md, MOM_domain, field, tstamp, tile_count, fill_value, turns, scale, unscale, zero_zeros)

Write a 2d field to an output file, potentially with rotation.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
mom_domain :: [in] The MOM_Domain that describes the decomposition
field :: field [inout] Unrotated field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
tile_count :: tile_count [in] PEs per tile (default: 1)
fill_value :: fill_value [in] Missing data fill value [a]
turns :: turns [in] Number of quarter-turns to rotate the data
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_1d(IO_handle, field_md, field, tstamp, fill_value, scale, unscale, zero_zeros)

Write a 1d field to an output file.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
field :: field [in] Field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
fill_value :: fill_value [in] Missing data fill value [a]
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/mom_write_field_0d(IO_handle, field_md, field, tstamp, fill_value, scale, unscale, zero_zeros)

Write a 0d field to an output file.

Parameters:

io_handle :: [inout] Handle for a file that is open for writing
field_md :: field_md [in] Field type with metadata
field :: field [in] Field to write in arbitrary units [A ~> a]
tstamp :: tstamp [in] Model timestamp, often in [days]
fill_value :: fill_value [in] Missing data fill value [a]
scale :: scale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output
unscale :: unscale [in] A scaling factor that the field is multiplied by before it is written [a A-1 ~> 1], for example to convert it from its internal units to the desired units for output. Here scale and unscale are synonymous, but unscale takes precedence if both are present.
zero_zeros :: zero_zeros [in] If present and true, convert negative zeros into ordinary signless zeros.

[source]

subroutine mom_io/field_size(filename, fieldname, sizes, field_found, no_domain, ndims, ncid_in)

Given filename and fieldname, this subroutine returns the size of the field in the file.

Parameters:

filename :: filename [in] The name of the file to read
fieldname :: fieldname [in] The name of the variable whose sizes are returned
sizes :: sizes [inout] The sizes of the variable in each dimension
field_found :: field_found [out] This indicates whether the field was found in the input file. Without this argument, there is a fatal error if the field is not found.
no_domain :: no_domain [in] If present and true, do not check for file names with an appended tile number. If ndims is present, the default changes to true.
ndims :: ndims [out] The number of dimensions to the variable
ncid_in :: ncid_in [in] The netCDF ID of an open file. If absent, the file is opened and closed within this routine.

Call to:

get_var_sizes mom_error_handler::mom_error

[source]

subroutine mom_io/safe_string_copy(str1, str2, fieldnm, caller)

Copies a string.

Parameters:

str1 :: str1 [in] The string being copied
str2 :: str2 [out] The string being copied into
fieldnm :: fieldnm [in] The name of the field for error messages
caller :: caller [in] The calling routine for error messages

Call to:

mom_error_handler::mom_error

Called from:

modify_vardesc query_vardesc set_axis_info var_desc

[source]

function mom_io/ensembler(name, ens_no_in)

Returns a name with “%#E” or “%E” replaced with the ensemble member number.

Parameters:

name :: name [in] The name to be modified
ens_no_in :: ens_no_in [in] The number of the current ensemble member

Return:

undefined :: The name encoded with the ensemble number

Call to:

mom_error_handler::mom_error

[source]

subroutine mom_io/get_filename_appendix(suffix)

Provide a string to append to filenames, to differentiate ensemble members, for example.

Parameters:: suffix :: suffix [out] A string to append to filenames
Called from:: mom_diag_mediator::diag_mediator_init mom_is_diag_mediator::mom_is_diag_mediator_init

[source]

subroutine mom_io/write_version_number(version, tag, unit)

Write a file version number to the log file or other output file.

Parameters:

version :: version [in] A string that contains the routine name and version
tag :: tag [in] A tag name to add to the message
unit :: unit [in] An alternate unit number for output

[source]

function mom_io/open_namelist_file(file)

Open a single namelist file that is potentially readable by all PEs.

Parameters:: file :: file [in] The file to open, by default “input.nml”
Return:: undefined :: The opened unit number of the namelist file
Called from:: mom_get_input::get_mom_input

[source]

function mom_io/check_nml_error(IOstat, nml_name)

Checks the iostat argument that is returned after reading a namelist variable and writes a message if there is an error.

Parameters:

iostat :: [in] An I/O status field from a namelist read call
nml_name :: nml_name [in] The name of the namelist

Return:

undefined :: A copy of IOstat that is returned to preserve legacy function behavior

Called from:

mom_get_input::get_mom_input mom6

[source]

subroutine mom_io/mom_io_init(param_file)

Initialize the MOM_io module.

Parameters:: param_file :: param_file [in] structure indicating the open file to parse for model parameter values.

[source]

subroutine mom_io/get_var_axes_info(filename, fieldname, axes_info)

Returns the dimension variable information for a netCDF variable.

Parameters:

filename :: filename [in] A filename from which to read
fieldname :: fieldname [in] The name of the field to read
axes_info :: axes_info [inout] A returned array of field axis information

Call to:

close_file_to_read mom_error_handler::mom_error open_file_to_read set_axis_info

[source]