Procedures

Test if a is divisible by b, where a and b are both reals. (KCW, 2024-05-25)

Test if a is divisible by b, where a and b are both reals. (KCW, 2024-05-25)

Test a and b for approximate equality, where a and b are both reals. (KCW, 2024-05-25)

Test a and b for approximate equality, where a and b are both reals. (KCW, 2024-05-25)

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)

Clamp/Limit the value of x to the range of [xmin, xmax], where x, xmin, and xmax are all integers. No check is performed to ensure xmin < xmax. (KCW, 2025-07-16)

Clamp/Limit the value of x to the range of [xmin, xmax], where x, xmin, and xmax are all integers. No check is performed to ensure xmin < xmax. (KCW, 2025-07-16)

Clamp/Limit the value of x to the range of [xmin, xmax], where x, xmin, and xmax are all reals. No check is performed to ensure xmin < xmax. (KCW, 2025-07-16)

Clamp/Limit the value of x to the range of [xmin, xmax], where x, xmin, and xmax are all reals. No check is performed to ensure xmin < xmax. (KCW, 2025-07-16)

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)

Compute the pressure difference dp from the density rho and the height difference dz by hydrostatic equation. Essentially, $\mathrm{d} P = -\rho g \mathrm{d} z$. (KCW, 2025-07-10)

CAM-SIMA holds information about all constituents. However, MPAS dynamical core only knows about the advected ones. Inquire the index mapping for constituents advected by MPAS dynamical core. Save it as the advected_constituent_index lookup table, which serves as the authoritative source for mapping an index within the set of advected constituents to an index within the set of all constituents. (KCW, 2026-03-25)

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 relative vorticities at cell points.

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.

Compute the differences in $\zeta$ between u-wind levels dzu from the differences in $\zeta$ between w-wind levels dzw, where $\zeta$ is the vertical coordinate, u-wind and w-wind levels are synonymous with layer midpoints and interfaces in MPAS, respectively. (KCW, 2025-10-20)

Compute the differences in $\zeta$ between u-wind levels dzu from the differences in $\zeta$ between w-wind levels dzw, where $\zeta$ is the vertical coordinate, u-wind and w-wind levels are synonymous with layer midpoints and interfaces in MPAS, respectively. (KCW, 2025-10-20)

Compute the differences in $\zeta$ between w-wind levels dzw from the reciprocal differences in $\zeta$ between w-wind levels rdzw, where $\zeta$ is the vertical coordinate, and w-wind levels are synonymous with layer interfaces in MPAS. (KCW, 2025-10-20)

Compute the differences in $\zeta$ between w-wind levels dzw from the reciprocal differences in $\zeta$ between w-wind levels rdzw, where $\zeta$ is the vertical coordinate, and w-wind levels are synonymous with layer interfaces in MPAS. (KCW, 2025-10-20)

Compute the Exner function pi from the pressure p. Essentially, $\Pi = (\frac{P}{P_0})^{\frac{R_d}{C_{pd}}}$. (KCW, 2025-07-10)

Compute the Exner function pi from the pressure p. Essentially, $\Pi = (\frac{P}{P_0})^{\kappa}$. (KCW, 2025-08-16)

Return the index of unique elements in array, which can be any intrinsic data types, as an integer array. Please note that array must only have one dimension, and the unique elements are returned by their first occurrences in 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)

Compute the vertical pressure velocity omega as a function of the vertical velocity w and the density rho. Essentially, $\omega = -\rho g w$. (KCW, 2025-07-10)

Compute the pressure p from the density rho and the temperature t by equation of state. Essentially, $P = \rho R T$. Equation of state may take other forms, such as $P_d = \rho_d R_d T$, $P = \rho R_d T_v$, $P = \rho_d R_d T_m$. Choose wisely which form to use. (KCW, 2025-07-10)

Compute the pressure p2 at height z2 from the pressure p1 at height z1 by hypsometric equation. tv is the mean virtual temperature between z1 and z2. Essentially, $P_2 = P_1 e^{\frac{-(z_2 - z_1) g}{R_d T_v}}$. (KCW, 2024-07-02)

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)

Compute the water vapor mixing ratio qv as a function of the specific humidity sh. Essentially, $q_v = \frac{SH}{1 - SH}$. (KCW, 2025-07-21)

