Refactor API boundary condition passing mechanism #1431

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.

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

Closed

glemieux wants to merge 117 commits into NGEET:main from glemieux:bc-refactor-patch-direct

biogeochem/EDCanopyStructureMod.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -1307,7 +1307,7 @@ end subroutine canopy_spread @@
       ! =====================================================================================
-      subroutine canopy_summarization( nsites, sites, bc_in )
+      subroutine canopy_summarization( nsites, sites )
         ! ----------------------------------------------------------------------------------
         ! Much of this routine was once ed_clm_link minus all the IO and history stuff
@@ Expand All / @@ -1323,7 +1323,6 @@ subroutine canopy_summarization( nsites, sites, bc_in ) @@
         ! !ARGUMENTS
         integer                 , intent(in)            :: nsites
         type(ed_site_type)      , intent(inout), target :: sites(nsites)
-        type(bc_in_type)        , intent(in)            :: bc_in(nsites)
         !
         ! !LOCAL VARIABLES:
         type (fates_patch_type)  , pointer :: currentPatch
@@ Expand Down @@

biogeochem/EDPatchDynamicsMod.F90

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -680,7 +680,7 @@ subroutine spawn_patches( currentSite, bc_in )
  
                       call newPatch%Create(age, site_areadis, i_landusechange_receiverpatchlabel, i_nocomp_pft, &

                                             num_swb, numpft, currentSite%nlevsoil, hlm_current_tod,              &

                                             hlm_regeneration_model)

                                             hlm_regeneration_model, currentSite%api)

                       ! Initialize the litter pools to zero, these

                       ! pools will be populated by looping over the existing patches

    @@ -1371,7 +1371,7 @@ subroutine spawn_patches( currentSite, bc_in )
  
                    call buffer_patch%Create(0._r8, 0._r8, i_land_use_label, 0, &

                         num_swb, numpft, currentSite%nlevsoil, hlm_current_tod,              &

                         hlm_regeneration_model)

                         hlm_regeneration_model, currentSite%api)

                    ! Initialize the litter pools to zero

                    do el=1,num_elements

    @@ -1664,7 +1664,7 @@ subroutine split_patch(currentSite, currentPatch, new_patch, fraction_to_keep, a
  
        call new_patch%Create(0._r8, temp_area, &

             currentPatch%land_use_label, currentPatch%nocomp_pft_label, &

             num_swb, numpft, currentSite%nlevsoil, hlm_current_tod, &

             hlm_regeneration_model)

             hlm_regeneration_model, currentSite%api)

        ! Initialize the litter pools to zero, these

        ! pools will be populated shortly

biogeochem/EDPhysiologyMod.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -3215,7 +3215,7 @@ subroutine fragmentation_scaler( currentPatch, bc_in) @@
            if ( use_hlm_soil_scalar ) then
              ! Calculate the fragmentation_scaler
-             currentPatch%fragmentation_scaler =  min(1.0_r8,max(0.0_r8,bc_in%t_scalar_sisl * bc_in%w_scalar_sisl))
+             currentPatch%fragmentation_scaler =  min(1.0_r8,max(0.0_r8,currentPatch%bc_in%t_scalar_sisl * currentPatch%bc_in%w_scalar_sisl))
            else
@@ Expand Down @@

