ESMF_FieldSet Subroutine

public subroutine ESMF_FieldSet(field, keywordEnforcer, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(inout) :: field
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Calls

proc~~esmf_fieldset~~CallsGraph proc~esmf_fieldset ESMF_FieldSet proc~esmf_fieldgetinit ESMF_FieldGetInit proc~esmf_fieldset->proc~esmf_fieldgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_fieldset->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_fieldset->proc~esmf_logfounderror proc~esmf_setname ESMF_SetName proc~esmf_fieldset->proc~esmf_setname 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_setname c_esmc_setname proc~esmf_setname->c_esmc_setname proc~esmf_basecreate ESMF_BaseCreate proc~esmf_setname->proc~esmf_basecreate proc~esmf_basecreate->proc~esmf_logfounderror c_esmc_basecreate c_esmc_basecreate proc~esmf_basecreate->c_esmc_basecreate 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_fieldset~~CalledByGraph proc~esmf_fieldset ESMF_FieldSet proc~nuopc_advertisefield NUOPC_AdvertiseField proc~nuopc_advertisefield->proc~esmf_fieldset proc~testfieldnamedalias TestFieldNamedAlias proc~testfieldnamedalias->proc~esmf_fieldset program~esmf_fieldutest ESMF_FieldUTest program~esmf_fieldutest->proc~esmf_fieldset interface~nuopc_advertise NUOPC_Advertise interface~nuopc_advertise->proc~nuopc_advertisefield proc~nuopc_advertisefields NUOPC_AdvertiseFields interface~nuopc_advertise->proc~nuopc_advertisefields proc~nuopc_advertisefields->proc~nuopc_advertisefield program~esmf_namedaliasutest ESMF_NamedAliasUTest program~esmf_namedaliasutest->proc~testfieldnamedalias proc~advertise Advertise proc~advertise->interface~nuopc_advertise proc~advertise~2 Advertise proc~advertise~2->interface~nuopc_advertise proc~f_nuopc_advertise f_nuopc_advertise proc~f_nuopc_advertise->interface~nuopc_advertise proc~initializeipdv05p1 InitializeIPDv05p1 proc~initializeipdv05p1->interface~nuopc_advertise program~esmf_nuopc_utest ESMF_NUOPC_UTest program~esmf_nuopc_utest->interface~nuopc_advertise

Source Code

  subroutine ESMF_FieldSet(field, keywordEnforcer, name, rc)

!
! !ARGUMENTS:
    type(ESMF_Field),   intent(inout)         :: field
    type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    character(len = *), intent(in),  optional :: name
    integer,            intent(out), optional :: rc
!
! !DESCRIPTION:
!     Sets adjustable settings in an {\tt ESMF\_Field} object. 
!
!     The arguments are:
!     \begin{description}
!     \item [field]
!       {\tt ESMF\_Field} object for which to set properties.
!     \item [{[name]}]
!       The Field name.
!     \item [{[rc]}]
!       Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    
    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_FieldGetInit, field, rc)
    
    ! Set the name in Base object
    if (present(name)) then
      if (field%isNamedAlias) then
        field%name = trim(name)
      else
        call ESMF_SetName(field%ftypep%base, name=name, rc=localrc)
        if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
          ESMF_CONTEXT, rcToReturn=rc)) return
      endif
    endif

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

  end subroutine ESMF_FieldSet