Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
character(len=*), | intent(in), | optional | :: | name | ||
type(ESMF_GridComp), | intent(inout) | :: | gridComp | |||
integer, | intent(out), | optional | :: | rc |
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