NUOPC_Compliance_Base Module


Uses


Variables

Type Visibility Attributes Name Initial
integer, public, save :: ccfDepth = 1
integer, public, save :: maxDepth = -2
logical, public, save :: complianceInit = .false.
logical, private, save :: includeState = .true.
logical, private, save :: includeVmStats = .true.
logical, public, save :: outputJSON = .false.
logical, public, save :: outputText = .true.
logical, public, save :: outputTrace = .false.

Interfaces

private interface JSON_GetID

  • private recursive subroutine JSON_GridCompGetID(comp, id, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp) :: comp
    character(len=*), intent(out) :: id
    integer, intent(out) :: rc

  • private recursive subroutine JSON_CplCompGetID(comp, id, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp) :: comp
    character(len=*), intent(out) :: id
    integer, intent(out) :: rc

  • private recursive subroutine JSON_StateGetID(state, id, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_State) :: state
    character(len=*), intent(out) :: id
    integer, intent(out) :: rc

  • private recursive subroutine JSON_FieldGetID(field, id, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Field) :: field
    character(len=*), intent(out) :: id
    integer, intent(out) :: rc

public interface JSON_LogCtrlFlow

  • private recursive subroutine JSON_GridCompLogCtrlFlow(event, comp, rc)

    Arguments

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

  • private recursive subroutine JSON_CplCompLogCtrlFlow(event, comp, rc)

    Arguments

    Type IntentOptional Attributes Name
    character(len=*), intent(in) :: event
    type(ESMF_CplComp), intent(in) :: comp
    integer, intent(out), optional :: rc

public interface NUOPC_CheckComponentAttribute

  • private recursive subroutine NUOPC_CheckGridComponentAttribute(prefix, comp, attributeName, convention, purpose, warnIfMissing, rc)

    Arguments

    Type IntentOptional Attributes Name
    character(len=*), intent(in) :: prefix
    type(ESMF_GridComp) :: comp
    character(len=*), intent(in) :: attributeName
    character(len=*), intent(in) :: convention
    character(len=*), intent(in) :: purpose
    logical, intent(in), optional :: warnIfMissing
    integer, intent(out), optional :: rc

  • private recursive subroutine NUOPC_CheckCplComponentAttribute(prefix, comp, attributeName, convention, purpose, rc)

    Arguments

    Type IntentOptional Attributes Name
    character(len=*), intent(in) :: prefix
    type(ESMF_CplComp) :: comp
    character(len=*), intent(in) :: attributeName
    character(len=*), intent(in) :: convention
    character(len=*), intent(in) :: purpose
    integer, intent(out), optional :: rc

public interface NUOPC_CheckComponentMetadata

  • private recursive subroutine NUOPC_CheckGridComponentMetadata(prefix, comp, rc)

    Arguments

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

  • private recursive subroutine NUOPC_CheckCplComponentMetadata(prefix, comp, rc)

    Arguments

    Type IntentOptional Attributes Name
    character(len=*), intent(in) :: prefix
    type(ESMF_CplComp) :: comp
    integer, intent(out), optional :: rc

public interface NUOPC_CompSearchPhaseMapByIndex

  • private subroutine NUOPC_GridCompSearchPhaseMapByIndex(comp, methodflag, phaseIndex, phaseLabel, attributeToCheck, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp) :: comp
    type(ESMF_Method_Flag), intent(in) :: methodflag
    integer, intent(in) :: phaseIndex
    character(len=*), intent(out) :: phaseLabel
    character(len=*), intent(in), optional :: attributeToCheck
    integer, intent(out), optional :: rc

  • private subroutine NUOPC_CplCompSearchPhaseMapByIndex(comp, methodflag, phaseIndex, phaseLabel, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp) :: comp
    type(ESMF_Method_Flag), intent(in) :: methodflag
    integer, intent(in) :: phaseIndex
    character(len=*), intent(out) :: phaseLabel
    integer, intent(out), optional :: rc

Subroutines

