Skip to content

WIP: Identify tracers and values to be exported to ATM #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nikizadehgfdl wants to merge 1 commit into
base: dev4.2
Choose a base branch
from
Open

WIP: Identify tracers and values to be exported to ATM #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion generic_tracers/FMS_coupler_util.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module FMS_coupler_util
use mpp_mod, only : mpp_error, FATAL, WARNING
use coupler_types_mod, only : coupler_2d_bc_type, ind_flux, ind_deltap, ind_kw
use coupler_types_mod, only : ind_alpha, ind_csurf, ind_sc_no
use coupler_types_mod, only : ind_export_value_ice

implicit none ; private

Expand Down Expand Up @@ -43,6 +44,7 @@ subroutine extract_coupler_values(BC_struc, BC_index, BC_element, array_out, ilb

if ((BC_element /= ind_flux) .and. (BC_element /= ind_alpha) .and. &
(BC_element /= ind_csurf) .and. (BC_element /= ind_sc_no) .and. &
(BC_element /= ind_export_value_ice) .and. &
(BC_element /= ind_deltap) .and. (BC_element /= ind_kw)) then
call mpp_error(FATAL,"extract_coupler_values: Unrecognized BC_element.")
endif
Expand Down Expand Up @@ -109,6 +111,7 @@ subroutine set_coupler_values(array_in, BC_struc, BC_index, BC_element, ilb, jlb

if ((BC_element /= ind_flux) .and. (BC_element /= ind_alpha) .and. &
(BC_element /= ind_csurf) .and. (BC_element /= ind_sc_no) .and. &
(BC_element /= ind_export_value_ice) .and. &
(BC_element /= ind_deltap) .and. (BC_element /= ind_kw)) then
call mpp_error(FATAL,"extract_coupler_values: Unrecognized BC_element.")
endif
Expand All @@ -124,7 +127,8 @@ subroutine set_coupler_values(array_in, BC_struc, BC_index, BC_element, ilb, jlb
"The requested boundary condition element is not associated.")
if (.not.associated(BC_struc%bc(BC_index)%field(BC_element)%values)) &
call mpp_error(FATAL,"set_coupler_values: " // &
"The requested boundary condition value array is not associated.")
"The requested boundary condition value array is not associated for "//&
trim(BC_struc%bc(BC_index)%name))

Array_out => BC_struc%bc(BC_index)%field(BC_element)%values

Expand Down
20 changes: 20 additions & 0 deletions generic_tracers/generic_COBALT.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6214,6 +6214,9 @@ subroutine user_add_tracers(tracer_list)
longname = 'Chlorophyll', &
units = 'ug kg-1', &
prog = .false., &
export2atm = .true., &
export2atm_name = 'export2atm_chl', &
flux_param = (/ 1.0 /), &
init_value = 0.08 )
!
! CO3_ion (Carbonate ion)
Expand Down Expand Up @@ -12043,6 +12046,9 @@ subroutine generic_COBALT_set_boundary_values(tracer_list,SST,SSS,rho,ilb,jlb,ta
real, dimension(:,:,:), ALLOCATABLE :: htotal_field,co3_ion_field
real, dimension(:,:), ALLOCATABLE :: co2_alpha,co2_csurf,co2_sc_no,o2_alpha,o2_csurf,o2_sc_no,nh3_alpha,nh3_csurf,nh3_sc_no,phos_nh3_exchange
real, dimension(:,:), ALLOCATABLE :: c14o2_alpha,c14o2_csurf
real, dimension(:,:,:,:), pointer :: tr_field
real, dimension(:,:), ALLOCATABLE :: g_exported2atm
type(g_tracer_type), pointer :: g_tracer
real :: pka_nh3,tr,ltr

logical :: phos_nh3_override
Expand Down Expand Up @@ -12351,6 +12357,20 @@ subroutine generic_COBALT_set_boundary_values(tracer_list,SST,SSS,rho,ilb,jlb,ta

endif !RADIOCARBON>>

!Loop over tracers and for the ones that are registered as "export2atm" set values to be exported to ATM
g_tracer => tracer_list !Local pointer. Do not change the input pointer!
do
if(g_tracer%export2atm) then
call g_tracer_get_pointer(tracer_list,g_tracer%name, 'field', tr_field)
allocate(g_exported2atm(isd:ied, jsd:jed)); g_exported2atm(:,:)=tr_field(:,:,1,tau)* cobalt%Rho_0 / 1e9
call g_tracer_set_values(tracer_list,g_tracer%name, 'exported2atm',g_exported2atm,isd,jsd)
deallocate(g_exported2atm)
endif
!traverse the linked list till hit NULL
if(.NOT. associated(g_tracer%next)) exit
g_tracer => g_tracer%next
enddo

deallocate(co2_alpha,co2_csurf,&
co2_sc_no,o2_alpha, &
c14o2_alpha,c14o2_csurf, &
Expand Down
58 changes: 54 additions & 4 deletions generic_tracers/generic_tracer_utils.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ module g_tracer_utils
#include <fms_platform.h>

use coupler_types_mod, only: coupler_2d_bc_type, ind_flux, ind_deltap, ind_kw
use coupler_types_mod, only: ind_alpha, ind_csurf, ind_sc_no
use coupler_types_mod, only: ind_alpha, ind_csurf, ind_sc_no, ind_export_value_ice
use FMS_coupler_util, only: extract_coupler_values, set_coupler_values
use atmos_ocean_fluxes_mod, only: aof_set_coupler_flux
use mpp_mod, only: mpp_error, NOTE, WARNING, FATAL
Expand Down Expand Up @@ -135,12 +135,14 @@ module g_tracer_utils
! logical :: flux_wetdep = .false. !Is there a wet deposition?
! logical :: flux_drydep = .false. !Is there a dry deposition?
! logical :: flux_bottom = .false. !Is there a flux through bottom?
! logical :: export2atm = .false. !Should the surface value be exported to atm ?
!
! ! Flux identifiers to be set by aof_set_coupler_flux()
! integer :: flux_gas_ind = -1
! integer :: flux_runoff_ind = -1
! integer :: flux_wetdep_ind = -1
! integer :: flux_drydep_ind = -1
! integer :: export2atm_ind = -1
!
!end type g_tracer_type
!
Expand Down Expand Up @@ -168,6 +170,7 @@ module g_tracer_utils

! Tracer flux names recognized by component models (OCN, LND, ICE, ATM)
character(len=fm_string_len) :: flux_gas_name, flux_gas_type, flux_runoff_name, flux_wetdep_name, flux_drydep_name,implementation
character(len=fm_string_len) :: export2atm_name
real, _ALLOCATABLE, dimension(:) :: flux_param, flux_gas_param

! IN and OUT (restart) files
Expand Down Expand Up @@ -215,6 +218,9 @@ module g_tracer_utils
! Dry deposition flux of tracer
real, _ALLOCATABLE, dimension(:,:) :: drydep _NULL

! Property of tracer to be exported directly to ATM
real, _ALLOCATABLE, dimension(:,:) :: exported2atm _NULL

! Tracer saturation, alpha and schmidt number
real, _ALLOCATABLE, dimension(:,:) :: csurf _NULL

Expand Down Expand Up @@ -257,12 +263,13 @@ module g_tracer_utils
logical :: flux_drydep = .false. !Is there a dry deposition?
logical :: flux_bottom = .false. !Is there a flux through bottom?
logical :: has_btm_reservoir = .false. !Is there a flux bottom reservoir?

logical :: export2atm = .false. !Is there a surface value to be exported to atmosphere?
! Flux identifiers to be set by aof_set_coupler_flux()
integer :: flux_gas_ind = -1
integer :: flux_runoff_ind = -1
integer :: flux_wetdep_ind = -1
integer :: flux_drydep_ind = -1
integer :: export2atm_ind = -1

logical :: requires_restart = .true.
! Tracer source: filename, type, var name, units, record, gridfile
Expand Down Expand Up @@ -749,7 +756,7 @@ end subroutine g_tracer_add_param_string
! </SUBROUTINE>

subroutine g_tracer_add(node_ptr, package, name, longname, units, prog, const_init_value,init_value,&
flux_gas, flux_gas_name, flux_runoff, flux_wetdep, flux_drydep, flux_gas_molwt, flux_gas_param, &
flux_gas, flux_gas_name, flux_runoff, flux_wetdep, flux_drydep, flux_gas_molwt, flux_gas_param, export2atm, export2atm_name,&
flux_param, flux_bottom, btm_reservoir, move_vertical, diff_vertical, sink_rate, flux_gas_restart_file, &
flux_gas_type,requires_src_info,standard_name,diag_name,diag_field_units,diag_field_scaling_factor,implementation)

Expand All @@ -764,12 +771,14 @@ subroutine g_tracer_add(node_ptr, package, name, longname, units, prog, const_i
logical, intent(in), optional :: flux_wetdep
logical, intent(in), optional :: flux_drydep
logical, intent(in), optional :: flux_bottom
logical, intent(in), optional :: export2atm
logical, intent(in), optional :: btm_reservoir
logical, intent(in), optional :: move_vertical
logical, intent(in), optional :: diff_vertical
real, intent(in), optional :: flux_gas_molwt
real, dimension(:), intent(in), optional :: flux_gas_param
real, dimension(:), intent(in), optional :: flux_param
character(len=*), intent(in), optional :: export2atm_name
character(len=*), intent(in), optional :: flux_gas_name
character(len=*), intent(in), optional :: implementation
character(len=*), intent(in), optional :: flux_gas_type
Expand Down Expand Up @@ -910,6 +919,15 @@ subroutine g_tracer_add(node_ptr, package, name, longname, units, prog, const_i
g_tracer%flux_drydep_name=trim("dry_dep_") // trim(g_tracer%alias)
endif

if(present(export2atm)) g_tracer%export2atm = export2atm
if(g_tracer%export2atm) then
if(present(export2atm_name))then
g_tracer%export2atm_name=trim(export2atm_name)
else
g_tracer%export2atm_name=trim("export2atm_") // trim(g_tracer%alias)
endif
endif

if(present(flux_bottom)) g_tracer%flux_bottom = flux_bottom

if(present(btm_reservoir)) g_tracer%has_btm_reservoir = btm_reservoir
Expand Down Expand Up @@ -1007,6 +1025,10 @@ subroutine g_tracer_init(g_tracer)
allocate(g_tracer%drydep(isd:ied,jsd:jed));g_tracer%drydep(:,:) = 0.0
endif

if(g_tracer%export2atm) then
allocate(g_tracer%exported2atm(isd:ied,jsd:jed));g_tracer%exported2atm(:,:) = 0.
endif

if(g_tracer%flux_bottom) then
allocate(g_tracer%btf(isd:ied,jsd:jed));g_tracer%btf(:,:) = 0.0
endif
Expand All @@ -1022,6 +1044,7 @@ subroutine g_tracer_init(g_tracer)
if(g_tracer%diff_vertical) then
allocate(g_tracer%vdiff(isd:ied,jsd:jed, nk));g_tracer%vdiff(:,:,:) = 0.
endif

!Surface flux %stf exists if one of the following fluxes were requested:

if(g_tracer%flux_gas .or. g_tracer%flux_runoff .or. g_tracer%flux_wetdep .or. g_tracer%flux_drydep) then
Expand Down Expand Up @@ -1086,7 +1109,17 @@ subroutine g_tracer_flux_init(g_tracer, verbosity)
)
endif


!The following aof call must match a corresponding call in ATM
!(e.g., atmos_tracer_driver module)
!for the flux name,type,implementation
if(g_tracer%export2atm) then
g_tracer%export2atm_ind = aof_set_coupler_flux(g_tracer%export2atm_name,&
flux_type = 'export_value', &
implementation = 'direct', &
param = g_tracer%flux_param, &
verbosity = verbosity &
)
endif

end subroutine g_tracer_flux_init

Expand Down Expand Up @@ -1371,6 +1404,17 @@ subroutine g_tracer_coupler_set(g_tracer_list,IOB_struc,value)
)
endif

if(_ALLOCATED(g_tracer%exported2atm)) then
!This is to export a field directly to ATM component
call set_coupler_values(g_tracer%exported2atm, &
BC_struc = IOB_struc, &
BC_index = g_tracer%export2atm_ind, &
BC_element = ind_export_value_ice, &
ilb=g_tracer_com%isd, jlb=g_tracer_com%jsd ,&
is=g_tracer_com%isc, ie=g_tracer_com%iec,&
js=g_tracer_com%jsc, je=g_tracer_com%jec &
)
endif
!traverse the linked list till hit NULL
if(.NOT. associated(g_tracer%next)) exit
g_tracer => g_tracer%next
Expand Down Expand Up @@ -1827,6 +1871,8 @@ subroutine g_tracer_get_2D(g_tracer_list,name,member,array_ptr)
array_ptr => g_tracer%drydep
case ('wetdep')
array_ptr => g_tracer%wetdep
case ('exported2atm')
array_ptr => g_tracer%exported2atm
case default
call mpp_error(FATAL, trim(sub_name)//": Not a known member variable: "//trim(member))
end select
Expand Down Expand Up @@ -1963,6 +2009,8 @@ subroutine g_tracer_get_2D_val(g_tracer_list,name,member,array,isd,jsd)
array = g_tracer%drydep
case ('wetdep')
array = g_tracer%wetdep
case ('exported2atm')
array = g_tracer%exported2atm
case default
call mpp_error(FATAL, trim(sub_name)//": Not a known member variable: "//trim(member))
end select
Expand Down Expand Up @@ -2098,6 +2146,8 @@ subroutine g_tracer_set_2D(g_tracer_list,name,member,array,isd,jsd,weight)
g_tracer%drydep = w0*g_tracer%drydep + w1*array
case ('wetdep')
g_tracer%wetdep = w0*g_tracer%wetdep + w1*array
case ('exported2atm')
g_tracer%exported2atm = w0*g_tracer%exported2atm + w1*array
case default
call mpp_error(FATAL, trim(sub_name)//": Not a known member variable: "//trim(member))
end select
Expand Down