Skip to content

Lfric2lfric: generate lbcs in the lbc mesh #369

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

Draft
ukmo-juan-castillo wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Lfric2lfric: generate lbcs in the lbc mesh #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4ee7122
Issue 192: update partitioning namelist in lfric2lfric
ukmo-juan-castillo Jan 30, 2026
e5ac5f5
Revert previous change, intended for another branch
ukmo-juan-castillo Jan 30, 2026
b6318ac
Merge remote-tracking branch 'refs/remotes/origin/main'
ukmo-juan-castillo Mar 6, 2026
df949dd
Version performing lbc mesh partitioning, but crashing because the
ukmo-juan-castillo Mar 9, 2026
65647bc
Changes to read also the lbc mesh in addition to the grid in which the
ukmo-juan-castillo Mar 10, 2026
d1e4cf8
Tested changes
ukmo-juan-castillo Mar 12, 2026
475c8a8
Simplify the number of namelist parameters needed to partition a lbc
ukmo-juan-castillo Mar 13, 2026
c91e413
Small changes to reduce the number of modifications in lfric_core
ukmo-juan-castillo Mar 16, 2026
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
3 changes: 2 additions & 1 deletion applications/lfric2lfric/source/driver/lfric2lfric_driver_mod.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module lfric2lfric_driver_mod
use lfric2lfric_config_mod, only: mode_ics, mode_lbc
use lfric2lfric_infrastructure_mod, only: initialise_infrastructure, &
context_dst, context_src, &
context_lbc, &
source_collection_name, &
target_collection_name
use lfric2lfric_regrid_mod, only: lfric2lfric_regrid
Expand Down Expand Up @@ -153,7 +154,7 @@ subroutine run( modeldb, oasis_clock )

is_running = modeldb%clock%tick()

call modeldb%io_contexts%get_io_context(context_dst, io_context)
call modeldb%io_contexts%get_io_context(context_lbc, io_context)
call io_context%set_current()
call advance(io_context, modeldb%clock)

Expand Down
38 changes: 29 additions & 9 deletions applications/lfric2lfric/source/initialisation/lfric2lfric_file_init_mod.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ module lfric2lfric_file_init_mod
implicit none

private
public :: init_lfric2lfric_src_files, init_lfric2lfric_dst_files
public :: init_lfric2lfric_src_files, init_lfric2lfric_dst_files, &
init_lfric2lfric_lbc_files

contains

Expand Down Expand Up @@ -151,14 +152,6 @@ subroutine init_lfric2lfric_dst_files( files_list, modeldb )
io_mode=FILE_MODE_WRITE, &
freq=checkpoint_frequency ) )
end if
else if (mode == mode_lbc) then
! Setup lbc writing context information
call files_list%insert_item( &
lfric_xios_file_type( "lfric2lfric_lbc", &
xios_id="lfric_lbc_write", &
io_mode=FILE_MODE_WRITE, &
operation=OPERATION_TIMESERIES, &
freq=diagnostic_frequency ) )
endif

! Setup orography ancillary file
Expand All @@ -176,4 +169,31 @@ subroutine init_lfric2lfric_dst_files( files_list, modeldb )

end subroutine init_lfric2lfric_dst_files

!> @brief Sets up lbc I/O configuration.
!> @details Initialises the file list for the lbc I/O context, using
!! the checkpoint_stem_name extracted from the `files` namelist.
!> @param [out] files_list The list of I/O files.
!> @param [in,out] modeldb Required by init_io.
subroutine init_lfric2lfric_lbc_files( files_list, modeldb )

implicit none

type(linked_list_type), intent(out) :: files_list
type(modeldb_type), optional, intent(inout) :: modeldb


if( use_xios_io ) then

! Setup lbc writing context information
call files_list%insert_item( &
lfric_xios_file_type( "lfric2lfric_lbc", &
xios_id="lfric_lbc_write", &
io_mode=FILE_MODE_WRITE, &
operation=OPERATION_TIMESERIES, &
freq=diagnostic_frequency ) )

endif

end subroutine init_lfric2lfric_lbc_files

end module lfric2lfric_file_init_mod
108 changes: 89 additions & 19 deletions applications/lfric2lfric/source/initialisation/lfric2lfric_infrastructure_mod.X90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ module lfric2lfric_infrastructure_mod

