mom_string_functions character(len=len(input_string)) function, public character(len=len(input_string)) function, public mom_string_functions::lowercase (input_string) lowercase input_string input_string Return a string in which all uppercase letters have been replaced by their lowercase counterparts. input_string The string to modify The modified output string basin_builder::basin_builder_topography mom_io::cmor_long_std mom_diag_remap::diag_remap_configure_axes mom_oda_driver_mod::init_oda mom_state_initialization::mom_initialize_state mom_io::num_timelevels mom_tracer_registry::register_tracer_diagnostics mom_restart::restore_state mom_tidal_mixing::tidal_mixing_init mom_tracer_registry::tracer_name_lookup character(len=len(input_string)) function, public character(len=len(input_string)) function, public mom_string_functions::uppercase (input_string) uppercase input_string input_string Return a string in which all uppercase letters have been replaced by their lowercase counterparts. input_string The string to modify The modified output string mom_continuity::continuity_init regrid_consts::coordinatemode mom_coriolisadv::coriolisadv_init mom_energetic_pbl::energetic_pbl_init mom_eos::eos_init regrid_interp::interpolation_scheme mom_main ocean_model_mod::ocean_model_init mom_opacity::opacity_init mom_shared_initialization::read_face_length_list mom_tidal_mixing::read_tidal_energy mom_shared_initialization::reset_face_lengths_list mom_remapping::setreconstructiontype mom_surface_forcing_gfdl::surface_forcing_init mom_tidal_mixing::tidal_mixing_init mom_surface_forcing::wind_forcing_from_file character(len=19) function, public character(len=19) function, public mom_string_functions::left_int (i) left_int i i Returns a character string of a left-formatted integer e.g. "123 " (assumes 19 digit maximum) i The integer to convert to a string The output string left_ints left_reals string_functions_unit_tests character(len=1320) function, public character(len=1320) function, public mom_string_functions::left_ints (i) left_ints i i Returns a character string of a comma-separated, compact formatted, integers e.g. "1, 2, 3, 4". i The array of integers to convert to a string The output string left_int string_functions_unit_tests character(len=32) function, public character(len=32) function, public mom_string_functions::left_real (val) left_real val val Returns a left-justified string with a real formatted like '(G)'. val The real variable to convert to a string The output string isformattedfloatequalto left_reals string_functions_unit_tests character(len=1320) function, public character(len=1320) function, public mom_string_functions::left_reals (r, sep) left_reals r r sep sep Returns a character string of a comma-separated, compact formatted, reals e.g. "1., 2., 5*3., 5.E2". r The array of real variables to convert to a string sep The separator between successive values, by default it is ', '. The output string left_int left_real string_functions_unit_tests logical function logical function mom_string_functions::isformattedfloatequalto (str, val) isformattedfloatequalto str str val val Returns True if the string can be read/parsed to give the exact value of "val". str The string to parse val The real value to compare with left_real character(len=120) function, public character(len=120) function, public mom_string_functions::extractword (string, n) extractword string string n n Returns the string corresponding to the nth word in the argument or "" if the string is not long enough. Both spaces and commas are interpreted as separators. string The string to scan n Number of word to extract extract_word mom_diag_remap::diag_remap_init mom_regridding::initialize_regridding string_functions_unit_tests character(len=120) function, public character(len=120) function, public mom_string_functions::extract_word (string, separators, n) extract_word string string separators separators n n Returns the string corresponding to the nth word in the argument or "" if the string is not long enough. Words are delineated by the mandatory separators argument. string String to scan separators Characters to use for delineation n Number of word to extract extract_integer extract_real extractword mom_open_boundary::parse_segment_data_str mom_open_boundary::parse_segment_manifest_str mom_open_boundary::parse_segment_str string_functions_unit_tests integer function, public integer function, public mom_string_functions::extract_integer (string, separators, n, missing_value) extract_integer string string separators separators n n missing_value missing_value Returns the integer corresponding to the nth word in the argument. string String to scan separators Characters to use for delineation n Number of word to extract missing_value Value to assign if word is missing extract_word mom_regridding::initialize_regridding string_functions_unit_tests real function, public real function, public mom_string_functions::extract_real (string, separators, n, missing_value) extract_real string string separators separators n n missing_value missing_value Returns the real corresponding to the nth word in the argument. string String to scan separators Characters to use for delineation n Number of word to extract missing_value Value to assign if word is missing extract_word mom_regridding::initialize_regridding string_functions_unit_tests character(len=120) function, public character(len=120) function, public mom_string_functions::remove_spaces (string) remove_spaces string string Returns string with all spaces removed. string String to scan mom_open_boundary::open_boundary_config string_functions_unit_tests logical function, public logical function, public mom_string_functions::string_functions_unit_tests (verbose) string_functions_unit_tests verbose verbose Returns true if a unit test of string_functions fails. verbose If true, write results to stdout extract_integer extract_real extract_word extractword left_int left_ints left_real left_reals localtesti localtestr localtests remove_spaces mom_unit_tests::unit_tests logical function logical function mom_string_functions::localtests (verbose, str1, str2) localtests verbose verbose str1 str1 str2 str2 True if str1 does not match str2. False otherwise. verbose If true, write results to stdout str1 String str2 String string_functions_unit_tests logical function logical function mom_string_functions::localtesti (verbose, i1, i2) localtesti verbose verbose i1 i1 i2 i2 True if i1 is not equal to i2. False otherwise. verbose If true, write results to stdout i1 Integer i2 Integer string_functions_unit_tests logical function logical function mom_string_functions::localtestr (verbose, r1, r2) localtestr verbose verbose r1 r1 r2 r2 True if r1 is not equal to r2. False otherwise. verbose If true, write results to stdout r1 Float r2 Float string_functions_unit_tests character(len=len(dir)+2) function, public character(len=len(dir)+2) function, public mom_string_functions::slasher (dir) slasher dir dir Returns a directory name that is terminated with a "/" or "./" if the argument is an empty string. dir A directory to be terminated with a "/" or changed to "./" if it is blank. mom_domains::mom_domains_init Handy functions for manipulating strings. By Alistair Adcroft and Robert Hallberg, last updated Sept. 2013. The functions here perform a set of useful manipulations of character strings. Although they are a part of MOM6, the do not require any other MOM software to be useful.