biogeochem/FatesPatchMod.F90

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -32,6 +32,9 @@ module FatesPatchMod
  
      use FatesRadiationMemMod,   only : num_rad_stream_types

      use FatesInterfaceTypesMod, only : hlm_hio_ignore_val

      use FatesInterfaceTypesMod, only : numpft

      use FatesInterfaceTypesMod, only : bc_in_type

      use FatesInterfaceTypesMod, only : bc_out_type

      use FatesInterfaceTypesMod, only : fates_interface_registry_base_type

      use shr_infnan_mod,         only : nan => shr_infnan_nan, assignment(=)

      use shr_log_mod,            only : errMsg => shr_log_errMsg

    @@ -48,6 +51,14 @@ module FatesPatchMod
  
        type (fates_cohort_type), pointer :: shortest => null() ! pointer to patch's shortest cohort

        type (fates_patch_type),  pointer :: older => null()    ! pointer to next older patch   

        type (fates_patch_type),  pointer :: younger => null()  ! pointer to next younger patch

        ! BC data

        ! TODO change this to a specific bc type for incremental refactor purposes if this method is picked

        type(bc_in_type)  :: bc_in

        type(bc_out_type) :: bc_out

        ! API registry container

        type(fates_interface_registry_base_type) :: api

        !---------------------------------------------------------------------------

    @@ -242,13 +253,16 @@ module FatesPatchMod
  
          procedure :: Dump

          procedure :: CheckVars

          procedure, private :: InitializeInterfaceRegistry

          procedure, private :: InitializeInterfaceVariables

      end type fates_patch_type

      contains 

        !===========================================================================

        subroutine Init(this, num_swb, num_levsoil)

        subroutine Init(this, num_swb, num_levsoil, api_pointer)

          !

          !  DESCRIPTION:

          !  Initialize a new patch - allocate arrays and set values to nan and/or 0.0

    @@ -258,6 +272,7 @@ subroutine Init(this, num_swb, num_levsoil)
  
          class(fates_patch_type), intent(inout) :: this        ! patch object

          integer,                 intent(in)    :: num_swb     ! number of shortwave broad-bands to track

          integer,                 intent(in)    :: num_levsoil ! number of soil layers

          class(fates_interface_registry_base_type), pointer, intent(in) :: api_pointer

          ! allocate arrays 

          allocate(this%tr_soil_dir(num_swb))

    @@ -270,6 +285,13 @@ subroutine Init(this, num_swb, num_levsoil)
  
          allocate(this%sabs_dif(num_swb))

          allocate(this%fragmentation_scaler(num_levsoil))

          ! Initialize the patch-level API registry

          call this%InitializeInterfaceRegistry()

          ! Initialize and register the variables in the API registry

          ! This also allocates the boundary conditions

          call this%InitializeInterfaceVariables(api_pointer)

          ! initialize all values to nan

          call this%NanValues()

    @@ -507,6 +529,12 @@ subroutine NanValues(this)
  
          this%scorch_ht(:)                 = nan 

          this%tfc_ros                      = nan

          this%frac_burnt                   = nan

          ! Boundary conditions

          this%bc_in%w_scalar_sisl(:)       = nan

          this%bc_in%t_scalar_sisl(:)       = nan

          this%bc_in%nlevdecomp             = fates_unset_int

          this%bc_in%nlevsoil               = fates_unset_int

        end subroutine NanValues

    @@ -594,6 +622,12 @@ subroutine ZeroValues(this)
  
          this%tfc_ros                           = 0.0_r8

          this%frac_burnt                        = 0.0_r8

          ! Boundary conditions

          this%bc_in%w_scalar_sisl(:)            = 0.0_r8

          this%bc_in%t_scalar_sisl(:)            = 0.0_r8

          this%bc_in%nlevdecomp                  = 0.0_r8

          this%bc_in%nlevsoil                    = 0.0_r8

        end subroutine ZeroValues

        !===========================================================================

    @@ -686,7 +720,7 @@ end subroutine InitLitter
  
        !===========================================================================

        subroutine Create(this, age, area, land_use_label, nocomp_pft, num_swb, num_pft,    &

          num_levsoil, current_tod, regeneration_model)

          num_levsoil, current_tod, regeneration_model, api_pointer)

          !

          ! DESCRIPTION:

          ! create a new patch with input and default values

    @@ -703,11 +737,13 @@ subroutine Create(this, age, area, land_use_label, nocomp_pft, num_swb, num_pft,
  
          integer,                 intent(in)    :: num_levsoil        ! number of soil layers

          integer,                 intent(in)    :: current_tod        ! time of day [seconds past 0Z]

          integer,                 intent(in)    :: regeneration_model ! regeneration model version

          class(fates_interface_registry_base_type), pointer, intent(in) :: api_pointer

          ! initialize patch

          ! sets all values to nan, then some values to zero

          call this%Init(num_swb, num_levsoil)

          ! sets all values to nan, then some values to zero, and initialize interface registry

          call this%Init(num_swb, num_levsoil, api_pointer)

          ! initialize running means for patch

          call this%InitRunningMeans(current_tod, regeneration_model, num_pft)

    @@ -1288,4 +1324,44 @@ end subroutine CheckVars
  
        !===========================================================================  

        subroutine InitializeInterfaceRegistry(this)

          use FatesInterfaceTypesMod, only: hlm_fates_soil_level

          class(fates_patch_type), intent(inout) :: this

          ! Initialize the patch-level interface variable registry for the FATES-side

          call this%api%InitializeInterfaceRegistry()

          ! Register the boundary condition data variables that are set during initialization only

          ! See RegisterInterfaceVariables patch-type bound procedure for remaining variables registrations

          call this%api%Register(hlm_fates_soil_level, this%bc_in%nlevsoil)

        end subroutine InitializeInterfaceRegistry

    ! ======================================================================================

        subroutine InitializeInterfaceVariables(this, input_api)

          use FatesInterfaceTypesMod, only : hlm_fates_decomp_frac_moisture

          use FatesInterfaceTypesMod, only : hlm_fates_decomp_frac_temperature

          class(fates_patch_type), intent(inout) :: this

          class(fates_interface_registry_base_type), intent(in) :: input_api

          ! Initialize interface variables

          call this%api%InitializeInterfaceVariables(input_api)

          ! Allocate the boundary conditions array using the BCs set during initialization

          allocate(this%bc_in%w_scalar_sisl(this%bc_in%nlevsoil))

          allocate(this%bc_in%t_scalar_sisl(this%bc_in%nlevsoil))

          ! Register the boundary condintion variables not exclusively updated during initialization

          call this%api%Register(hlm_fates_decomp_frac_moisture, this%bc_in%w_scalar_sisl)

          call this%api%Register(hlm_fates_decomp_frac_temperature, this%bc_in%t_scalar_sisl)

        end subroutine InitializeInterfaceVariables

    ! ======================================================================================

    end module FatesPatchMod

biogeophys/EDAccumulateFluxesMod.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -29,7 +29,7 @@ module EDAccumulateFluxesMod @@
       !------------------------------------------------------------------------------
-      subroutine AccumulateFluxes_ED(nsites, sites, bc_in, bc_out, dt_time)
+      subroutine AccumulateFluxes_ED(nsites, sites, bc_in, dt_time)
         !
         ! !DESCRIPTION:
@@ Expand All @@
         use EDTypesMod        , only : ed_site_type, AREA
         use FatesPatchMod,      only : fates_patch_type
         use FatesCohortMod,     only : fates_cohort_type
-        use FatesInterfaceTypesMod , only : bc_in_type,bc_out_type
+        use FatesInterfaceTypesMod , only : bc_in_type
         !
         ! !ARGUMENTS
         integer,            intent(in)            :: nsites
         type(ed_site_type), intent(inout), target :: sites(nsites)
         type(bc_in_type),   intent(in)            :: bc_in(nsites)
-        type(bc_out_type),  intent(inout)         :: bc_out(nsites)
         real(r8),           intent(in)            :: dt_time  ! timestep interval
         !
         ! !LOCAL VARIABLES:
@@ Expand Down @@

main/EDInitMod.F90

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -53,7 +53,7 @@ module EDInitMod
  
      use EDTypesMod                , only : phen_dstat_moistoff

      use EDTypesMod                , only : phen_cstat_notcold

      use EDTypesMod                , only : phen_dstat_moiston

      use FatesInterfaceTypesMod         , only : bc_in_type,bc_out_type

      use FatesInterfaceTypesMod         , only : bc_in_type

      use FatesInterfaceTypesMod         , only : hlm_use_planthydro

      use FatesInterfaceTypesMod         , only : hlm_use_inventory_init

      use FatesInterfaceTypesMod         , only : hlm_use_fixed_biogeog

    @@ -128,15 +128,14 @@ module EDInitMod
  
      ! ============================================================================

      subroutine init_site_vars( site_in, bc_in, bc_out )

      subroutine init_site_vars( site_in, bc_in )

        !

        ! !DESCRIPTION:

        !

        !

        ! !ARGUMENTS

        type(ed_site_type), intent(inout) :: site_in

        type(bc_in_type),intent(in)       :: bc_in

        type(bc_out_type),intent(in)      :: bc_out

        !

        ! !LOCAL VARIABLES:

        !----------------------------------------------------------------------

    @@ -784,7 +783,7 @@ subroutine init_patches( nsites, sites, bc_in)
  
                    call newp%Create(age, newparea, nocomp_bareground_land, nocomp_bareground,     &

                         num_swb, numpft, sites(s)%nlevsoil, hlm_current_tod,      &

                         hlm_regeneration_model)

                         hlm_regeneration_model, sites(s)%api)

                    ! set pointers for first patch (or only patch, if nocomp is false)

                    newp%patchno = 1

    @@ -863,7 +862,7 @@ subroutine init_patches( nsites, sites, bc_in)
  
                             call newp%Create(age, newparea, i_lu_state, nocomp_pft, &

                                  num_swb, numpft, sites(s)%nlevsoil, hlm_current_tod, &

                                  hlm_regeneration_model)

                                  hlm_regeneration_model, sites(s)%api)

                             if (is_first_patch) then !is this the first patch?

                                ! set pointers for first patch (or only patch, if nocomp is false)

