ESMF_IO_YAMLRead Subroutine

public subroutine ESMF_IO_YAMLRead(yaml, fileName, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_IO_YAML) :: yaml
character(len=*), intent(in) :: fileName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Calls

proc~~esmf_io_yamlread~~CallsGraph proc~esmf_io_yamlread ESMF_IO_YAMLRead c_esmc_io_yamlread c_esmc_io_yamlread proc~esmf_io_yamlread->c_esmc_io_yamlread proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_io_yamlread->proc~esmf_logfounderror esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

proc~~esmf_io_yamlread~~CalledByGraph proc~esmf_io_yamlread ESMF_IO_YAMLRead proc~nuopc_freeformatcreatefdyaml NUOPC_FreeFormatCreateFDYAML proc~nuopc_freeformatcreatefdyaml->proc~esmf_io_yamlread program~esmf_io_yamlutest ESMF_IO_YAMLUTest program~esmf_io_yamlutest->proc~esmf_io_yamlread proc~nuopc_fielddictionarysetupfile NUOPC_FieldDictionarySetupFile proc~nuopc_fielddictionarysetupfile->proc~nuopc_freeformatcreatefdyaml interface~nuopc_fielddictionarysetup NUOPC_FieldDictionarySetup interface~nuopc_fielddictionarysetup->proc~nuopc_fielddictionarysetupfile proc~nuopc_fielddictionaryaddentry NUOPC_FieldDictionaryAddEntry proc~nuopc_fielddictionaryaddentry->interface~nuopc_fielddictionarysetup proc~nuopc_fielddictionaryegest NUOPC_FieldDictionaryEgest proc~nuopc_fielddictionaryegest->interface~nuopc_fielddictionarysetup proc~nuopc_fielddictionarygetentry NUOPC_FieldDictionaryGetEntry proc~nuopc_fielddictionarygetentry->interface~nuopc_fielddictionarysetup proc~nuopc_fielddictionaryhasentry NUOPC_FieldDictionaryHasEntry proc~nuopc_fielddictionaryhasentry->interface~nuopc_fielddictionarysetup proc~nuopc_fielddictionarymatchsyno NUOPC_FieldDictionaryMatchSyno proc~nuopc_fielddictionarymatchsyno->interface~nuopc_fielddictionarysetup proc~nuopc_fielddictionarysetsyno NUOPC_FieldDictionarySetSyno proc~nuopc_fielddictionarysetsyno->interface~nuopc_fielddictionarysetup proc~nuopc_initattributesfield NUOPC_InitAttributesField proc~nuopc_initattributesfield->interface~nuopc_fielddictionarysetup program~esmf_nuopc_utest ESMF_NUOPC_UTest program~esmf_nuopc_utest->interface~nuopc_fielddictionarysetup program~esmx_app ESMX_App program~esmx_app->interface~nuopc_fielddictionarysetup

Source Code

  subroutine ESMF_IO_YAMLRead(yaml, fileName, keywordEnforcer, rc)
!
! !ARGUMENTS:
    type(ESMF_IO_YAML)                             :: yaml
    character(len=*),        intent(in)            :: fileName
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,                 intent(out), optional :: rc

! !DESCRIPTION:
!     Load YAML content into {\tt ESMF\_YAML\_IO} object from file.
!
!     The arguments are:
!     \begin{description}
!     \item[{yaml}]
!          Existing {\tt ESMF\_IO_YAML} object.
!     \item[{fileName}]
!          Name of YAML file to read content from.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!     
!EOPI

    ! local return code
    integer :: localrc
!
!   ! Assume failure until success
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
!
!   invoke C to C++ entry point
    call c_ESMC_IO_YAMLRead(yaml, fileName, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, rcToReturn=rc)) return

    ! Return success
    if (present(rc)) rc = localrc

  end subroutine ESMF_IO_YAMLRead