use add_mesh_map_mod, only: assign_mesh_maps
use blend_orography_alg_mod, only: blend_orography
use check_configuration_mod, only: get_required_stencil_depth
use constants_mod, only: str_def, r_def, i_def, l_def, r_second
use create_mesh_mod, only: create_extrusion, &
create_mesh
Expand All @@ -38,8 +37,6 @@ module lfric2lfric_infrastructure_mod
um_L120_99t_21s_40km_extrusion_type, &
um_L140_122t_18s_40km_extrusion_type, &
um_L70_50t_20s_80km_extrusion_type
use sci_geometric_constants_mod, only: get_chi_inventory, &
get_panel_id_inventory
use init_altitude_mod, only: init_altitude
use inventory_by_mesh_mod, only: inventory_by_mesh_type
use io_context_mod, only: callback_clock_arg
Expand All @@ -49,7 +46,8 @@ module lfric2lfric_infrastructure_mod
use log_mod, only: log_event, &
log_scratch_space, &
log_level_error, &
log_level_debug
log_level_debug, &
log_level_info
use mesh_mod, only: mesh_type
use mesh_collection_mod, only: mesh_collection
use model_clock_mod, only: model_clock_type
Expand All @@ -68,7 +66,8 @@ module lfric2lfric_infrastructure_mod
use lfric2lfric_init_mesh_mod, only: init_mesh
use lfric2lfric_check_conf_mod, only: lfric2lfric_check_configuration
use lfric2lfric_file_init_mod, only: init_lfric2lfric_dst_files, &
init_lfric2lfric_src_files
init_lfric2lfric_src_files, &
init_lfric2lfric_lbc_files
use lfric2lfric_init_mod, only: init_lfric2lfric
use lfric2lfric_init_coupler_mod,only: lfric2lfric_init_coupler_src, &
lfric2lfric_init_coupler_dst, &
Expand Down Expand Up @@ -109,6 +108,7 @@ module lfric2lfric_infrastructure_mod
! Source and destination XIOS context names
character(len=*), public, parameter :: context_dst = "lfric2lfric_destination"
character(len=*), public, parameter :: context_src = "lfric2lfric_source"
character(len=*), public, parameter :: context_lbc = "lfric2lfric_boundaries"

! Source and destination field collection names
character(len=*), public, parameter :: source_collection_name = "source_fields"
Expand Down Expand Up @@ -152,6 +152,8 @@ contains
type(mesh_type), pointer :: twod_mesh_src
type(mesh_type), pointer :: mesh_dst
type(mesh_type), pointer :: twod_mesh_dst
type(mesh_type), pointer :: mesh_lbc
type(mesh_type), pointer :: twod_mesh_lbc
type(mesh_type), pointer :: orography_twod_mesh
type(mesh_type), pointer :: orography_mesh

Expand All @@ -166,10 +168,10 @@ contains
type(namelist_type), pointer :: finite_element_nml

! Namelist parameters
character(len=str_def) :: mesh_names(2)
character(len=str_def), allocatable :: twod_names(:)
character(len=str_def) :: start_dump_filename
character(len=str_def) :: source_file_lbc
character(len=str_def), allocatable :: mesh_names(:)
character(len=str_def), allocatable :: twod_names(:)
character(len=str_def) :: start_dump_filename
character(len=str_def) :: source_file_lbc

! lfric2lfric namelist parameters
integer(kind=i_def) :: stencil_depth(1)
Expand All @@ -188,8 +190,9 @@ contains
integer(kind=i_def) :: i
integer(kind=i_def), parameter :: one_layer = 1_i_def

integer(kind=i_def), parameter :: dst = 1
integer(kind=i_def), parameter :: src = 2
integer(kind=i_def), parameter :: src = 1
integer(kind=i_def), parameter :: dst = 2
integer(kind=i_def), parameter :: lbc = 3

type(coupling_type), pointer :: coupling_ptr
type(field_collection_type), pointer :: cpl_snd_2d
Expand All @@ -208,8 +211,10 @@ contains

! Source context pointer and temporary context for setup
type(lfric_xios_context_type) :: tmp_io_context_src
type(lfric_xios_context_type) :: tmp_io_context_lbc
type(lfric_xios_context_type), pointer :: io_context_src
type(lfric_xios_context_type), pointer :: io_context_dst
type(lfric_xios_context_type), pointer :: io_context_lbc
type(linked_list_type), pointer :: file_list


Expand All @@ -230,10 +235,28 @@ contains
! Check lfric2lfric configuration settings are allowed
call lfric2lfric_check_configuration( lfric2lfric_nml )

call lfric2lfric_nml%get_value( 'mode', mode )
call lfric2lfric_nml%get_value( 'regrid_method', regrid_method )
call lfric2lfric_nml%get_value( 'destination_mesh_name', &
mesh_names(dst) )
call lfric2lfric_nml%get_value( 'mode', mode )

