From a6eeeeaa38c8d7cd4c124c9c5ff35d4d27082590 Mon Sep 17 00:00:00 2001 From: Manda Chasteen Date: Thu, 23 May 2024 21:41:59 -0600 Subject: [PATCH 1/2] Framework for adding tendency diagnostics, updating PV diagnostics - Add tendency and PV packages declarations to Registry.xml - Add Registry_tendencies.xml file with tendency package variables - Update Registry_diagnostics.xml with Registry_tendencies.xml and namelist config option declarations - Update Registry_pv.xml with all variables required to make modifications to PV diagnostics package --- src/core_atmosphere/Registry.xml | 28 +- .../diagnostics/Registry_diagnostics.xml | 48 ++ .../diagnostics/Registry_pv.xml | 434 ++++++++++++++-- .../diagnostics/Registry_tendencies.xml | 484 ++++++++++++++++++ 4 files changed, 953 insertions(+), 41 deletions(-) create mode 100644 src/core_atmosphere/diagnostics/Registry_tendencies.xml diff --git a/src/core_atmosphere/Registry.xml b/src/core_atmosphere/Registry.xml index 10cfbca3ea..d92bb38c2f 100644 --- a/src/core_atmosphere/Registry.xml +++ b/src/core_atmosphere/Registry.xml @@ -410,6 +410,13 @@ + + + + + + + @@ -1628,8 +1635,16 @@ #endif - + + + + + + @@ -1715,9 +1730,6 @@ - - @@ -1929,6 +1941,14 @@ packages="mp_thompson_aers_in"/> #endif + + + + + + diff --git a/src/core_atmosphere/diagnostics/Registry_diagnostics.xml b/src/core_atmosphere/diagnostics/Registry_diagnostics.xml index b9e7dc5682..322d5148cf 100644 --- a/src/core_atmosphere/diagnostics/Registry_diagnostics.xml +++ b/src/core_atmosphere/diagnostics/Registry_diagnostics.xml @@ -19,6 +19,54 @@ #include "Registry_soundings.xml" + +#include "Registry_tendencies.xml" + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/core_atmosphere/diagnostics/Registry_pv.xml b/src/core_atmosphere/diagnostics/Registry_pv.xml index d776ec2a15..e42292a023 100644 --- a/src/core_atmosphere/diagnostics/Registry_pv.xml +++ b/src/core_atmosphere/diagnostics/Registry_pv.xml @@ -1,68 +1,428 @@ - - + + + - - + + - - - - + description="Ertel's potential vorticity (1 PVU = 10^{-6} m^{2} s^{-1} K kg^{-1})" + packages="pv_diagnostics"/> - + - - - -#ifdef DO_PHYSICS + + + description="Diabatic PV tendency from longwave radiation parameterization scheme" + packages="pv_tendencies"/> + description="Diabatic PV tendency from shortwave radiation parameterization scheme" + packages="pv_tendencies"/> + description="Diabatic PV tendency from PBL parameterization scheme" + packages="pv_tendencies"/> + description="Diabatic PV tendency from cumulus parameterization scheme" + packages="pv_tendencies"/> - - + description="Diabatic PV tendency from microphysics parameterization scheme" + packages="pv_tendencies"/> - + description="Diabatic PV tendency from explicit horizontal mixing" + packages="pv_tendencies"/> + + description="Sum of calculated PV tendencies from diabatic processes" + packages="pv_tendencies"/> + + + + + + + + description="Sum of calculated PV tendencies from frictional processes" + packages="pv_tendencies"/> + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + description="Diabatic PV tendency on dynamic tropopause diagnosed at beginning of previous time step (i.e., iLev_DT_prev)" + packages="pv_tendencies"/> -#endif + description="Frictional PV tendency on dynamic tropopause diagnosed at beginning of previous time step (i.e., iLev_DT_prev)" + packages="pv_tendencies"/> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + description="1 if within troposphere based on PV flood fill" + packages="pv_diagnostics"/> + + + + + + + + diff --git a/src/core_atmosphere/diagnostics/Registry_tendencies.xml b/src/core_atmosphere/diagnostics/Registry_tendencies.xml new file mode 100644 index 0000000000..618cb79cc3 --- /dev/null +++ b/src/core_atmosphere/diagnostics/Registry_tendencies.xml @@ -0,0 +1,484 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 47d1203b77acb12ff01f0b4ca5fc37ac26872e86 Mon Sep 17 00:00:00 2001 From: Manda Chasteen Date: Fri, 24 May 2024 14:22:28 -0600 Subject: [PATCH 2/2] Check compatability between diagnostic configs and connect configs to variable packages - Added mpas_atm_diagnostics_packages.F in /src/core_atmosphere/diagnostics to setup the tendency and PV diagnostics packages based on config options and ensure comptability between the config options selected in the namelist - Modified Makefile in /src/core_atmosphere/diagnostics to reflect this new script - Modified mpas_atm_core_interface.F to call mpas_atm_diagnostics_packages.F to setup these packages --- src/core_atmosphere/diagnostics/Makefile | 3 +- .../mpas_atm_diagnostics_packages.F | 250 ++++++++++++++++++ src/core_atmosphere/mpas_atm_core_interface.F | 13 + 3 files changed, 265 insertions(+), 1 deletion(-) create mode 100644 src/core_atmosphere/diagnostics/mpas_atm_diagnostics_packages.F diff --git a/src/core_atmosphere/diagnostics/Makefile b/src/core_atmosphere/diagnostics/Makefile index 614bc1c137..0efd219e10 100644 --- a/src/core_atmosphere/diagnostics/Makefile +++ b/src/core_atmosphere/diagnostics/Makefile @@ -25,12 +25,13 @@ mpas_soundings.o: ################### Generally no need to modify below here ################### -OBJS = mpas_atm_diagnostics_manager.o mpas_atm_diagnostics_utils.o +OBJS = mpas_atm_diagnostics_manager.o mpas_atm_diagnostics_utils.o mpas_atm_diagnostics_packages.o all: $(DIAGNOSTIC_MODULES) $(OBJS) mpas_atm_diagnostics_manager.o: mpas_atm_diagnostics_utils.o $(DIAGNOSTIC_MODULES) +mpas_atm_diagnostics_packages.o: mpas_atm_diagnostics_utils.o clean: $(RM) *.o *.mod *.f90 diff --git a/src/core_atmosphere/diagnostics/mpas_atm_diagnostics_packages.F b/src/core_atmosphere/diagnostics/mpas_atm_diagnostics_packages.F new file mode 100644 index 0000000000..08edbdb333 --- /dev/null +++ b/src/core_atmosphere/diagnostics/mpas_atm_diagnostics_packages.F @@ -0,0 +1,250 @@ +! Copyright (c) 2013, Los Alamos National Security, LLC (LANS) +! and the University Corporation for Atmospheric Research (UCAR). +! +! Unless noted otherwise source code is licensed under the BSD license. +! Additional copyright and license information can be found in the LICENSE file +! distributed with this code, or at http://mpas-dev.github.com/license.html +! +!================================================================================================================= + module mpas_atm_diagnostics_packages + + + use mpas_kind_types + use mpas_derived_types, only : mpas_pool_type, mpas_io_context_type, MPAS_LOG_ERR, MPAS_LOG_WARN + use mpas_pool_routines, only : mpas_pool_get_config, mpas_pool_get_package + use mpas_log, only : mpas_log_write + + implicit none + private + public :: diagnostics_setup_packages + + +! Module mpas_diagnostics_packages contains the definitions for the tendency and PV diagnostics packages +! Script is modeled after mpas_atmphys_packages.F +! +! Manda Chasteen, 21 May 2024 + + contains + + +!================================================================================================================= + function diagnostics_setup_packages(configs, packages, iocontext) result(ierr) +!================================================================================================================= + + ! inout arguments: + type (mpas_pool_type), intent(inout) :: configs + type (mpas_pool_type), intent(inout) :: packages + type (mpas_io_context_type), intent(inout) :: iocontext + + ! microphysics config: + character(len=StrKIND), pointer :: config_microp_scheme + + ! LBC config: + logical, pointer :: config_apply_lbcs + + ! Tendencies diagnostics config: + logical, pointer :: config_tend + + ! MC note: May's code in mpas_atm_core_interface is written in terms of tendenciesActive, but + ! physics code is written in terms of package names in Registry... why? + + ! Tendencies package: + logical, pointer :: tendenciesActive + + ! PV diagnostics configs: + logical, pointer :: config_pv_diag, config_pv_tend, config_pv_scalar, & + config_pv_microphys, config_pv_isobaric + + ! PV diagnostics packages: + logical, pointer :: pv_diagnosticsActive, pv_tendenciesActive, pv_scalarActive, & + pv_microphysicsActive, pv_isobaricActive + + integer :: ierr + +!----------------------------------------------------------------------------------------------------------------- + +! call mpas_log_write('') +! call mpas_log_write('--- enter subroutine diagnostics_setup_packages:') + + ierr = 0 + +!----------------------------------------------------------------------------------------------------------------- +!--- initialization of package for model tendency diagnostics: +!----------------------------------------------------------------------------------------------------------------- + + call mpas_log_write('----- Setting up tendency diagnostics variables -----') + call mpas_log_write('') + + nullify(config_tend) + call mpas_pool_get_config(configs, 'config_tend', config_tend) + + nullify(tendenciesActive) + call mpas_pool_get_package(packages, 'tendenciesActive', tendenciesActive) + + if (associated(config_tend) .and. associated(tendenciesActive)) then + tendenciesActive = config_tend + call mpas_log_write(' tendenciesActive = $l', logicArgs=(/tendenciesActive/)) + else + ierr = ierr + 1 + call mpas_log_write('Package setup failed for ''tendencies''. '// & + 'Either ''tendencies'' is not a package, or ''config_tend'' is not a namelist option.', & + messageType=MPAS_LOG_ERR) + end if + + +!----------------------------------------------------------------------------------------------------------------- +!--- initialization of packages for PV diagnostics: +! This contains compatability checks for various config_pv options. +!----------------------------------------------------------------------------------------------------------------- + + call mpas_log_write('----- Performing compatability checks for PV diagnostics configs -----') + call mpas_log_write('') + + call mpas_pool_get_config(configs, 'config_apply_lbcs', config_apply_lbcs) + call mpas_pool_get_config(configs, 'config_microp_scheme', config_microp_scheme) + + nullify(config_pv_diag) + call mpas_pool_get_config(configs, 'config_pv_diag', config_pv_diag) + + nullify(config_pv_tend) + call mpas_pool_get_config(configs, 'config_pv_tend', config_pv_tend) + + nullify(config_pv_scalar) + call mpas_pool_get_config(configs, 'config_pv_scalar', config_pv_scalar) + + nullify(config_pv_microphys) + call mpas_pool_get_config(configs, 'config_pv_microphys', config_pv_microphys) + + nullify(config_pv_isobaric) + call mpas_pool_get_config(configs, 'config_pv_isobaric', config_pv_isobaric) + + + ! Before setting packages, need to check compatability of config flags and then disable them as appropriate. + + ! if limited area simulation, disable all PV flags if activated + if (config_apply_lbcs .and. (config_pv_diag .or. config_pv_tend .or. config_pv_scalar & + .or. config_pv_microphys .or. config_pv_isobaric)) then + call mpas_log_write('PV diagnostics are not supported for limited-area simulations. Disabling.', MPAS_LOG_WARN) + config_pv_diag = .false. + config_pv_tend = .false. + config_pv_scalar = .false. + config_pv_microphys = .false. + config_pv_isobaric = .false. + end if + + ! if dependent config_pv flags are activated but parent config_pv_diag flag is not, deactivate them. + if ((.not. config_pv_diag) .and. (config_pv_tend .or. config_pv_scalar .or. config_pv_microphys .or. config_pv_isobaric)) then + config_pv_tend = .false. + config_pv_scalar = .false. + config_pv_microphys = .false. + config_pv_isobaric = .false. + call mpas_log_write('config_pv_diag is not activated; deactivated all dependent PV configs.', MPAS_LOG_WARN) + end if + + ! if config_pv_tend is activated but config_tend is not, deactivate. + if ((.not. config_tend) .and. (config_pv_tend .or. config_pv_microphys .or. config_pv_isobaric)) then + config_pv_tend = .false. + config_pv_microphys = .false. + config_pv_isobaric = .false. + call mpas_log_write('config_tend is not activated; deactivated all dependent PV configs.', MPAS_LOG_WARN) + end if + + ! if config_pv_microphys or config_pv_isobaric is activated but config_pv_tend is not, deactivate. + if ((.not. config_pv_tend) .and. (config_pv_microphys .or. config_pv_isobaric)) then + config_pv_microphys = .false. + config_pv_isobaric = .false. + call mpas_log_write('config_pv_tend is not activated; deactivated all dependent PV configs.', MPAS_LOG_WARN) + end if + + ! Ensure Thompson scheme is enabled for microphysics PV tendencies + if ((config_pv_microphys) .and. (config_microp_scheme /= 'mp_thompson')) then + call mpas_log_write('config_pv_microphys is not compatible with = '''//trim(config_microp_scheme)//''' -- disabling', MPAS_LOG_WARN) + config_pv_microphys = .false. + end if + + + call mpas_log_write('----- Setting up PV diagnostics variables -----') + call mpas_log_write('') + + nullify(pv_diagnosticsActive) + nullify(pv_tendenciesActive) + nullify(pv_scalarActive) + nullify(pv_microphysicsActive) + nullify(pv_isobaricActive) + + call mpas_pool_get_package(packages, 'pv_diagnosticsActive', pv_diagnosticsActive) + call mpas_pool_get_package(packages, 'pv_tendenciesActive', pv_tendenciesActive) + call mpas_pool_get_package(packages, 'pv_scalarActive', pv_scalarActive) + call mpas_pool_get_package(packages, 'pv_microphysicsActive', pv_microphysicsActive) + call mpas_pool_get_package(packages, 'pv_isobaricActive', pv_isobaricActive) + + + ! pv_diagnostics: + if (associated(config_pv_diag) .and. associated(pv_diagnosticsActive)) then + pv_diagnosticsActive = config_pv_diag + call mpas_log_write(' pv_diagnosticsActive = $l', logicArgs=(/pv_diagnosticsActive/)) + else + ierr = ierr + 1 + call mpas_log_write('Package setup failed for ''pv_diagnostics''. '// & + 'Either ''pv_diagnostics'' is not a package, ''config_pv_diag'' is not a namelist option, or '//& + ' ''config_pv_diag'' has been disabled due to incompatability with other model configuration options.', & + messageType=MPAS_LOG_ERR) + end if + + ! pv_tendencies: + if (associated(config_pv_tend) .and. associated(pv_tendenciesActive)) then + pv_tendenciesActive = config_pv_tend + call mpas_log_write(' pv_tendenciesActive = $l', logicArgs=(/pv_tendenciesActive/)) + else + ierr = ierr + 1 + call mpas_log_write('Package setup failed for ''pv_tendencies''. '// & + 'Either ''pv_tendencies'' is not a package, ''config_pv_tend'' is not a namelist option, or '//& + ' ''config_pv_tend'' has been disabled due to incompatability with other model configuration options.', & + messageType=MPAS_LOG_ERR) + end if + + ! pv_scalar: + if (associated(config_pv_scalar) .and. associated(pv_scalarActive)) then + pv_scalarActive = config_pv_scalar + call mpas_log_write(' pv_scalarActive = $l', logicArgs=(/pv_scalarActive/)) + else + ierr = ierr + 1 + call mpas_log_write('Package setup failed for ''pv_scalar''. '// & + 'Either ''pv_scalar'' is not a package, ''config_pv_scalar'' is not a namelist option, or '//& + ' ''config_pv_scalar'' has been disabled due to incompatability with other model configuration options.', & + messageType=MPAS_LOG_ERR) + end if + + ! pv_microphys: + if (associated(config_pv_microphys) .and. associated(pv_microphysicsActive)) then + pv_microphysicsActive = config_pv_microphys + call mpas_log_write(' pv_microphysicsActive = $l', logicArgs=(/pv_microphysicsActive/)) + else + ierr = ierr + 1 + call mpas_log_write('Package setup failed for ''pv_microphysics''. '// & + 'Either ''pv_microphysics'' is not a package, ''config_pv_microphys'' is not a namelist option, or '//& + ' ''config_pv_microphys'' has been disabled due to incompatability with other model configuration options.', & + messageType=MPAS_LOG_ERR) + end if + + ! pv_isobaric: + if (associated(config_pv_isobaric) .and. associated(pv_isobaricActive)) then + pv_isobaricActive = config_pv_isobaric + call mpas_log_write(' pv_isobaricActive = $l', logicArgs=(/pv_isobaricActive/)) + else + ierr = ierr + 1 + call mpas_log_write('Package setup failed for ''pv_isobaric''. '// & + 'Either ''pv_isobaric'' is not a package, ''config_pv_isobaric'' is not a namelist option, or '//& + ' ''config_pv_isobaric'' has been disabled due to incompatability with other model configuration options.', & + messageType=MPAS_LOG_ERR) + end if + + + end function diagnostics_setup_packages + +!================================================================================================================= + end module mpas_atm_diagnostics_packages +!================================================================================================================= + + + diff --git a/src/core_atmosphere/mpas_atm_core_interface.F b/src/core_atmosphere/mpas_atm_core_interface.F index c8db24ceac..0af1bdbc97 100644 --- a/src/core_atmosphere/mpas_atm_core_interface.F +++ b/src/core_atmosphere/mpas_atm_core_interface.F @@ -110,6 +110,8 @@ function atm_setup_packages(configs, streamInfo, packages, iocontext) result(ier use mpas_atmphys_packages #endif + use mpas_atm_diagnostics_packages ! MC added + implicit none type (mpas_pool_type), intent(inout) :: configs @@ -208,6 +210,17 @@ function atm_setup_packages(configs, streamInfo, packages, iocontext) result(ier end if #endif + + ! MC ADDED + ! Tendency and PV diagnostics + ! + local_ierr = diagnostics_setup_packages(configs, packages, iocontext) + if (local_ierr /= 0) then + ierr = ierr + 1 + call mpas_log_write('Package setup failed for diagnostics in core_atmosphere', messageType=MPAS_LOG_ERR) + end if + + end function atm_setup_packages