ESMF_IOCreate Function

public function ESMF_IOCreate(name, gridComp, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in), optional :: name
type(ESMF_GridComp), intent(inout) :: gridComp
integer, intent(out), optional :: rc

Return Value type(ESMF_IO)


Calls

proc~~esmf_iocreate~~CallsGraph proc~esmf_iocreate ESMF_IOCreate c_esmc_io_xmlcreate c_esmc_io_xmlcreate proc~esmf_iocreate->c_esmc_io_xmlcreate proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_iocreate->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

Source Code

      function ESMF_IOCreate(name, gridComp, rc)
!
! !RETURN VALUE:
      type(ESMF_IO) :: ESMF_IOCreate
!
! !ARGUMENTS:
      character (len=*),       intent(in),  optional :: name
      type(ESMF_GridComp),     intent(inout)         :: gridComp
      integer,                 intent(out), optional :: rc
!   
! !DESCRIPTION:
!     Creates and sets the initial values in a new {\tt ESMF\_IO} object.    
!
!     The arguments are:
!     \begin{description}
!     \item[{[name]}]     
!          The name for the newly created io object.  If not specified, a
!          default unique name will be generated: "IONNN" where NNN
!          is a unique sequence number from 001 to 999.
!     \item[gridComp]
!           An {\tt ESMF\GridComp} object.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!     
!EOPI
! !REQUIREMENTS:
!     IOx.y, IOx.y.z  TODO
!
!     ! initialize name length to zero for non-existent name
      integer :: nameLen, localrc
!
!     ! Assume failure until success
      if (present(rc)) rc = ESMF_RC_NOT_IMPL
      localrc = ESMF_RC_NOT_IMPL
!
!     TODO:  init checks
!
      nameLen = 0
!
!     ! get length of given name for C++ validation
      if (present(name)) then
        nameLen = len_trim(name)
      end if
!
!     invoke C to C++ entry point to allocate and initialize new io
      call c_ESMC_IO_XMLCreate(ESMF_IOCreate, nameLen, name, 0, "", &
                               gridComp%compp%base, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
          ESMF_CONTEXT, rcToReturn=rc)) return
!
!     call ESMF_IOSetInitCreated(ESMF_IOCreate)  TODO
!
!     ! Return success
      if (present(rc)) rc = ESMF_SUCCESS
      end function ESMF_IOCreate