if (mode == mode_ics) then
allocate(mesh_names(2))
call lfric2lfric_nml%get_value( 'destination_mesh_name', &
mesh_names(dst) )
else if (mode == mode_lbc) then
allocate(mesh_names(3))
call lfric2lfric_nml%get_value( 'destination_mesh_name', &
mesh_names(lbc) )
! The name of the destination mesh is the name of the lbc mesh
! without the suffix '-lbc'
i = index(mesh_names(lbc), '-lbc', .true.)
if (i > 0) then
mesh_names(dst) = mesh_names(lbc)(:i-1)
else
mesh_names(dst) = mesh_names(lbc)
end if
call log_event('JMCS Mesh name: ' // mesh_names(dst), &
log_level_info)
end if
call lfric2lfric_nml%get_value( 'source_mesh_name', &
mesh_names(src) )
call lfric2lfric_nml%get_value( 'source_geometry', source_geometry )
Expand Down Expand Up @@ -349,6 +372,10 @@ contains
twod_mesh_src => mesh_collection%get_mesh(trim(twod_names(src)))
mesh_dst => mesh_collection%get_mesh(trim(mesh_names(dst)))
twod_mesh_dst => mesh_collection%get_mesh(trim(twod_names(dst)))
if (mode == mode_lbc) then
mesh_lbc => mesh_collection%get_mesh(trim(mesh_names(lbc)))
twod_mesh_lbc => mesh_collection%get_mesh(trim(twod_names(lbc)))
end if

! Log this change
call log_event('Source mesh set to: ' // mesh_names(src), &
Expand All @@ -359,6 +386,12 @@ contains
log_level_debug)
call log_event('Destination 2D mesh set to: ' // twod_names(dst), &
log_level_debug)
if (mode == mode_lbc) then
call log_event('LBC mesh set to: ' // mesh_names(lbc), &
log_level_debug)
call log_event('LBC 2D mesh set to: ' // twod_names(lbc), &
log_level_debug)
end if

!=======================================================================
! Setup I/O system
Expand Down Expand Up @@ -458,6 +491,37 @@ contains
call init_altitude( orography_twod_mesh, surface_altitude_src )
end if

if (mode == mode_lbc) then
!-----------------------------------------------------------------------
! Create the IO context for lbc files
!-----------------------------------------------------------------------
! Because the source lbc are not the same as the 'prime mesh', we have
! to initialise the lbc context manually with the desired mesh

! Add the lbc context to modeldb and return a pointer to it
call tmp_io_context_lbc%initialise(context_lbc)
call modeldb%io_contexts%add_context(tmp_io_context_lbc)
call modeldb%io_contexts%get_io_context(context_lbc, io_context_lbc)

! Get the file list of context and populate
file_list => io_context_lbc%get_filelist()
call init_lfric2lfric_lbc_files( file_list, modeldb )

! Get panel_id and chi from correct mesh
call chi_inventory%get_field_array(mesh_lbc, chi)
call panel_id_inventory%get_field(mesh_lbc, panel_id)

! Using correct chi and panel_id, initialise xios context for lbc mesh
nullify( before_close )
call io_context_lbc%initialise_xios_context( modeldb%mpi%get_comm(), &
chi, &
panel_id, &
modeldb%clock, &
modeldb%calendar, &
before_close )
call io_context_src%set_current()
end if

!=======================================================================
! Create and initialise prognostic fields
!=======================================================================
Expand All @@ -468,10 +532,10 @@ contains
target_collection_name, mesh_dst, twod_mesh_dst )
else if (mode == mode_lbc) then
call lfric2lfric_nml%get_value( 'source_file_lbc', source_file_lbc )
call init_lfric2lfric( modeldb, context_src, context_dst, &
call init_lfric2lfric( modeldb, context_src, context_lbc, &
source_file_lbc, mode, &
source_collection_name, mesh_src, twod_mesh_src, &
target_collection_name, mesh_dst, twod_mesh_dst )
target_collection_name, mesh_lbc, twod_mesh_lbc )
end if

!=======================================================================
Expand All @@ -493,9 +557,15 @@ contains
element_order_h, element_order_v, &
modeldb)
! Destination fields
call lfric2lfric_init_coupler_dst(twod_mesh_dst, "coupling_dst", &
element_order_h, element_order_v, &
modeldb)
if (mode == mode_ics) then
call lfric2lfric_init_coupler_dst(twod_mesh_dst, "coupling_dst", &
element_order_h, element_order_v, &
modeldb)
else if (mode == mode_lbc) then
call lfric2lfric_init_coupler_dst(twod_mesh_lbc, "coupling_dst", &
element_order_h, element_order_v, &
modeldb)
end if

! Finish coupling definition
call lfric2lfric_end_coupler_init(modeldb, "coupling")
Expand Down
Loading
Loading