|
| 1 | +! Copyright (c) 2022, University Corporation for Atmospheric Research (UCAR). |
| 2 | +! |
| 3 | +! Unless noted otherwise source code is licensed under the BSD license. |
| 4 | +! Additional copyright and license information can be found in the LICENSE file |
| 5 | +! distributed with this code, or at https://mpas-dev.github.io/license.html |
| 6 | +! |
| 7 | +module mpas_modellevel_diagnostics |
| 8 | + |
| 9 | + use mpas_derived_types, only : MPAS_pool_type, MPAS_clock_type |
| 10 | + use mpas_kind_types, only : RKIND |
| 11 | + use mpas_constants, only : rvord |
| 12 | + |
| 13 | + type (MPAS_pool_type), pointer :: mesh |
| 14 | + type (MPAS_pool_type), pointer :: state |
| 15 | + type (MPAS_pool_type), pointer :: diag |
| 16 | + !type (MPAS_pool_type), pointer :: diag_physics |
| 17 | + |
| 18 | + type (MPAS_clock_type), pointer :: clock |
| 19 | + |
| 20 | + public :: modellevel_diagnostics_setup, & |
| 21 | + modellevel_diagnostics_compute |
| 22 | + |
| 23 | + private |
| 24 | + |
| 25 | + |
| 26 | + contains |
| 27 | + |
| 28 | + |
| 29 | + !----------------------------------------------------------------------- |
| 30 | + ! routine modellevel_diagnostics_setup |
| 31 | + ! |
| 32 | + !> \brief Initialize the modellevel diagnostic module |
| 33 | + !> \author Jihyeon Jang |
| 34 | + !> \date 30 January 2026 |
| 35 | + !> \details |
| 36 | + !> Initialize the diagnostic and save pointers to subpools for |
| 37 | + !> reuse in this module |
| 38 | + ! |
| 39 | + !----------------------------------------------------------------------- |
| 40 | + subroutine modellevel_diagnostics_setup(all_pools, simulation_clock) |
| 41 | + |
| 42 | + use mpas_derived_types, only : MPAS_pool_type, MPAS_clock_type |
| 43 | + use mpas_pool_routines, only : mpas_pool_get_subpool |
| 44 | + |
| 45 | + implicit none |
| 46 | + |
| 47 | + type (MPAS_pool_type), pointer :: all_pools |
| 48 | + type (MPAS_clock_type), pointer :: simulation_clock |
| 49 | + |
| 50 | + clock => simulation_clock |
| 51 | + |
| 52 | + call mpas_pool_get_subpool(all_pools, 'mesh', mesh) |
| 53 | + call mpas_pool_get_subpool(all_pools, 'state', state) |
| 54 | + call mpas_pool_get_subpool(all_pools, 'diag', diag) |
| 55 | + |
| 56 | + !call mpas_pool_get_array(diag, 'temperature', temperature) |
| 57 | + !call mpas_pool_get_array(diag, 'spechum', spechum) |
| 58 | + ! |
| 59 | + ! Zero-out the initial field |
| 60 | + ! |
| 61 | + !temperature(:,:) = 0.0_RKIND |
| 62 | + !spechum(:,:) = 0.0_RKIND |
| 63 | + |
| 64 | + end subroutine modellevel_diagnostics_setup |
| 65 | + |
| 66 | + |
| 67 | + !----------------------------------------------------------------------- |
| 68 | + ! routine modellevel_diagnostics_compute |
| 69 | + ! |
| 70 | + !> \brief Compute diagnostic before model output is written |
| 71 | + !> \author Jihyeon Jang |
| 72 | + !> \date 30 January 2026 |
| 73 | + !> \details |
| 74 | + !> Compute diagnostic before model output is written |
| 75 | + !> The following fields are computed by this routine: |
| 76 | + !> temperature |
| 77 | + !> spechum |
| 78 | + ! |
| 79 | + !----------------------------------------------------------------------- |
| 80 | + subroutine modellevel_diagnostics_compute() |
| 81 | + |
| 82 | + use mpas_atm_diagnostics_utils, only : MPAS_field_will_be_written |
| 83 | + use mpas_pool_routines, only : mpas_pool_get_dimension, mpas_pool_get_array |
| 84 | + |
| 85 | + implicit none |
| 86 | + |
| 87 | + integer :: iCell, k |
| 88 | + integer :: time_lev |
| 89 | + integer, pointer :: nCellsSolve, nVertLevels |
| 90 | + integer, pointer :: index_qv |
| 91 | + |
| 92 | + real (kind=RKIND), dimension(:,:), pointer :: temperature |
| 93 | + real (kind=RKIND), dimension(:,:), pointer :: spechum |
| 94 | + real (kind=RKIND), dimension(:,:), pointer :: exner, theta_m |
| 95 | + real (kind=RKIND), dimension(:,:,:), pointer :: scalars |
| 96 | + |
| 97 | + logical :: need_ml_diags, need_temperature, need_spechum |
| 98 | + |
| 99 | + time_lev = 1 |
| 100 | + |
| 101 | + need_ml_diags = .false. |
| 102 | + need_temperature = MPAS_field_will_be_written('temperature') |
| 103 | + need_ml_diags = need_ml_diags .or. need_temperature |
| 104 | + need_spechum = MPAS_field_will_be_written('spechum') |
| 105 | + need_ml_diags = need_ml_diags .or. need_spechum |
| 106 | + |
| 107 | + |
| 108 | + if (need_ml_diags) then |
| 109 | + call mpas_pool_get_dimension(mesh, 'nCellsSolve', nCellsSolve) |
| 110 | + call mpas_pool_get_dimension(mesh, 'nVertLevels', nVertLevels) |
| 111 | + end if |
| 112 | + |
| 113 | + if (need_temperature .or. need_spechum) then |
| 114 | + call mpas_pool_get_dimension(state, 'index_qv', index_qv) |
| 115 | + call mpas_pool_get_array(state, 'scalars', scalars, time_lev) |
| 116 | + end if |
| 117 | + |
| 118 | + if (need_temperature) then |
| 119 | + call mpas_pool_get_array(state, 'theta_m', theta_m, time_lev) |
| 120 | + call mpas_pool_get_array(diag, 'exner', exner) |
| 121 | + call mpas_pool_get_array(diag, 'temperature', temperature) |
| 122 | + end if |
| 123 | + |
| 124 | + if (need_spechum) then |
| 125 | + call mpas_pool_get_array(diag, 'spechum', spechum) |
| 126 | + end if |
| 127 | + |
| 128 | + if (need_temperature) then |
| 129 | + do iCell=1,nCellsSolve |
| 130 | + do k=1,nVertLevels |
| 131 | + temperature(k,iCell) = (theta_m(k,iCell)/(1._RKIND+rvord*scalars(index_qv,k,iCell)))*exner(k,iCell) |
| 132 | + end do |
| 133 | + end do |
| 134 | + end if |
| 135 | + |
| 136 | + if (need_spechum) then |
| 137 | + do iCell=1,nCellsSolve |
| 138 | + do k=1,nVertLevels |
| 139 | + spechum(k,iCell) = scalars(index_qv,k,iCell) / (1.0_RKIND+scalars(index_qv,k,iCell)) |
| 140 | + end do |
| 141 | + end do |
| 142 | + end if |
| 143 | + |
| 144 | + end subroutine modellevel_diagnostics_compute |
| 145 | + |
| 146 | +end module mpas_modellevel_diagnostics |
0 commit comments