Regrid values from vertex points to the specified cell point.

Reverse the order of elements in array. Single precision variant. (KCW, 2024-07-17)

Reverse the order of elements in array. Double precision variant. (KCW, 2024-07-17)

Compute the density rho from the pressure p and the temperature t by equation of state. Essentially, $\rho = \frac{P}{R T}$. Equation of state may take other forms, such as $P_d = \rho_d R_d T$, $P = \rho R_d T_v$, $P = \rho_d R_d T_m$. Choose wisely which form to use. (KCW, 2025-07-10)

Convert second(s) to hour(s), minute(s), and second(s). (KCW, 2024-02-07)

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

Inform CAM-SIMA about the index mapping between MPAS scalars and CAM-SIMA constituents. (KCW, 2025-07-17)

Set the thermodynamic energy formula of dynamical core to MPAS. (KCW, 2025-07-17)

Compute the specific humidity sh as a function of the water vapor mixing ratio qv. Essentially, $SH = \frac{q_v}{1 + q_v}$. (KCW, 2025-07-21)

Parse a string into tokens, one at a time. Each character in set is a token delimiter. If back is absent or is present with the value .false., pos is assigned the position of the leftmost token delimiter in string whose position is greater than pos, or if there is no such character, it is assigned a value one greater than the length of string. This identifies a token with starting position one greater than the value of pos on invocation, and ending position one less than the value of pos on return. If back is present with the value .true., pos is assigned the position of the rightmost token delimiter in string whose position is less than pos, or if there is no such character, it is assigned the value zero. This identifies a token with ending position one less than the value of pos on invocation, and starting position one greater than the value of pos on return. This subroutine implements the split intrinsic procedure as defined in the Fortran 2023 language standard (Section 16.9.196). We implement it ourselves because the compiler support may take years to become widespread. (KCW, 2025-10-29)

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)

Compute the temperature t from the pressure p and the density rho by equation of state. Essentially, $T = \frac{P}{\rho R}$. Equation of state may take other forms, such as $P_d = \rho_d R_d T$, $P = \rho R_d T_v$, $P = \rho_d R_d T_m$. Choose wisely which form to use. (KCW, 2025-07-10)

Compute the temperature t at pressure p from the potential temperature theta at reference pressure p0 by Poisson equation. Essentially, $T = \theta (\frac{P}{P_0})^{\frac{R_d}{C_{pd}}}$. (KCW, 2025-07-14)

Compute the temperature t as a function of the potential temperature theta, the dry air density rhod, and the water vapor mixing ratio qv. Essentially, $T = \theta^{\frac{C_{pd}}{C_{vd}}} [\frac{\rho_d R_d (1 + \frac{R_v}{R_d} q_v)}{P_0}]^{\frac{R_d}{C_{vd}}}$. The formulation comes from Poisson equation with equation of state plugged in and arranging for temperature. This function is the exact inverse of theta_of_t_rhod_qv, which means that: t == t_of_theta_rhod_qv(..., theta_of_t_rhod_qv(..., t, rhod, qv), rhod, qv). (KCW, 2024-09-13)

Compute the temperature t as a function of the modified moist temperature tm and the water vapor mixing ratio qv. Essentially, $T = \frac{T_m}{1 + \frac{R_v}{R_d} q_v}$. This modified "moist" temperature is described herein: The paragraph below equation 2.7 in doi:10.5065/1DFH-6P97. The paragraph below equation 2 in doi:10.1175/MWR-D-11-00215.1. Similarly, it can be shown that the relation, $\theta = \frac{\theta_m}{1 + \frac{R_v}{R_d} q_v}$, also holds. (KCW, 2025-07-10)

Compute the potential temperature theta at reference pressure p0 from the temperature t at pressure p by Poisson equation. Essentially, $\theta = T (\frac{P_0}{P})^{\frac{R_d}{C_{pd}}}$. (KCW, 2024-07-02)

Compute the potential temperature theta as a function of the temperature t, the dry air density rhod, and the water vapor mixing ratio qv. Essentially, $\theta = T^{\frac{C_{vd}}{C_{pd}}} [\frac{P_0}{\rho_d R_d (1 + \frac{R_v}{R_d} q_v)}]^{\frac{R_d}{C_{pd}}}$. The formulation comes from Poisson equation with equation of state plugged in and arranging for potential temperature. This function is the exact inverse of t_of_theta_rhod_qv, which means that: theta == theta_of_t_rhod_qv(..., t_of_theta_rhod_qv(..., theta, rhod, qv), rhod, qv). (KCW, 2024-09-13)

