esmf_atm_void.h

Go to the documentation of this file.

      MODULE esmf_atm_mod
 
#if !(defined COAMPS_COUPLING || defined REGCM_COUPLING || \
      defined wrf_coupling)   && defined esmf_lib
!
!git $Id$
!=======================================================================
!  Copyright (c) 2002-2025 The ROMS Group                              !
!    Licensed under a MIT/X style license         Hernan G. Arango     !
!    See License_ROMS.md                          Ufuk Utku Turuncoglu !
!=======================================================================
!                                                                      !
!  This module sets a void atmospheric model gridded component using   !
!  generic ESMF/NUOPC layer:                                           !
!                                                                      !
!    ATM_SetServices         Sets ATM component shared-object entry    !
!                            points using NUPOC generic methods for    !
!                            "initialize", "run", and "finalize".      !
!                            This routine is empty because it is       !
!                            used for testing purposes.                !
!                                                                      !
!  ESMF:   Earth System Modeling Framework (Version 7 or higher)       !
!            https://www.earthsystemcog.org/projects/esmf              !
!                                                                      !
!  NUOPC:  National Unified Operational Prediction Capability          !
!            https://www.earthsystemcog.org/projects/nuopc             !
!                                                                      !
!=======================================================================
!
      USE esmf
      USE nuopc
      USE nuopc_model,                                                  &
     &    nuopc_setservices          => setservices,                    &
     &    nuopc_label_advance        => label_advance,                  &
     &    nuopc_label_datainitialize => label_datainitialize
!
      USE mod_esmf_esm          ! ESM coupling structures and variables
!
      implicit none
!
      PUBLIC  :: atm_setservices
!
      CONTAINS
!
      SUBROUTINE atm_setservices (model, rc)
!
!=======================================================================
!                                                                      !
!  Sets ATM a void atmosphere model component shared-object entry      !
!  points for "initialize", "run", and "finalize" by using NUOPC       !
!  generic methods.                                                    !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      integer, intent(out) :: rc
!
      TYPE (esmf_gridcomp) :: model
!
!  Local variable declarations.
!
      character (len=*), parameter :: myfile =                          &
     &  __FILE__//", ATM_SetServices"
!
!-----------------------------------------------------------------------
!  Initialize return code flag to success state (no error).
!-----------------------------------------------------------------------
!
      rc=esmf_success
!
!-----------------------------------------------------------------------
!  Register NUOPC generic routines.  It is empty to for testing
!-----------------------------------------------------------------------
!
      RETURN
      END SUBROUTINE atm_setservices
!
#endif
      END MODULE esmf_atm_mod