main/EDTypesMod.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ module EDTypesMod @@
       use FatesConstantsMod,     only : secondaryland
       use FatesConstantsMod,     only : secondary_age_threshold
       use FatesConstantsMod,     only : nearzero
+      use FatesConstantsMod    , only : n_landuse_cats
       use FatesGlobals,          only : fates_log
       use FatesHydraulicsMemMod, only : ed_cohort_hydr_type
       use FatesHydraulicsMemMod, only : ed_site_hydr_type
@@ Expand All / @@ -29,8 +30,8 @@ module EDTypesMod @@
       use FatesConstantsMod,     only : fates_unset_r8
       use FatesInterfaceTypesMod,only : bc_in_type
       use FatesInterfaceTypesMod,only : bc_out_type
-      use FatesConstantsMod    , only : n_landuse_cats
       use FatesInterfaceTypesMod,only : hlm_parteh_mode
+      use FatesInterfaceTypesMod,only : fates_interface_registry_base_type
       use FatesCohortMod,        only : fates_cohort_type
       use FatesPatchMod,         only : fates_patch_type
       use EDParamsMod,           only : nclmax, nlevleaf, maxpft
@@ Expand Down Expand Up / @@ -327,10 +328,15 @@ module EDTypesMod @@
       type, public :: ed_site_type
-         ! POINTERS
+         !! POINTERS
+         ! patch pointers
          type (fates_patch_type), pointer :: oldest_patch => null()   ! pointer to oldest patch at the site
          type (fates_patch_type), pointer :: youngest_patch => null() ! pointer to yngest patch at the site
+         ! interface pointer
+         type(fates_interface_registry_base_type), pointer :: api => null() ! pointer to the fates interface type api
          ! Resource management
          type (ed_resources_management_type) :: resources_management ! resources_management at the site
@@ Expand All / @@ -339,6 +345,10 @@ module EDTypesMod @@
          ! position in history output fields
          !integer :: clump_id
+         ! Arrays that map the HLM subgrid index for each patch in this site
+         integer, allocatable :: column_map(:)
+         integer, allocatable :: patch_map(:)
          ! Global index of this site in the history output file
          integer :: h_gid
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor API boundary condition passing mechanism #1431

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!