NUOPC_Base Module

Uses

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Variables

Type	Visibility	Attributes		Name		Initial
integer,	public,	parameter	::	NUOPC_PhaseMapStringLength	=	400

Interfaces

public interface NUOPC_Advertise

private subroutine NUOPC_AdvertiseField(state, StandardName, Units, LongName, ShortName, name, TransferOfferGeomObject, SharePolicyField, SharePolicyGeomObject, vm, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
character(len=*),	intent(in)			::	StandardName
character(len=*),	intent(in),	optional		::	Units
character(len=*),	intent(in),	optional		::	LongName
character(len=*),	intent(in),	optional		::	ShortName
character(len=*),	intent(in),	optional		::	name
character(len=*),	intent(in),	optional		::	TransferOfferGeomObject
character(len=*),	intent(in),	optional		::	SharePolicyField
character(len=*),	intent(in),	optional		::	SharePolicyGeomObject
type(ESMF_VM),	intent(in),	optional		::	vm
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_AdvertiseFields(state, StandardNames, TransferOfferGeomObject, SharePolicyField, SharePolicyGeomObject, vm, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
character(len=*),	intent(in)			::	StandardNames(:)
character(len=*),	intent(in),	optional		::	TransferOfferGeomObject
character(len=*),	intent(in),	optional		::	SharePolicyField
character(len=*),	intent(in),	optional		::	SharePolicyGeomObject
type(ESMF_VM),	intent(in),	optional		::	vm
integer,	intent(out),	optional		::	rc

public interface NUOPC_GetAttribute

private subroutine NUOPC_GetAttributeFieldVal(field, name, value, isPresent, isSet, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(in)			::	field
character(len=*),	intent(in)			::	name
character(len=*),	intent(out)			::	value
logical,	intent(out),	optional		::	isPresent
logical,	intent(out),	optional		::	isSet
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_GetAttributeFieldTK(field, name, isPresent, isSet, itemCount, typekind, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(in)			::	field
character(len=*),	intent(in)			::	name
logical,	intent(out),	optional		::	isPresent
logical,	intent(out),	optional		::	isSet
integer,	intent(out),	optional		::	itemCount
type(ESMF_TypeKind_Flag),	intent(out),	optional		::	typekind
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_GetAttributeState(state, name, value, isPresent, isSet, itemCount, typekind, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=*),	intent(in)			::	name
character(len=*),	intent(out),	optional		::	value
logical,	intent(out),	optional		::	isPresent
logical,	intent(out),	optional		::	isSet
integer,	intent(out),	optional		::	itemCount
type(ESMF_TypeKind_Flag),	intent(out),	optional		::	typekind
integer,	intent(out),	optional		::	rc

public interface NUOPC_IngestPetList

private subroutine NUOPC_IngestPetListFF(petList, freeFormat, rc)

Arguments

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

private subroutine NUOPC_IngestPetListHC(petList, hconfig, rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(out),		allocatable	::	petList(:)
type(ESMF_HConfig),	intent(in)			::	hconfig
integer,	intent(out),	optional		::	rc

public interface NUOPC_InitAttributes

private subroutine NUOPC_InitAttributesField(field, StandardName, Units, LongName, ShortName, Connected, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field)				::	field
character(len=*),	intent(in)			::	StandardName
character(len=*),	intent(in),	optional		::	Units
character(len=*),	intent(in),	optional		::	LongName
character(len=*),	intent(in),	optional		::	ShortName
character(len=*),	intent(in),	optional		::	Connected
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_InitAttributesState(state, rc)

Arguments

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

public interface NUOPC_IsAtTime

private function NUOPC_IsAtTimeField(field, time, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(in)			::	field
type(ESMF_Time),	intent(in)			::	time
integer,	intent(out),	optional		::	rc

Return Value logical

private function NUOPC_IsAtTimeState(state, time, fieldName, count, fieldList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
type(ESMF_Time),	intent(in)			::	time
character(len=*),	intent(in),	optional		::	fieldName
integer,	intent(out),	optional		::	count
type(ESMF_Field),	intent(out),	optional,	allocatable	::	fieldList(:)
integer,	intent(out),	optional		::	rc

Return Value logical

public interface NUOPC_IsConnected

private function NUOPC_IsConnectedField(field, rc)

Arguments

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

Return Value logical

private function NUOPC_IsConnectedState(state, fieldName, count, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=*),	intent(in),	optional		::	fieldName
integer,	intent(out),	optional		::	count
integer,	intent(out),	optional		::	rc

Return Value logical

public interface NUOPC_IsUpdated

private function NUOPC_IsUpdatedField(field, rc)

Arguments

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

Return Value logical

private function NUOPC_IsUpdatedState(state, fieldName, count, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=*),	intent(in),	optional		::	fieldName
integer,	intent(out),	optional		::	count
integer,	intent(out),	optional		::	rc

Return Value logical

public interface NUOPC_Realize

private subroutine NUOPC_RealizeCompleteG(state, grid, fieldName, typekind, staggerloc, selection, dataFillScheme, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
type(ESMF_Grid),	intent(in)			::	grid
character(len=*),	intent(in),	optional		::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
type(ESMF_StaggerLoc),	intent(in),	optional		::	staggerloc
character(len=*),	intent(in),	optional		::	selection
character(len=*),	intent(in),	optional		::	dataFillScheme
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeCompleteLS(state, locstream, fieldName, typekind, selection, dataFillScheme, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
type(ESMF_LocStream),	intent(in)			::	locstream
character(len=*),	intent(in),	optional		::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
character(len=*),	intent(in),	optional		::	selection
character(len=*),	intent(in),	optional		::	dataFillScheme
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeCompleteM(state, mesh, fieldName, typekind, meshloc, selection, dataFillScheme, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
type(ESMF_Mesh),	intent(in)			::	mesh
character(len=*),	intent(in),	optional		::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
type(ESMF_MeshLoc),	intent(in),	optional		::	meshloc
character(len=*),	intent(in),	optional		::	selection
character(len=*),	intent(in),	optional		::	dataFillScheme
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeField(state, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
type(ESMF_Field),	intent(in)			::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeTransfer(state, fieldName, typekind, gridToFieldMap, ungriddedLBound, ungriddedUBound, totalLWidth, totalUWidth, realizeOnlyConnected, removeNotConnected, realizeOnlyNotShared, realizeOnlyNotComplete, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
character(len=*),	intent(in)			::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
integer,	intent(in),	optional,	target	::	gridToFieldMap(:)
integer,	intent(in),	optional,	target	::	ungriddedLBound(:)
integer,	intent(in),	optional,	target	::	ungriddedUBound(:)
integer,	intent(in),	optional		::	totalLWidth(:)
integer,	intent(in),	optional		::	totalUWidth(:)
logical,	intent(in),	optional		::	realizeOnlyConnected
logical,	intent(in),	optional		::	removeNotConnected
logical,	intent(in),	optional		::	realizeOnlyNotShared
logical,	intent(in),	optional		::	realizeOnlyNotComplete
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

public interface NUOPC_SetAttribute

private subroutine NUOPC_SetAttributeField(field, name, value, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field)				::	field
character(len=*),	intent(in)			::	name
character(len=*),	intent(in)			::	value
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetAttributeState(state, name, value, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
character(len=*),	intent(in)			::	name
character(len=*),	intent(in)			::	value
integer,	intent(out),	optional		::	rc

public interface NUOPC_SetTimestamp

private subroutine NUOPC_SetTimestampField(field, time, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(inout)			::	field
type(ESMF_Time),	intent(in)			::	time
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampFieldList(fieldList, time, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(inout)			::	fieldList(:)
type(ESMF_Time),	intent(in)			::	time
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampFieldListClk(fieldList, clock, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(inout)			::	fieldList(:)
type(ESMF_Clock),	intent(in)			::	clock
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampState(state, time, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
type(ESMF_Time),	intent(in)			::	time
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampStateClk(state, clock, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
type(ESMF_Clock),	intent(in)			::	clock
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

public interface NUOPC_UpdateTimestamp

private subroutine NUOPC_UpdateFieldList(fieldList, rootPet, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),			pointer	::	fieldList(:)
integer,	intent(in)			::	rootPet
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_UpdateAcrossFieldLists(srcFieldList, dstFieldList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),			pointer	::	srcFieldList(:)
type(ESMF_Field),			pointer	::	dstFieldList(:)
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_FieldBundleUpdateTime(srcFields, dstFields, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_FieldBundle),	intent(in)			::	srcFields
type(ESMF_FieldBundle),	intent(inout)			::	dstFields
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_StateUpdateTimestamp(state, rootPet, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
integer,	intent(in)			::	rootPet
integer,	intent(out),	optional		::	rc

Functions

private function NUOPC_IsAtTimeField(field, time, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(in)			::	field
type(ESMF_Time),	intent(in)			::	time
integer,	intent(out),	optional		::	rc

Return Value logical

private function NUOPC_IsAtTimeState(state, time, fieldName, count, fieldList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
type(ESMF_Time),	intent(in)			::	time
character(len=*),	intent(in),	optional		::	fieldName
integer,	intent(out),	optional		::	count
type(ESMF_Field),	intent(out),	optional,	allocatable	::	fieldList(:)
integer,	intent(out),	optional		::	rc

Return Value logical

private function NUOPC_IsConnectedField(field, rc)

Arguments

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

Return Value logical

private function NUOPC_IsConnectedState(state, fieldName, count, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=*),	intent(in),	optional		::	fieldName
integer,	intent(out),	optional		::	count
integer,	intent(out),	optional		::	rc

Return Value logical

private function NUOPC_IsUpdatedField(field, rc)

Arguments

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

Return Value logical

private function NUOPC_IsUpdatedState(state, fieldName, count, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=*),	intent(in),	optional		::	fieldName
integer,	intent(out),	optional		::	count
integer,	intent(out),	optional		::	rc

Return Value logical

Subroutines

public subroutine NUOPC_AddNamespace(state, Namespace, nestedStateName, nestedState, vm, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
character(len=*),	intent(in)			::	Namespace
character(len=*),	intent(in),	optional		::	nestedStateName
type(ESMF_State),	intent(out),	optional		::	nestedState
type(ESMF_VM),	intent(in),	optional		::	vm
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_AddNestedState(state, Namespace, CplSet, nestedStateName, vm, nestedState, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
character(len=*),	intent(in),	optional		::	Namespace
character(len=*),	intent(in),	optional		::	CplSet
character(len=*),	intent(in),	optional		::	nestedStateName
type(ESMF_VM),	intent(in),	optional		::	vm
type(ESMF_State),	intent(out),	optional		::	nestedState
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_AdjustClock(clock, maxTimestep, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock)				::	clock
type(ESMF_TimeInterval),	intent(in),	optional		::	maxTimestep
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_AdvertiseField(state, StandardName, Units, LongName, ShortName, name, TransferOfferGeomObject, SharePolicyField, SharePolicyGeomObject, vm, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
character(len=*),	intent(in)			::	StandardName
character(len=*),	intent(in),	optional		::	Units
character(len=*),	intent(in),	optional		::	LongName
character(len=*),	intent(in),	optional		::	ShortName
character(len=*),	intent(in),	optional		::	name
character(len=*),	intent(in),	optional		::	TransferOfferGeomObject
character(len=*),	intent(in),	optional		::	SharePolicyField
character(len=*),	intent(in),	optional		::	SharePolicyGeomObject
type(ESMF_VM),	intent(in),	optional		::	vm
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_AdvertiseFields(state, StandardNames, TransferOfferGeomObject, SharePolicyField, SharePolicyGeomObject, vm, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
character(len=*),	intent(in)			::	StandardNames(:)
character(len=*),	intent(in),	optional		::	TransferOfferGeomObject
character(len=*),	intent(in),	optional		::	SharePolicyField
character(len=*),	intent(in),	optional		::	SharePolicyGeomObject
type(ESMF_VM),	intent(in),	optional		::	vm
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_CheckSetClock(setClock, checkClock, setStartTimeToCurrent, currTime, forceCurrTime, checkTimeStep, forceTimeStep, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Clock),	intent(inout)			::	setClock
type(ESMF_Clock),	intent(in)			::	checkClock
logical,	intent(in),	optional		::	setStartTimeToCurrent
type(ESMF_Time),	intent(in),	optional		::	currTime
logical,	intent(in),	optional		::	forceCurrTime
logical,	intent(in),	optional		::	checkTimeStep
logical,	intent(in),	optional		::	forceTimeStep
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_ChopString(string, chopChar, chopStringList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*)				::	string
character(len=1)				::	chopChar
character(len=ESMF_MAXSTR),			pointer	::	chopStringList(:)
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_FieldBundleUpdateTime(srcFields, dstFields, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_FieldBundle),	intent(in)			::	srcFields
type(ESMF_FieldBundle),	intent(inout)			::	dstFields
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_GetAttributeFieldTK(field, name, isPresent, isSet, itemCount, typekind, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(in)			::	field
character(len=*),	intent(in)			::	name
logical,	intent(out),	optional		::	isPresent
logical,	intent(out),	optional		::	isSet
integer,	intent(out),	optional		::	itemCount
type(ESMF_TypeKind_Flag),	intent(out),	optional		::	typekind
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_GetAttributeFieldVal(field, name, value, isPresent, isSet, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(in)			::	field
character(len=*),	intent(in)			::	name
character(len=*),	intent(out)			::	value
logical,	intent(out),	optional		::	isPresent
logical,	intent(out),	optional		::	isSet
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_GetAttributeState(state, name, value, isPresent, isSet, itemCount, typekind, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=*),	intent(in)			::	name
character(len=*),	intent(out),	optional		::	value
logical,	intent(out),	optional		::	isPresent
logical,	intent(out),	optional		::	isSet
integer,	intent(out),	optional		::	itemCount
type(ESMF_TypeKind_Flag),	intent(out),	optional		::	typekind
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_GetStateMemberCount(state, fieldCount, nestedFlag, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
integer,	intent(out),	optional		::	fieldCount
logical,	intent(in),	optional		::	nestedFlag
integer,	intent(out),	optional		::	rc

private recursive subroutine NUOPC_GetStateMemberCountIntrnl(state, fieldCount, nestedFlag, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
integer,	intent(inout)			::	fieldCount
logical,	intent(in)			::	nestedFlag
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_GetStateMemberLists(state, StandardNameList, ConnectedList, NamespaceList, CplSetList, itemNameList, fieldList, stateList, nestedFlag, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=ESMF_MAXSTR),		optional,	pointer	::	StandardNameList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	ConnectedList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	NamespaceList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	CplSetList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	itemNameList(:)
type(ESMF_Field),		optional,	pointer	::	fieldList(:)
type(ESMF_State),		optional,	pointer	::	stateList(:)
logical,	intent(in),	optional		::	nestedFlag
integer,	intent(out),	optional		::	rc

private recursive subroutine NUOPC_GetStateMemberListsIntrnl(state, StandardNameList, ConnectedList, NamespaceList, CplSetList, itemNameList, fieldList, stateList, nestedFlag, namespaceRoot, itemIndex, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
character(len=ESMF_MAXSTR),		optional,	pointer	::	StandardNameList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	ConnectedList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	NamespaceList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	CplSetList(:)
character(len=ESMF_MAXSTR),		optional,	pointer	::	itemNameList(:)
type(ESMF_Field),		optional,	pointer	::	fieldList(:)
type(ESMF_State),		optional,	pointer	::	stateList(:)
logical,	intent(in)			::	nestedFlag
character(len=*),	intent(in)			::	namespaceRoot
integer,	intent(inout)			::	itemIndex
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_GetTimestamp(field, isValid, time, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(in)			::	field
logical,	intent(out),	optional		::	isValid
type(ESMF_Time),	intent(out),	optional		::	time
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_IngestPetListFF(petList, freeFormat, rc)

Arguments

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

private subroutine NUOPC_IngestPetListHC(petList, hconfig, rc)

Arguments

Type	Intent	Optional	Attributes		Name
integer,	intent(out),		allocatable	::	petList(:)
type(ESMF_HConfig),	intent(in)			::	hconfig
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_InitAttributesField(field, StandardName, Units, LongName, ShortName, Connected, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field)				::	field
character(len=*),	intent(in)			::	StandardName
character(len=*),	intent(in),	optional		::	Units
character(len=*),	intent(in),	optional		::	LongName
character(len=*),	intent(in),	optional		::	ShortName
character(len=*),	intent(in),	optional		::	Connected
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_InitAttributesState(state, rc)

Arguments

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

public subroutine NUOPC_LogExtro(name, rName, verbosity, importState, exportState, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name
character(len=*),	intent(in)			::	rName
integer,	intent(in)			::	verbosity
type(ESMF_State),	intent(in),	optional		::	importState
type(ESMF_State),	intent(in),	optional		::	exportState
integer,	intent(out)			::	rc

public subroutine NUOPC_LogIntro(name, rName, verbosity, importState, exportState, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name
character(len=*),	intent(in)			::	rName
integer,	intent(in)			::	verbosity
type(ESMF_State),	intent(in)			::	importState
type(ESMF_State),	intent(in)			::	exportState
integer,	intent(out)			::	rc

public subroutine NUOPC_LogPetList(petList, name, rc)

Arguments

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

public subroutine NUOPC_NoOp(gcomp, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp)				::	gcomp
integer,	intent(out)			::	rc

private subroutine NUOPC_RealizeCompleteG(state, grid, fieldName, typekind, staggerloc, selection, dataFillScheme, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
type(ESMF_Grid),	intent(in)			::	grid
character(len=*),	intent(in),	optional		::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
type(ESMF_StaggerLoc),	intent(in),	optional		::	staggerloc
character(len=*),	intent(in),	optional		::	selection
character(len=*),	intent(in),	optional		::	dataFillScheme
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeCompleteLS(state, locstream, fieldName, typekind, selection, dataFillScheme, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
type(ESMF_LocStream),	intent(in)			::	locstream
character(len=*),	intent(in),	optional		::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
character(len=*),	intent(in),	optional		::	selection
character(len=*),	intent(in),	optional		::	dataFillScheme
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeCompleteM(state, mesh, fieldName, typekind, meshloc, selection, dataFillScheme, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
type(ESMF_Mesh),	intent(in)			::	mesh
character(len=*),	intent(in),	optional		::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
type(ESMF_MeshLoc),	intent(in),	optional		::	meshloc
character(len=*),	intent(in),	optional		::	selection
character(len=*),	intent(in),	optional		::	dataFillScheme
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeField(state, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
type(ESMF_Field),	intent(in)			::	field
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_RealizeTransfer(state, fieldName, typekind, gridToFieldMap, ungriddedLBound, ungriddedUBound, totalLWidth, totalUWidth, realizeOnlyConnected, removeNotConnected, realizeOnlyNotShared, realizeOnlyNotComplete, field, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
character(len=*),	intent(in)			::	fieldName
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
integer,	intent(in),	optional,	target	::	gridToFieldMap(:)
integer,	intent(in),	optional,	target	::	ungriddedLBound(:)
integer,	intent(in),	optional,	target	::	ungriddedUBound(:)
integer,	intent(in),	optional		::	totalLWidth(:)
integer,	intent(in),	optional		::	totalUWidth(:)
logical,	intent(in),	optional		::	realizeOnlyConnected
logical,	intent(in),	optional		::	removeNotConnected
logical,	intent(in),	optional		::	realizeOnlyNotShared
logical,	intent(in),	optional		::	realizeOnlyNotComplete
type(ESMF_Field),	intent(out),	optional		::	field
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_Reconcile(state, rc)

Arguments

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

private subroutine NUOPC_SetAttributeField(field, name, value, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field)				::	field
character(len=*),	intent(in)			::	name
character(len=*),	intent(in)			::	value
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetAttributeState(state, name, value, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State)				::	state
character(len=*),	intent(in)			::	name
character(len=*),	intent(in)			::	value
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampField(field, time, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(inout)			::	field
type(ESMF_Time),	intent(in)			::	time
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampFieldList(fieldList, time, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(inout)			::	fieldList(:)
type(ESMF_Time),	intent(in)			::	time
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampFieldListClk(fieldList, clock, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),	intent(inout)			::	fieldList(:)
type(ESMF_Clock),	intent(in)			::	clock
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampState(state, time, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
type(ESMF_Time),	intent(in)			::	time
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_SetTimestampStateClk(state, clock, selective, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(inout)			::	state
type(ESMF_Clock),	intent(in)			::	clock
logical,	intent(in),	optional		::	selective
integer,	intent(out),	optional		::	rc

public subroutine NUOPC_SetVM(gcomp, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp)				::	gcomp
integer,	intent(out)			::	rc

private subroutine NUOPC_StateUpdateTimestamp(state, rootPet, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_State),	intent(in)			::	state
integer,	intent(in)			::	rootPet
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_UpdateAcrossFieldLists(srcFieldList, dstFieldList, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),			pointer	::	srcFieldList(:)
type(ESMF_Field),			pointer	::	dstFieldList(:)
integer,	intent(out),	optional		::	rc

private subroutine NUOPC_UpdateFieldList(fieldList, rootPet, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Field),			pointer	::	fieldList(:)
integer,	intent(in)			::	rootPet
integer,	intent(out),	optional		::	rc

private recursive subroutine ProcessRecusive(freeFormat, hconfig, rc)

Arguments

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