NUOPC_FieldDictionaryDef Module

Uses

- ESMF
- NUOPC_FreeFormatDef

Derived Types

type, public :: NUOPC_FieldDictionaryEntry

Components

Type	Visibility	Attributes		Name		Initial
type(NUOPC_FieldDictionaryEntryS),	public,	pointer	::	wrap

type, public :: NUOPC_FieldDictionaryEntryS

Components

Type	Visibility	Attributes		Name		Initial
character(len=ESMF_MAXSTR),	public		::	canonicalUnits
character(len=ESMF_MAXSTR),	public,	pointer	::	connectedOptions(:)
character(len=ESMF_MAXSTR),	public		::	standardName
character(len=ESMF_MAXSTR),	public,	pointer	::	synonyms(:)

Functions

public function NUOPC_FieldDictionaryHasEntryI(fieldDictionary, standardName, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
character(len=*),	intent(in)			::	standardName
integer,	intent(out),	optional		::	rc

Return Value logical

public function NUOPC_FieldDictionaryMatchSynoI(fieldDictionary, standardName1, standardName2, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
character(len=*),	intent(in)			::	standardName1
character(len=*),	intent(in)			::	standardName2
integer,	intent(out),	optional		::	rc

Return Value logical

Subroutines

public subroutine NUOPC_FieldDictionaryAddEntryI(fieldDictionary, standardName, canonicalUnits, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
character(len=*),	intent(in)			::	standardName
character(len=*),	intent(in)			::	canonicalUnits
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionaryCreateI(fieldDictionary, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(out)			::	fieldDictionary
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionaryDefinition(fieldDictionary, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionaryDestroyI(fieldDictionary, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_FieldDictionaryEgestDefaultI(fieldDictionary, freeFormat, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
type(NUOPC_FreeFormat),	intent(out)			::	freeFormat
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionaryEgestI(fieldDictionary, freeFormat, iofmt, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
type(NUOPC_FreeFormat),	intent(out)			::	freeFormat
type(ESMF_IOFmt_Flag),	intent(in),	optional		::	iofmt
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_FieldDictionaryEgestYAMLI(fieldDictionary, freeFormat, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
type(NUOPC_FreeFormat),	intent(out)			::	freeFormat
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionaryGetEntryI(fieldDictionary, standardName, canonicalUnits, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
character(len=*),	intent(in)			::	standardName
character(len=*),	intent(out),	optional		::	canonicalUnits
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionaryIngestI(fieldDictionary, freeFormat, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
type(NUOPC_FreeFormat),	intent(in)			::	freeFormat
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionarySetSynoI(fieldDictionary, standardNames, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Container),	intent(inout)			::	fieldDictionary
character(len=*),	intent(in)			::	standardNames(:)
integer,	intent(out),	optional		::	rc