NUOPC_FieldDictionaryApi Module

Uses

Variables

Type	Visibility	Attributes		Name		Initial
logical,	public,	save	::	NUOPC_FieldDictionaryAutoAdd	=	.false.
logical,	public,	save	::	NUOPC_FieldDictionaryIsSetup	=	.false.
type(ESMF_Container),	public,	save	::	NUOPC_FieldDictionary

Interfaces

public interface NUOPC_FieldDictionarySetup

private subroutine NUOPC_FieldDictionarySetupDefault(rc)

Arguments

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

private subroutine NUOPC_FieldDictionarySetupFile(fileName, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	fileName
integer,	intent(out),	optional		::	rc

Functions

public function NUOPC_FieldDictionaryHasEntry(standardName, rc)

Arguments

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

Return Value logical

public function NUOPC_FieldDictionaryMatchSyno(standardName1, standardName2, rc)

Arguments

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

Return Value logical

Subroutines

public subroutine NUOPC_FieldDictionaryAddEntry(standardName, canonicalUnits, rc)

Arguments

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

public subroutine NUOPC_FieldDictionaryEgest(freeFormat, iofmt, rc)

Arguments

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

public subroutine NUOPC_FieldDictionaryGetEntry(standardName, canonicalUnits, rc)

Arguments

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

public subroutine NUOPC_FieldDictionaryIngest(freeFormat, rc)

Arguments

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

private subroutine NUOPC_FieldDictionaryRemove(rc)

Arguments

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

public subroutine NUOPC_FieldDictionarySetAutoAdd(setting, rc)

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	setting
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_FieldDictionarySetSyno(standardNames, rc)

Arguments

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

private subroutine NUOPC_FieldDictionarySetupDefault(rc)

Arguments

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

private subroutine NUOPC_FieldDictionarySetupEmpty(rc)

Arguments

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

private subroutine NUOPC_FieldDictionarySetupFile(fileName, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	fileName
integer,	intent(out),	optional		::	rc