Procedures

Check for consistency in topography data. The presence of topography file is inferred from the pio_file pointer. If topography file is used, check that the "PHIS" variable, which denotes surface geopotential, is consistent with the surface geometric height in MPAS. Otherwise, if topography file is not used, check that the surface geometric height in MPAS is zero. (KCW, 2024-05-10)

This subroutine defines and registers four variants of dynamics grids in terms of dynamics decomposition. Their names are listed in dyn_grid_name and their corresponding ids can be determined by calling dyn_grid_id. * "mpas_cell": Grid that is centered at MPAS "cell" points. * "cam_cell": Grid that is also centered at MPAS "cell" points but uses standard CAM-SIMA coordinate and dimension names. * "mpas_edge": Grid that is centered at MPAS "edge" points. * "mpas_vertex": Grid that is centered at MPAS "vertex" points. (KCW, 2024-03-28)

Print a debug message at a debug level. The debug message will be prefixed by "MPAS Interface (N): ", where N is the MPI rank. The debug level is one of the debugout_* constants from the cam_logfile module. If printer is not supplied, the MPI root rank will print. Otherwise, the designated MPI rank will print instead. (KCW, 2024-02-03)

Exchange and/or convert constituent states between CAM-SIMA and MPAS. If exchange is .true. and direction is "e" or "export", set MPAS state scalars from physics state constituents. If exchange is .true. and direction is "i" or "import", set physics state constituents from MPAS state scalars. Think of it as "exporting/importing constituent states in CAM-SIMA to/from MPAS". Otherwise, if exchange is .false., no exchange is performed at all. If conversion is .true., appropriate conversion is performed for constituent mixing ratios that have different definitions between CAM-SIMA and MPAS (i.e., dry/moist). Otherwise, if conversion is .false., no conversion is performed at all. This subroutine is intentionally designed to have these elaborate controls due to complications in CAM-SIMA. Some procedures in CAM-SIMA expect constituent states to be dry, while the others expect them to be moist. (KCW, 2024-09-26)

Finalize MPAS dynamical core as well as its framework. (KCW, 2024-10-04)

Helper function for returning grid id given its name. (KCW, 2024-03-27)

Initialize MPAS dynamical core by one of the following: 1. Setting analytic initial condition; 2. Reading initial condition from a file; 3. Restarting from a file. (KCW, 2024-05-28)

Inquire local and global mesh dimensions. Save them as protected module variables. (KCW, 2024-11-21)

Check and return variable status on the given file.

Compute the edge-normal wind (tendency) vectors at edge points.

Compute local east, north, and edge-normal unit vectors.

Print a debug message at a debug level.

Define the names of constituents at run-time.

Update the halo layers of the named field.

Finalize MPAS dynamical core as well as its framework.

Query constituent index by its name.

Query constituent name by its index.

Return global mesh dimensions.

Return local mesh dimensions.

Return a pointer of mpas_pool_type to the named pool.

A family of accessor subroutines for MPAS dynamical core instance.

A family of accessor subroutines for MPAS dynamical core instance.

Track mpas_init up to the point of reading namelist.

Track mpas_init after namelist has been read.

Track mpas_init up to the point of calling atm_core_init.

Track atm_core_init to finish MPAS dynamical core initialization.

Initialize an MPAS stream with an accompanying MPAS pool.

Map constituent index from MPAS scalar index.

Map MPAS scalar index from constituent index.

Track mpas_init where namelist is being read.

Read or write an MPAS stream.

Integrate the dynamical states with time.

Read MPAS namelist from the supplied path. Additionally, perform early initialization of MPAS dynamical core. (KCW, 2024-02-09)

Run MPAS dynamical core to integrate the dynamical states with time. (KCW, 2024-07-11)

Perform one-way coupling from the dynamics output states to the physics input states. The other coupling direction is implemented by its counterpart, physics_to_dynamics_coupling. (KCW, 2024-07-31)

Return the index of unique elements in array, which can be any intrinsic data types, as an integer array. If array contains zero element or is of unsupported data types, an empty integer array is produced. For example, index_unique([1, 2, 3, 1, 2, 3, 4, 5]) returns [1, 2, 3, 7, 8]. (KCW, 2024-03-22)

Initialize physics grid in terms of dynamics decomposition. Provide grid and mapping information between global and local indexes to physics by calling phys_grid_init. (KCW, 2024-03-27)

Initialize reference pressure for use by physics. (KCW, 2024-03-25)

Mark everything in the physics_types module along with constituents as initialized to prevent physics from attempting to read them from a file. (KCW, 2024-05-23)

Initialize various model grids (e.g., dynamics, physics) in terms of dynamics decomposition. Additionally, MPAS framework initialization and reading time-invariant (e.g., grid/mesh) variables are also being completed in this subroutine. (KCW, 2024-03-29)

Parse a stream name, which consists of one or more stream name fragments, and return the corresponding variable information as a list of var_info_type. Multiple stream name fragments should be separated by "+" (i.e., a plus, meaning "addition" operation) or "-" (i.e., a minus, meaning "subtraction" operation). A stream name fragment can be a predefined stream name (e.g., "invariant", "input", etc.) or a single variable name. For example, a stream name of "invariant+input+restart" means the union of variables in the "invariant", "input", and "restart" streams. Duplicate variable information in the resulting list is discarded. (KCW, 2024-06-01)

Parse a stream name fragment and return the corresponding variable information as a list of var_info_type. A stream name fragment can be a predefined stream name (e.g., "invariant", "input", etc.) or a single variable name. (KCW, 2024-06-01)

Perform one-way coupling from the physics output states to the dynamics input states. The other coupling direction is implemented by its counterpart, dynamics_to_physics_coupling. (KCW, 2024-09-20)

Helper function for reversing the order of elements in array. (KCW, 2024-07-17)

Set analytic initial condition for MPAS. (KCW, 2024-05-22)

Convert one or more values of any intrinsic data types to a character string for pretty printing. If value contains more than one element, the elements will be stringified, delimited by separator, then concatenated. If value contains exactly one element, the element will be stringified without using separator. If value contains zero element or is of unsupported data types, an empty character string is produced. If separator is not supplied, it defaults to ", " (i.e., a comma and a space). (KCW, 2024-02-04)