mom_io mom_io::file_exists mom_io::mom_read_data mom_io::mom_read_vector mom_io::vardesc subroutine, public subroutine, public mom_io::create_file (unit, filename, vars, novars, fields, threading, timeunit, G, dG, GV, checksums) create_file unit unit filename filename vars vars novars novars fields fields threading threading timeunit timeunit G G dG dG GV GV checksums checksums Routine creates a new NetCDF file. It also sets up structures that describe this file and variables that will later be written to this file. Type for describing a variable, typically a tracer. unit unit id of an open file or -1 on a nonwriting PE with single file output filename full path to the file to create vars structures describing fields written to filename novars number of fields written to filename fields array of fieldtypes for each variable threading SINGLE_FILE or MULTIPLE timeunit length of the units for time [s]. The default value is 86400.0, for 1 day. g ocean horizontal grid structure; G or dG is required if the new file uses any horizontal grid axes. dg dynamic horizontal grid structure; G or dG is required if the new file uses any horizontal grid axes. gv ocean vertical grid structure, which is required if the new file uses any vertical grid axes. checksums checksums of vars mom_error_handler::mom_error mom_ale::ale_writecoordinatefile reopen_file subroutine, public subroutine, public mom_io::reopen_file (unit, filename, vars, novars, fields, threading, timeunit, G, dG, GV) reopen_file unit unit filename filename vars vars novars novars fields fields threading threading timeunit timeunit G G dG dG GV GV 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. unit unit id of an open file or -1 on a nonwriting PE with single file output filename full path to the file to create vars structures describing fields written to filename novars number of fields written to filename fields array of fieldtypes for each variable threading SINGLE_FILE or MULTIPLE timeunit length of the units for time [s]. The default value is 86400.0, for 1 day. g ocean horizontal grid structure; G or dG is required if a new file uses any horizontal grid axes. dg dynamic horizontal grid structure; G or dG is required if a new file uses any horizontal grid axes. gv ocean vertical grid structure, which is required if a new file uses any vertical grid axes. create_file mom_error_handler::mom_error subroutine, public subroutine, public mom_io::read_axis_data (filename, axis_name, var) read_axis_data filename filename axis_name axis_name var var Read the data associated with a named axis in a file. filename Name of the file to read axis_name Name of the axis to read var The axis location data mom_error_handler::mom_error integer function, public integer function, public mom_io::num_timelevels (filename, varname, min_dims) num_timelevels filename filename varname varname min_dims min_dims This function determines how many time levels a variable has. filename name of the file to read varname variable whose number of time levels are to be returned min_dims 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. number of time levels varname has in filename mom_string_functions::lowercase mom_error_handler::mom_error mom_surface_forcing::surface_forcing_init type(vardesc) function, public type(vardesc) function, public mom_io::var_desc (name, units, longname, hor_grid, z_grid, t_grid, cmor_field_name, cmor_units, cmor_longname, conversion, caller) var_desc name name units units longname longname hor_grid hor_grid z_grid z_grid t_grid t_grid cmor_field_name cmor_field_name cmor_units cmor_units cmor_longname cmor_longname conversion conversion caller caller 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. name variable name units variable units longname variable long name hor_grid variable horizonal staggering z_grid variable vertical staggering t_grid time description: s, p, or 1 cmor_field_name CMOR name cmor_units CMOR physical dimensions of variable cmor_longname CMOR long name conversion for unit conversions, such as needed to convert from intensive to extensive caller calling routine? vardesc type that is created modify_vardesc safe_string_copy mom_meke::meke_alloc_register_restart mom_open_boundary::open_boundary_register_restarts advection_test_tracer::register_advection_test_tracer mom_barotropic::register_barotropic_restarts boundary_impulse_tracer::register_boundary_impulse_tracer mom_controlled_forcing::register_ctrl_forcing_restarts 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 mom_ocmip2_cfc::register_ocmip2_cfc oil_tracer::register_oil_tracer pseudo_salt_tracer::register_pseudo_salt_tracer rgc_tracer::register_rgc_tracer user_tracer_example::user_register_tracer_example mom_shared_initialization::write_ocean_geometry_file mom_coord_initialization::write_vertgrid_file subroutine, public subroutine, public mom_io::modify_vardesc (vd, name, units, longname, hor_grid, z_grid, t_grid, cmor_field_name, cmor_units, cmor_longname, conversion, caller) modify_vardesc vd vd name name units units longname longname hor_grid hor_grid z_grid z_grid t_grid t_grid cmor_field_name cmor_field_name cmor_units cmor_units cmor_longname cmor_longname conversion conversion caller caller This routine modifies the named elements of a vardesc type. All arguments are optional, except the vardesc type to be modified. vd vardesc type that is modified name name of variable units units of variable longname long name of variable hor_grid horizonal staggering of variable z_grid vertical staggering of variable t_grid time description: s, p, or 1 cmor_field_name CMOR name cmor_units CMOR physical dimensions of variable cmor_longname CMOR long name conversion for unit conversions, such as needed to convert from intensive to extensive caller calling routine? safe_string_copy var_desc character(len=len(longname)) function, public character(len=len(longname)) function, public mom_io::cmor_long_std (longname) cmor_long_std longname longname This function returns the CMOR standard name given a CMOR longname, based on the standard pattern of character conversions. longname The CMOR longname being converted The CMOR standard name generated from longname mom_string_functions::lowercase mom_tracer_registry::register_tracer_diagnostics subroutine, public subroutine, public mom_io::query_vardesc (vd, name, units, longname, hor_grid, z_grid, t_grid, cmor_field_name, cmor_units, cmor_longname, conversion, caller) query_vardesc vd vd name name units units longname longname hor_grid hor_grid z_grid z_grid t_grid t_grid cmor_field_name cmor_field_name cmor_units cmor_units cmor_longname cmor_longname conversion conversion caller caller This routine queries vardesc. vd vardesc type that is queried name name of variable units units of variable longname long name of variable hor_grid horiz staggering of variable z_grid vert staggering of variable t_grid time description: s, p, or 1 cmor_field_name CMOR name cmor_units CMOR physical dimensions of variable cmor_longname CMOR long name conversion for unit conversions, such as needed to convert from intensive to extensive caller calling routine? safe_string_copy advection_test_tracer::advection_test_stock boundary_impulse_tracer::boundary_impulse_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 oil_tracer::initialize_oil_tracer pseudo_salt_tracer::initialize_pseudo_salt_tracer rgc_tracer::initialize_rgc_tracer 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 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 subroutine subroutine mom_io::safe_string_copy (str1, str2, fieldnm, caller) safe_string_copy str1 str1 str2 str2 fieldnm fieldnm caller caller Copies a string. str1 The string being copied str2 The string being copied into fieldnm The name of the field for error messages caller The calling routine for error messages mom_error_handler::mom_error modify_vardesc query_vardesc var_desc character(len=len(name)) function, public character(len=len(name)) function, public mom_io::ensembler (name, ens_no_in) ensembler name name ens_no_in ens_no_in Returns a name with "%#E" or "%E" replaced with the ensemble member number. name The name to be modified ens_no_in The number of the current ensemble member The name encoded with the ensemble number mom_error_handler::mom_error logical function logical function mom_io::mom_file_exists (filename, MOM_Domain) mom_file_exists filename filename MOM_Domain MOM_Domain Returns true if the named file or its domain-decomposed variant exists. filename The name of the file being inquired about mom_domain The MOM_Domain that describes the decomposition logical function logical function mom_io::fms_file_exists (filename, domain, no_domain) fms_file_exists filename filename domain domain no_domain no_domain Returns true if the named file or its domain-decomposed variant exists. filename The name of the file being inquired about domain The mpp domain2d that describes the decomposition no_domain This file does not use domain decomposition subroutine subroutine mom_io::mom_read_data_1d (filename, fieldname, data, timelevel, scale) mom_read_data_1d filename filename fieldname fieldname data data timelevel timelevel scale scale This function uses the fms_io function read_data to read 1-D data field named "fieldname" from file "filename". filename The name of the file to read fieldname The variable name of the data in the file data The 1-dimensional array into which the data timelevel The time level in the file to read scale A scaling factor that the field is multiplied by before they are returned. subroutine subroutine mom_io::mom_read_data_2d (filename, fieldname, data, MOM_Domain, timelevel, position, scale) mom_read_data_2d filename filename fieldname fieldname data data MOM_Domain MOM_Domain timelevel timelevel position position scale scale This function uses the fms_io function read_data to read a distributed 2-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE. filename The name of the file to read fieldname The variable name of the data in the file data The 2-dimensional array into which the data should be read mom_domain The MOM_Domain that describes the decomposition timelevel The time level in the file to read position A flag indicating where this data is located scale A scaling factor that the field is multiplied by before they are returned. mom_domains::get_simple_array_i_ind mom_domains::get_simple_array_j_ind subroutine subroutine mom_io::mom_read_data_3d (filename, fieldname, data, MOM_Domain, timelevel, position, scale) mom_read_data_3d filename filename fieldname fieldname data data MOM_Domain MOM_Domain timelevel timelevel position position scale scale This function uses the fms_io function read_data to read a distributed 3-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE. filename The name of the file to read fieldname The variable name of the data in the file data The 3-dimensional array into which the data should be read mom_domain The MOM_Domain that describes the decomposition timelevel The time level in the file to read position A flag indicating where this data is located scale A scaling factor that the field is multiplied by before they are returned. mom_domains::get_simple_array_i_ind mom_domains::get_simple_array_j_ind subroutine subroutine mom_io::mom_read_data_4d (filename, fieldname, data, MOM_Domain, timelevel, position, scale) mom_read_data_4d filename filename fieldname fieldname data data MOM_Domain MOM_Domain timelevel timelevel position position scale scale This function uses the fms_io function read_data to read a distributed 4-D data field named "fieldname" from file "filename". Valid values for "position" include CORNER, CENTER, EAST_FACE and NORTH_FACE. filename The name of the file to read fieldname The variable name of the data in the file data The 4-dimensional array into which the data should be read mom_domain The MOM_Domain that describes the decomposition timelevel The time level in the file to read position A flag indicating where this data is located scale A scaling factor that the field is multiplied by before they are returned. mom_domains::get_simple_array_i_ind mom_domains::get_simple_array_j_ind subroutine subroutine mom_io::mom_read_vector_2d (filename, u_fieldname, v_fieldname, u_data, v_data, MOM_Domain, timelevel, stagger, scalar_pair, scale) mom_read_vector_2d filename filename u_fieldname u_fieldname v_fieldname v_fieldname u_data u_data v_data v_data MOM_Domain MOM_Domain timelevel timelevel stagger stagger scalar_pair scalar_pair scale scale This function uses the fms_io function read_data to read a pair of distributed 2-D data fields with names given by "[uv]_fieldname" from file "filename". Valid values for "stagger" include CGRID_NE, BGRID_NE, and AGRID. filename The name of the file to read u_fieldname The variable name of the u data in the file v_fieldname The variable name of the v data in the file u_data The 2 dimensional array into which the u-component of the data should be read v_data The 2 dimensional array into which the v-component of the data should be read mom_domain The MOM_Domain that describes the decomposition timelevel The time level in the file to read stagger A flag indicating where this vector is discretized scalar_pair If true, a pair of scalars are to be read.cretized scale A scaling factor that the fields are multiplied by before they are returned. mom_domains::get_simple_array_i_ind mom_domains::get_simple_array_j_ind subroutine subroutine mom_io::mom_read_vector_3d (filename, u_fieldname, v_fieldname, u_data, v_data, MOM_Domain, timelevel, stagger, scalar_pair, scale) mom_read_vector_3d filename filename u_fieldname u_fieldname v_fieldname v_fieldname u_data u_data v_data v_data MOM_Domain MOM_Domain timelevel timelevel stagger stagger scalar_pair scalar_pair scale scale This function uses the fms_io function read_data to read a pair of distributed 3-D data fields with names given by "[uv]_fieldname" from file "filename". Valid values for "stagger" include CGRID_NE, BGRID_NE, and AGRID. filename The name of the file to read u_fieldname The variable name of the u data in the file v_fieldname The variable name of the v data in the file u_data The 3 dimensional array into which the u-component of the data should be read v_data The 3 dimensional array into which the v-component of the data should be read mom_domain The MOM_Domain that describes the decomposition timelevel The time level in the file to read stagger A flag indicating where this vector is discretized scalar_pair If true, a pair of scalars are to be read.cretized scale A scaling factor that the fields are multiplied by before they are returned. mom_domains::get_simple_array_i_ind mom_domains::get_simple_array_j_ind subroutine, public subroutine, public mom_io::mom_io_init (param_file) mom_io_init param_file param_file Initialize the MOM_io module. param_file structure indicating the open file to parse for model parameter values. This module contains I/O framework code. 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.