Skip to content

Enable custom stream updates in mpas_init via callback config #1374

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
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Enable custom stream updates in mpas_init via callback config #1374

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7edb08e
Add optional callback-based stream update configuration to mpas_init.
Nov 6, 2025
416d7c1
Updated stream callback type implementation to use an abstract class.…
Nov 12, 2025
e8cabb7
Removed update type bound method in stream_update_callback_type.
Nov 12, 2025
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
55 changes: 52 additions & 3 deletions src/driver/mpas_subdriver.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,52 @@ module mpas_subdriver
use test_core_interface
#endif


!***********************************************************************
!
! type stream_update_callback_type
!
!> \brief Abstract base class for stream update callbacks.
!> \author Andy Stokely
!> \date 11/11/2025
!> \details
!> Users extend this type to define custom behavior for updating
!> MPAS stream configurations. The deferred procedure "apply" is
!> implemented by the child derived type.
!
!-----------------------------------------------------------------------
type, abstract :: stream_update_callback_type
contains
procedure(stream_update_callback), deferred :: apply
end type stream_update_callback_type

!***********************************************************************
!
! interface stream_update_callback
!
!> \brief Interface for the deferred callback procedure.
!> \author Andy Stokely
!> \date 11/11/2025
!> \details
!> Implementations of this routine modify stream metadata within
!> the MPAS_streamManager_type. Errors should be signaled by setting
!> ierr to a non-zero value when present.
!
!-----------------------------------------------------------------------
abstract interface
subroutine stream_update_callback(self, manager, ierr)
import :: MPAS_streamManager_type
import :: stream_update_callback_type

implicit none
class(stream_update_callback_type), intent(inout) :: self
type(MPAS_streamManager_type), intent(inout) :: manager
integer, optional, intent(out) :: ierr
end subroutine stream_update_callback
end interface

contains

subroutine mpas_init(corelist, domain_ptr, external_comm, namelistFileParam, streamsFileParam)
subroutine mpas_init(corelist, domain_ptr, external_comm, namelistFileParam, streamsFileParam, streamUpdateCallback)

#ifdef MPAS_USE_MPI_F08
use mpi_f08, only : MPI_Comm
Expand All @@ -51,6 +92,7 @@ subroutine mpas_init(corelist, domain_ptr, external_comm, namelistFileParam, str
use mpas_bootstrapping, only : mpas_bootstrap_framework_phase1, mpas_bootstrap_framework_phase2
use mpas_log
use mpas_stream_inquiry, only : MPAS_stream_inquiry_new_streaminfo
use mpas_callback, only : stream_update_callback_type

implicit none

Expand All @@ -63,6 +105,7 @@ subroutine mpas_init(corelist, domain_ptr, external_comm, namelistFileParam, str
#endif
character(len=*), intent(in), optional :: namelistFileParam
character(len=*), intent(in), optional :: streamsFileParam
class(stream_update_callback_type), intent(inout), optional :: streamUpdateCallback

integer :: iArg, nArgs
logical :: readNamelistArg, readStreamsArg
Expand Down Expand Up @@ -374,7 +417,13 @@ end subroutine xml_stream_get_attributes
call mpas_log_write('xml stream parser failed: '//trim(domain_ptr % streams_filename), messageType=MPAS_LOG_CRIT)
end if

!
if ( present(streamUpdateCallback) ) then
call streamUpdateCallback%update(domain_ptr % streamManager, ierr)
if ( ierr /= 0 ) then
call mpas_log_write('Stream update callback failed for core '//trim(domain_ptr % core % coreName), messageType=MPAS_LOG_CRIT)
end if
end if

! Validate streams after set-up
!
call mpas_log_write(' ** Validating streams')
Expand Down