Compute the modified moist temperature tm as a function of the temperature t and the water vapor mixing ratio qv. Essentially, $T_m = T (1 + \frac{R_v}{R_d} q_v)$. This modified "moist" temperature is described herein: The paragraph below equation 2.7 in doi:10.5065/1DFH-6P97. The paragraph below equation 2 in doi:10.1175/MWR-D-11-00215.1. Similarly, it can be shown that the relation, $\theta_m = \theta (1 + \frac{R_v}{R_d} q_v)$, also holds. (KCW, 2025-07-10)

Compute the modified moist temperature tm as a function of the virtual temperature tv and the water vapor mixing ratio qv. Essentially, $T_m = T_v (1 + q_v)$. This modified "moist" temperature is described herein: The paragraph below equation 2.7 in doi:10.5065/1DFH-6P97. The paragraph below equation 2 in doi:10.1175/MWR-D-11-00215.1. Similarly, it can be shown that the relation, $\theta_m = \theta_v (1 + q_v)$, also holds. (KCW, 2025-07-11)

Parse a string into tokens. Each character in set is a token delimiter. first is allocated with the lower bound equal to one and the upper bound equal to the number of tokens in string. Each element is assigned, in array element order, the starting position of each token in string, in the order found. last is allocated with the lower bound equal to one and the upper bound equal to the number of tokens in string. Each element is assigned, in array element order, the ending position of each token in string, in the order found. This subroutine implements the tokenize intrinsic procedure as defined in the Fortran 2023 language standard (Section 16.9.210). We implement it ourselves because the compiler support may take years to become widespread. (KCW, 2025-10-29)

Parse a string into tokens. Each character in set is a token delimiter. tokens is allocated with the lower bound equal to one and the upper bound equal to the number of tokens in string, and with character length equal to the length of the longest token. It contains the tokens in string. separator is allocated with the lower bound equal to one and the upper bound equal to one less than the number of tokens in string, and with character length equal to one. It contains the token delimiters in string. This subroutine implements the tokenize intrinsic procedure as defined in the Fortran 2023 language standard (Section 16.9.210). We implement it ourselves because the compiler support may take years to become widespread. (KCW, 2025-10-29)

Compute the virtual temperature tv as a function of the modified moist temperature tm and the water vapor mixing ratio qv. Essentially, $T_v = \frac{T_m}{1 + q_v}$. This modified "moist" temperature is described herein: The paragraph below equation 2.7 in doi:10.5065/1DFH-6P97. The paragraph below equation 2 in doi:10.1175/MWR-D-11-00215.1. Similarly, it can be shown that the relation, $\theta_v = \frac{\theta_m}{1 + q_v}$, also holds. (KCW, 2025-07-11)

Compute the vertical velocity w as a function of the vertical pressure velocity omega and the density rho. Essentially, $w = -\frac{\omega}{\rho g}$. (KCW, 2025-07-10)

Compute the $\zeta$ coordinates at u-wind levels zu from the differences in $\zeta$ between w-wind levels dzw, where $\zeta$ is the vertical coordinate, u-wind and w-wind levels are synonymous with layer midpoints and interfaces in MPAS, respectively. (KCW, 2025-10-20)

Compute the $\zeta$ coordinates at u-wind levels zu from the differences in $\zeta$ between w-wind levels dzw, where $\zeta$ is the vertical coordinate, u-wind and w-wind levels are synonymous with layer midpoints and interfaces in MPAS, respectively. (KCW, 2025-10-20)

Compute the $\zeta$ coordinates at w-wind levels zw from the differences in $\zeta$ between w-wind levels dzw, where $\zeta$ is the vertical coordinate, and w-wind levels are synonymous with layer interfaces in MPAS. (KCW, 2025-10-20)

Compute the $\zeta$ coordinates at w-wind levels zw from the differences in $\zeta$ between w-wind levels dzw, where $\zeta$ is the vertical coordinate, and w-wind levels are synonymous with layer interfaces in MPAS. (KCW, 2025-10-20)