Next:
1 Description
Up:
NUOPC_refdoc
Previous:
NUOPC_refdoc
Contents
1 Description
2 Design and Implementation Notes
2.1 Generic Components
2.2 Field Dictionary
2.3 Metadata
2.3.1 Model Component Metadata
2.3.2 Connector Component Metadata
2.3.3 Field Metadata
2.4 Initialize Phase Definitions
3 API
3.1 Generic Component: NUOPC_Driver
3.2 Generic Component: NUOPC_DriverAtmOcn
3.3 Generic Component: NUOPC_DriverAtmOcnMed
3.4 Generic Component: NUOPC_ModelBase
3.5 Generic Component: NUOPC_Model
3.6 Generic Component: NUOPC_Mediator
3.7 Generic Component: NUOPC_Connector
3.8 Utility Class: NUOPC_RunSequence
3.8.1 NUOPC_RunElementAdd - Add a RunElement to the end of a RunSequence
3.8.2 NUOPC_RunElementPrint - Print info about a RunElement object
3.8.3 NUOPC_RunSequenceAdd - Add more RunSequences to a RunSequence vector
3.8.4 NUOPC_RunSequenceDeallocate - Deallocate an entire RunSequence vector
3.8.5 NUOPC_RunSequenceDeallocate - Deallocate a single RunSequence object
3.8.6 NUOPC_RunSequenceIterate - Iterate through a RunSequence
3.8.7 NUOPC_RunSequencePrint - Print info about a single RunSequence object
3.8.8 NUOPC_RunSequencePrint - Print info about a RunSequence vector
3.8.9 NUOPC_RunSequenceSet - Set values inside a RunSequence object
3.9 Utility Routines
3.9.1 NUOPC_ClockCheckSetClock - Check a Clock for compatibility
3.9.2 NUOPC_ClockInitialize - Initialize a new Clock from Clock and stabilityTimeStep
3.9.3 NUOPC_ClockPrintCurrTime - Formatted print ot current time
3.9.4 NUOPC_ClockPrintStartTime - Formatted print ot start time
3.9.5 NUOPC_ClockPrintStopTime - Formatted print ot stop time
3.9.6 NUOPC_CplCompAreServicesSet - Check if SetServices was called
3.9.7 NUOPC_CplCompAttributeAdd - Add the NUOPC CplComp Attributes
3.9.8 NUOPC_CplCompAttributeGet - Get a NUOPC CplComp Attribute
3.9.9 NUOPC_CplCompAttributeSet - Set the NUOPC CplComp Attributes
3.9.10 NUOPC_FieldAttributeAdd - Add the NUOPC Field Attributes
3.9.11 NUOPC_FieldAttributeGet - Get a NUOPC Field Attribute
3.9.12 NUOPC_FieldAttributeSet - Set a NUOPC Field Attribute
3.9.13 NUOPC_FieldBundleUpdateTime - Update the time stamp on all Fields in a FieldBundle
3.9.14 NUOPC_FieldDictionaryAddEntry - Add an entry to the NUOPC Field dictionary
3.9.15 NUOPC_FieldDictionaryGetEntry - Get information about a NUOPC Field dictionary entry
3.9.16 NUOPC_FieldDictionaryHasEntry - Check whether the NUOPC Field dictionary has a specific entry
3.9.17 NUOPC_FieldDictionarySetup - Setup the NUOPC Field dictionary
3.9.18 NUOPC_FieldIsAtTime - Check if the Field is at the given Time
3.9.19 NUOPC_FillCplList - Fill the cplList according to matching Fields
3.9.20 NUOPC_GridCompAreServicesSet - Check if SetServices was called
3.9.21 NUOPC_GridCompAttributeAdd - Add the NUOPC GridComp Attributes
3.9.22 NUOPC_GridCompCheckSetClock - Check Clock compatibility and set stopTime
3.9.23 NUOPC_GridCompSetClock - Initialize and set the internal Clock of a GridComp
3.9.24 NUOPC_GridCreateSimpleXY - Create a simple XY cartesian Grid
3.9.25 NUOPC_IsCreated - Check whether an ESMF object has been created
3.9.26 NUOPC_StateAdvertiseField - Advertise a Field in a State
3.9.27 NUOPC_StateBuildStdList - Build lists of Field information from a State
3.9.28 NUOPC_StateIsAllConnected - Check if all the Fields in a State are connected
3.9.29 NUOPC_StateIsAtTime - Check if all the Fields in a State are at the given Time
3.9.30 NUOPC_StateIsFieldConnected - Test if Field in a State is connected
3.9.31 NUOPC_StateIsUpdated - Check if all the Fields in a State are marked as updated
3.9.32 NUOPC_StateRealizeField - Realize a previously advertised Field in a State
3.9.33 NUOPC_StateSetTimestamp - Set a time stamp on all Fields in a State
3.9.34 NUOPC_StateUpdateTimestamp - Update the timestamp on all the Fields in a State
3.9.35 NUOPC_TimePrint - Formatted print ot time information
esmf_support@list.woc.noaa.gov
