ESMF_CompPrint Subroutine

public recursive subroutine ESMF_CompPrint(compp, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CompClass), pointer :: compp
integer, intent(out), optional :: rc

Calls

proc~~esmf_compprint~~CallsGraph proc~esmf_compprint ESMF_CompPrint proc~esmf_basegetstatus ESMF_BaseGetStatus proc~esmf_compprint->proc~esmf_basegetstatus proc~esmf_compclassgetinit ESMF_CompClassGetInit proc~esmf_compprint->proc~esmf_compclassgetinit proc~esmf_getname ESMF_GetName proc~esmf_compprint->proc~esmf_getname proc~esmf_imerr ESMF_IMErr proc~esmf_compprint->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_compprint->proc~esmf_logfounderror proc~esmf_basegetstatus->proc~esmf_logfounderror c_esmc_basegetstatus c_esmc_basegetstatus proc~esmf_basegetstatus->c_esmc_basegetstatus interface~c_esmc_getname c_ESMC_GetName proc~esmf_getname->interface~c_esmc_getname proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep 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_compprint~~CalledByGraph proc~esmf_compprint ESMF_CompPrint proc~esmf_cplcompprint ESMF_CplCompPrint proc~esmf_cplcompprint->proc~esmf_compprint proc~esmf_gridcompprint ESMF_GridCompPrint proc~esmf_gridcompprint->proc~esmf_compprint proc~esmf_scicompprint ESMF_SciCompPrint proc~esmf_scicompprint->proc~esmf_compprint proc~comprun compRun proc~comprun->proc~esmf_gridcompprint proc~f_esmf_cplcompprint f_esmf_cplcompprint proc~f_esmf_cplcompprint->proc~esmf_cplcompprint proc~f_esmf_gridcompprint f_esmf_gridcompprint proc~f_esmf_gridcompprint->proc~esmf_gridcompprint proc~f_esmf_scicompprint f_esmf_scicompprint proc~f_esmf_scicompprint->proc~esmf_scicompprint proc~my_cplregistrationinfortran my_CplRegistrationInFortran proc~my_cplregistrationinfortran->proc~esmf_cplcompprint proc~my_registrationinfortran my_RegistrationInFortran proc~my_registrationinfortran->proc~esmf_gridcompprint proc~myinitinfortran~2 myInitInFortran proc~myinitinfortran~2->proc~esmf_gridcompprint proc~user_init2 user_init2 proc~user_init2->proc~esmf_gridcompprint program~compcreate CompCreate program~compcreate->proc~esmf_gridcompprint program~esmf_componentutest ESMF_ComponentUTest program~esmf_componentutest->proc~esmf_gridcompprint

Source Code

  recursive subroutine ESMF_CompPrint(compp, rc)
!
!
! !ARGUMENTS:
    type(ESMF_CompClass), pointer               :: compp
    integer,              intent(out), optional :: rc 
!
! !DESCRIPTION:
!     Routine to print information about a component. \\
!
!     Note:  Many {\tt ESMF\_<class>Print} methods are implemented in C++.
!     On some platforms/compilers there is a potential issue with interleaving
!     Fortran and C++ output to {\tt stdout} such that it doesn't appear in
!     the expected order.  If this occurs, the {\tt ESMF\_IOUnitFlush()} method
!     may be used on unit 6 to get coherent output.  \\
!
!EOPI
!------------------------------------------------------------------------------
    integer                     :: localrc      ! local return code
    character(len=6)            :: defaultopts
    character(len=ESMF_MAXSTR)  :: cname
    type(ESMF_Status)           :: baseStatus

    ! Initialize return code; assume not implemented until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    defaultopts = "brief"

    if (.not.associated(compp)) then
      !nsc  call ESMF_LogWrite("Invalid or uninitialized Component",  &
      !nsc                      ESMF_LOGMSG_INFO)
      write (ESMF_UtilIOStdout,*)  "Invalid or uninitialized Component"
      return
    endif


    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_CompClassGetInit, compp, rc)

    call ESMF_BaseGetStatus(compp%base, baseStatus, rc=localrc)
    if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
        
    if (baseStatus /= ESMF_STATUS_READY) then
      !nsc  call ESMF_LogWrite("Invalid or uninitialized Component",  &
      !nsc                      ESMF_LOGMSG_INFO)
      write (ESMF_UtilIOStdout,*)  "Invalid or uninitialized Component"
      return
    endif

    call ESMF_GetName(compp%base, cname, rc=localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
       ESMF_CONTEXT, rcToReturn=rc)) return
       
    write (ESMF_UtilIOStdout,*) " Component name = ", trim(cname)
    
    ! TODO: add more info here

    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_CompPrint