private recursive subroutine JSON_CplCompGetID(comp, id, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: comp
character(len=*), intent(out) :: id
integer, intent(out) :: rc

private recursive subroutine JSON_CplCompLogCtrlFlow(event, comp, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: event
type(ESMF_CplComp), intent(in) :: comp
integer, intent(out), optional :: rc

private recursive subroutine JSON_FieldGetID(field, id, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field) :: field
character(len=*), intent(out) :: id
integer, intent(out) :: rc

private recursive subroutine JSON_GridCompGetID(comp, id, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp) :: comp
character(len=*), intent(out) :: id
integer, intent(out) :: rc

private recursive subroutine JSON_GridCompLogCtrlFlow(event, comp, rc)

Arguments

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

public recursive subroutine JSON_LogHeader(rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(out), optional :: rc

public recursive subroutine JSON_LogWrite(msg, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: msg
integer, intent(out), optional :: rc

private recursive subroutine JSON_StateGetID(state, id, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_State) :: state
character(len=*), intent(out) :: id
integer, intent(out) :: rc

public recursive subroutine NUOPC_CheckClockUsageIncoming(prefix, clock, clockCopy, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_Clock), intent(in) :: clock
type(ESMF_Clock), intent(inout) :: clockCopy
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_CheckClockUsageOutgoing(prefix, clock, clockCopy, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_Clock), intent(in) :: clock
type(ESMF_Clock), intent(inout) :: clockCopy
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_CheckComponentMetadataCIM(prefix, comp, rc)

Arguments

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

public recursive subroutine NUOPC_CheckComponentStatistics(prefix, comp, rc)

Arguments

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

private recursive subroutine NUOPC_CheckCplComponentAttribute(prefix, comp, attributeName, convention, purpose, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_CplComp) :: comp
character(len=*), intent(in) :: attributeName
character(len=*), intent(in) :: convention
character(len=*), intent(in) :: purpose
integer, intent(out), optional :: rc

private recursive subroutine NUOPC_CheckCplComponentMetadata(prefix, comp, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_CplComp) :: comp
integer, intent(out), optional :: rc

private recursive subroutine NUOPC_CheckField(prefix, referenceName, field, stateid, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
character(len=*), intent(in) :: referenceName
type(ESMF_Field) :: field
character(len=64) :: stateid
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_CheckFieldAttribute(prefix, field, attributeName, convention, purpose, warnIfMissing, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_Field) :: field
character(len=*), intent(in) :: attributeName
character(len=*), intent(in) :: convention
character(len=*), intent(in) :: purpose
logical, intent(in), optional :: warnIfMissing
integer, intent(out), optional :: rc

private recursive subroutine NUOPC_CheckGridComponentAttribute(prefix, comp, attributeName, convention, purpose, warnIfMissing, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_GridComp) :: comp
character(len=*), intent(in) :: attributeName
character(len=*), intent(in) :: convention
character(len=*), intent(in) :: purpose
logical, intent(in), optional :: warnIfMissing
integer, intent(out), optional :: rc

private recursive subroutine NUOPC_CheckGridComponentMetadata(prefix, comp, rc)

Arguments

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

public recursive subroutine NUOPC_CheckInternalClock(prefix, comp, clock, mustMatchCurr, mustReachStop, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_GridComp) :: comp
type(ESMF_Clock), intent(in) :: clock
logical, intent(in) :: mustMatchCurr
logical, intent(in) :: mustReachStop
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_CheckState(prefix, referenceName, state, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
character(len=*), intent(in) :: referenceName
type(ESMF_State) :: state
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_CheckStateAttribute(prefix, state, attributeName, convention, purpose, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: prefix
type(ESMF_State) :: state
character(len=*), intent(in) :: attributeName
character(len=*), intent(in) :: convention
character(len=*), intent(in) :: purpose
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_ComplianceInit(rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_ComplianceLogWrite(msg, msgType, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: msg
type(ESMF_LogMsg_Flag), intent(in), optional :: msgType
integer, intent(out), optional :: rc

private subroutine NUOPC_CplCompSearchPhaseMapByIndex(comp, methodflag, phaseIndex, phaseLabel, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
integer, intent(in) :: phaseIndex
character(len=*), intent(out) :: phaseLabel
integer, intent(out), optional :: rc

private subroutine NUOPC_GridCompSearchPhaseMapByIndex(comp, methodflag, phaseIndex, phaseLabel, attributeToCheck, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
integer, intent(in) :: phaseIndex
character(len=*), intent(out) :: phaseLabel
character(len=*), intent(in), optional :: attributeToCheck
integer, intent(out), optional :: rc

public recursive subroutine NUOPC_RegionEnter(name, rc)

Arguments

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

public recursive subroutine NUOPC_RegionExit(name, rc)

Arguments

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