mct_coupler.h

Go to the documentation of this file.

#include "cppdefs.h"
      MODULE mct_coupler_mod
 
#if defined MODEL_COUPLING && defined MCT_LIB
!
!git $Id$
!==================================================== John C. Warner ===
!  Copyright (c) 2002-2025 The ROMS Group           Hernan G. Arango   !
!    Licensed under a MIT/X style license                              !
!    See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  This module is used to communicate and exchange data between        !
!  ROMS and other coupled model(s)  via the Model Coupling             !
!  Toolkit (MCT), developed at the Argonne National Laboratory.        !
!                                                                      !
!=======================================================================
!
!  Component Model Registry.
!
      USE m_mctworld, ONLY : mctworld_init => init
      USE m_mctworld, ONLY : mctworld_clean => clean
!
!  Domain Decomposition Descriptor DataType and associated methods.
!
      USE m_globalsegmap, ONLY : globalsegmap
      USE m_globalsegmap, ONLY : globalsegmap_init => init
      USE m_globalsegmap, ONLY : globalsegmap_lsize => lsize
      USE m_globalsegmap, ONLY : globalsegmap_clean => clean
      USE m_globalsegmap, ONLY : globalsegmap_ordpnts => orderedpoints
!
!  Field Storage DataType and associated methods.
!
      USE m_attrvect, ONLY : attrvect
      USE m_attrvect, ONLY : attrvect_init => init
      USE m_attrvect, ONLY : attrvect_zero => zero
      USE m_attrvect, ONLY : attrvect_lsize => lsize
      USE m_attrvect, ONLY : attrvect_clean => clean
      USE m_attrvect, ONLY : attrvect_importrattr => importrattr
      USE m_attrvect, ONLY : attrvect_exportrattr => exportrattr
!
!  Intercomponent communications scheduler.
!
      USE m_router, ONLY : router
      USE m_router, ONLY : router_init => init
      USE m_router, ONLY : router_clean => clean
!
!  Intercomponent transfer.
!
      USE m_transfer, ONLY: mct_send => send
      USE m_transfer, ONLY: mct_recv => recv
!
!  Sparse Matrix DataType and associated methods.
!
      USE m_sparsematrix, ONLY : sparsematrix
      USE m_sparsematrix, ONLY : sparsematrix_init => init
      USE m_sparsematrix, ONLY : sparsematrix_importgrowind =>          &
     &                           importglobalrowindices
      USE m_sparsematrix, ONLY : sparsematrix_importgcolind =>          &
     &                           importglobalcolumnindices
      USE m_sparsematrix, ONLY : sparsematrix_importmatrixelts =>       &
     &                           importmatrixelements
      USE m_sparsematrixplus, ONLY : sparsematrixplus
      USE m_sparsematrixplus, ONLY : sparsematrixplus_init => init
      USE m_sparsematrixplus, ONLY : sparsematrixplus_clean => clean
!
!  Decompose matrix by row.
!
      USE m_sparsematrixplus, ONLY : xonly
!
!  Matrix-Vector multiply methods.
!
      USE m_matattrvectmul, ONLY : mct_matvecmul => smatavmult
!
      implicit none
!
      PRIVATE
 
# ifdef SWAN_COUPLING
      PUBLIC :: initialize_ocn2wav_coupling
      PUBLIC :: ocn2wav_coupling
      PUBLIC :: finalize_ocn2wav_coupling
# endif
# ifdef WRF_COUPLING
      PUBLIC :: initialize_ocn2atm_coupling
      PUBLIC :: ocn2atm_coupling
      PUBLIC :: finalize_ocn2atm_coupling
# endif
!
!  Declarations.
!
# ifdef SWAN_COUPLING
      TYPE(attrvect) :: wav2ocn_av            ! AttrVect variables
      TYPE(attrvect) :: ocn2wav_av
      TYPE(router)   :: romstoswan            ! Router variables
# endif
# ifdef WRF_COUPLING
      TYPE(attrvect) :: atm2ocn_av            ! AttrVect variables
      TYPE(attrvect) :: ocn2atm_av
      TYPE(router)   :: romstowrf             ! Router variables
# endif
      TYPE(globalsegmap) :: gsmaproms         ! GloabalSegMap variables
 
      CONTAINS
/*
************************************************************************
*  include model specific communication routines.
************************************************************************
*/
 
# ifdef SWAN_COUPLING
#  include "mct_roms_swan.h"
# endif
# ifdef REFDIF_COUPLING
#  include "mct_roms_refdif.h"
# endif
# ifdef WRF_COUPLING
#  include "mct_roms_wrf.h"
# endif
 
#endif
      END MODULE mct_coupler_mod