lfric_apps/interfaces/jules_interface/source/diagnostics/jules_exp_diags_mod.f90 at 896f917332536fc800005ed3ed6994cb3de107cf · mo-marqh/lfric_apps · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
!-------------------------------------------------------------------------------
! (c) Crown copyright 2023 Met Office. All rights reserved.
! The file LICENCE, distributed with this code, contains details of the terms
! under which the code may be used.
!-------------------------------------------------------------------------------
!> @brief Processes diagnostics for jules_exp_alg

module jules_exp_diags_mod

  use constants_mod,       only: l_def
  use field_mod,           only: field_type
  use integer_field_mod,   only: integer_field_type
  use timing_mod,          only: start_timing, stop_timing, &
                                 tik, LPROF
  use initialise_diagnostics_mod,     only : init_diag => init_diagnostic_field

  implicit none

  private

  ! Logical indicating whether diagnostics are requested
  logical( l_def ) :: gross_prim_prod_flag, z0h_eff_flag,  &
                      soil_respiration_flag

  public :: initialise_diags_for_jules_exp
  public :: output_diags_for_jules_exp

contains

  !> @brief Initialise fields for locally-computed diagnostics
  !> @param[inout] z0h_eff            Gridbox mean effective roughness length for scalars
  !> @param[inout] gross_prim_prod    Gross Primary Productivity
  !> @param[inout] soil_respiration   Soil heterotrophic respiration
  subroutine initialise_diags_for_jules_exp(z0h_eff, gross_prim_prod, &
                                            soil_respiration)

    implicit none

    type( field_type ), intent(inout) :: z0h_eff
    type( field_type ), intent(inout) :: gross_prim_prod
    type( field_type ), intent(inout) :: soil_respiration
    integer( tik )                    :: id

    if ( LPROF ) call start_timing( id, 'diags.jules_exp' )

    z0h_eff_flag = init_diag(z0h_eff, 'surface__z0h_eff')
    gross_prim_prod_flag = init_diag(gross_prim_prod, 'surface__gross_prim_prod')
    soil_respiration_flag = init_diag(soil_respiration, 'surface__soil_respiration')

    if ( LPROF ) call stop_timing( id, 'diags.jules_exp' )

  end subroutine initialise_diags_for_jules_exp

  !> @brief Output diagnostics from jules_exp_alg
  !> @param[in] z0h_eff           Gridbox mean effective roughness length for scalars
  !> @param[in] tile_fraction     Surface tile fractions
  !> @param[in] z0m_tile          tile roughness length for momentum
  !> @param[in] z0m               Cell roughness length
  !> @param[in] canopy_height     Height of the plant canopy
  !> @param[in] leaf_area_index   Leaf area index of vegetated tiles
  !> @param[in] gross_prim_prod   Gross Primary Productivity
  !> @param[in] net_prim_prod     Net Primary Productivity
  !> @param[in] gc_tile           Stomatal conductance on tiles (m s-1)
  !> @param[in] soil_respiration  Soil respiration  (kg m-2 s-1)
  !> @param[in] ustar             surface friction velocity
  !> @param[in] z0m_eff           Gridbox mean effective roughness length for momentum
  !> @param[in] dust_flux         Flux of mineral dust by division
  subroutine output_diags_for_jules_exp(z0h_eff, tile_fraction, z0m_tile, z0m, &
                                     canopy_height, leaf_area_index,           &
                                     gross_prim_prod, net_prim_prod, gc_tile,  &
                                     soil_respiration, ustar, z0m_eff,         &
                                     dust_flux)

    implicit none

    ! Prognostic fields to output
    type( field_type ), intent(in)    :: z0h_eff
    type( field_type ), intent(in)    :: tile_fraction, z0m_tile, z0m,         &
                                         gross_prim_prod, net_prim_prod,       &
                                         gc_tile, soil_respiration, ustar,     &
                                         z0m_eff, canopy_height, leaf_area_index
    type( field_type ),  intent(in)   :: dust_flux
    integer( tik )                    :: id

    if ( LPROF ) call start_timing( id, 'diags.jules_exp' )

    ! Prognostic fields from surface collection
    call tile_fraction%write_field('surface__tile_fraction')
    call z0m_tile%write_field('surface__z0m_tile')
    call z0m%write_field('surface__z0m')
    call z0m_eff%write_field('surface__z0m_eff')
    call canopy_height%write_field('surface__canopy_height')
    call leaf_area_index%write_field('surface__leaf_area_index')
    call net_prim_prod%write_field('surface__net_prim_prod')
    call gc_tile%write_field('surface__gc_tile')
    call ustar%write_field('surface__ustar')
    ! Prognostic fields from aerosol collection
    call dust_flux%write_field('aerosol__dust_flux')

    ! Diagnostics computed in the kernel
    if (z0h_eff_flag) call z0h_eff%write_field()
    if (gross_prim_prod_flag) call gross_prim_prod%write_field()
    if (soil_respiration_flag) call soil_respiration%write_field()

    if ( LPROF ) call stop_timing( id, 'diags.jules_exp' )

  end subroutine output_diags_for_jules_exp
end module jules_exp_diags_mod