MODULE:
module NUOPC_Driver
DESCRIPTION:
Component that drives and coordinates initialization of its child components: Model, Mediator, and Connector components. For every Driver time step the same run sequence, i.e. sequence of Model, Mediator, and Connector Run methods is called. The run sequence is fully customizable. The default run sequence implements explicit time stepping.
SUPER:
ESMF_GridComp
USE DEPENDENCIES:
use ESMF
SETSERVICES:
subroutine SetServices(driver, rc)
type(ESMF_GridComp) :: driver
integer, intent(out) :: rc
INITIALIZE:
RUN:
FINALIZE:
INTERFACE:
! Private name; call using NUOPC_DriverAddComp()
recursive subroutine NUOPC_DriverAddGridComp(driver, compLabel, &
compSetServicesRoutine, petList, comp, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
character(len=*), intent(in) :: compLabel
interface
recursive subroutine compSetServicesRoutine(gridcomp, rc)
use ESMF
implicit none
type(ESMF_GridComp) :: gridcomp ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(in), optional :: petList(:)
type(ESMF_GridComp), intent(out), optional :: comp
integer, intent(out), optional :: rc
DESCRIPTION:
Create and add a GridComp (i.e. Model, Mediator, or Driver) as a child component to a Driver. The component is created on the provided petList, or by default across all of the Driver PETs.
The specified SetServices() routine is called back immediately after the new child component has been created internally. Very little around the component is set up at that time (e.g. component attributes are not available). The routine should therefore be very light weight, with the sole purpose of setting the entry points of the component - typically by deriving from a generic component followed by the appropriate specilizations.
The compLabel must uniquely identify the child component within the context of the Driver component.
If the comp argument is specified, it will reference the newly created component on return.
INTERFACE:
! Private name; call using NUOPC_DriverAddComp()
recursive subroutine NUOPC_DriverAddGridCompSO(driver, compLabel, &
sharedObj, petList, comp, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
character(len=*), intent(in) :: compLabel
character(len=*), intent(in), optional :: sharedObj
integer, intent(in), optional :: petList(:)
type(ESMF_GridComp), intent(out), optional :: comp
integer, intent(out), optional :: rc
DESCRIPTION:
Create and add a GridComp (i.e. Model, Mediator, or Driver) as a child component to a Driver. The component is created on the provided petList, or by default across all of the Driver PETs.
The SetServices() routine in the sharedObj is called back immediately after the new child component has been created internally. Very little around the component is set up at that time (e.g. component attributes are not available). The routine should therefore be very light weight, with the sole purpose of setting the entry points of the component - typically by deriving from a generic component followed by the appropriate specilizations.
The compLabel must uniquely identify the child component within the context of the Driver component.
If the comp argument is specified, it will reference the newly created component on return.
INTERFACE:
! Private name; call using NUOPC_DriverAddComp()
recursive subroutine NUOPC_DriverAddCplComp(driver, srcCompLabel, &
dstCompLabel, compSetServicesRoutine, petList, comp, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
character(len=*), intent(in) :: srcCompLabel
character(len=*), intent(in) :: dstCompLabel
interface
recursive subroutine compSetServicesRoutine(cplcomp, rc)
use ESMF
implicit none
type(ESMF_CplComp) :: cplcomp ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, target, intent(in), optional :: petList(:)
type(ESMF_CplComp), intent(out), optional :: comp
integer, intent(out), optional :: rc
DESCRIPTION:
Create and add a CplComp (i.e. Connector) as a child component to a Driver. The component is created on the provided petList, or by default across the union of PETs of the components indicated by srcCompLabel and dstCompLabel.
The specified SetServices() routine is called back immediately after the new child component has been created internally. Very little around the component is set up at that time (e.g. component attributes are not available). The routine should therefore be very light weight, with the sole purpose of setting the entry points of the component - typically by deriving from a generic component followed by the appropriate specilizations.
The compLabel must uniquely identify the child component within the context of the Driver component.
If the comp argument is specified, it will reference the newly created component on return.
INTERFACE:
! Private name; call using NUOPC_DriverAddRunElement()
recursive subroutine NUOPC_DriverAddRunElementMPL(driver, slot, compLabel, &
phaseLabel, relaxedflag, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
integer, intent(in) :: slot
character(len=*), intent(in) :: compLabel
-- The following arguments require argument keyword syntax (e.g. rc=rc). --
character(len=*), intent(in), optional :: phaseLabel
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Add an element associated with a Model, Mediator, or Driver component to the run sequence of the Driver. The component must have been added to the Driver, and associated with compLabel prior to this call.
If phaseLabel was not specified, the first entry in the RunPhaseMap attribute of the referenced component will be used to determine the run phase of the added element.
By default an error is returned if no component is associated with the specified compLabel. This error can be suppressed by setting relaxedflag=.true., and no entry will be added to the run sequence.
The slot number identifies the run sequence time slot in case multiple sequences are available. Slots start counting from 1.
INTERFACE:
! Private name; call using NUOPC_DriverAddRunElement()
recursive subroutine NUOPC_DriverAddRunElementCPL(driver, slot, srcCompLabel,&
dstCompLabel, phaseLabel, relaxedflag, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
integer, intent(in) :: slot
character(len=*), intent(in) :: srcCompLabel
character(len=*), intent(in) :: dstCompLabel
-- The following arguments require argument keyword syntax (e.g. rc=rc). --
character(len=*), intent(in), optional :: phaseLabel
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Add an element associated with a Connector component to the run sequence of the Driver. The component must have been added to the Driver, and associated with srcCompLabel and dstCompLabel prior to this call.
If phaseLabel was not specified, the first entry in the RunPhaseMap attribute of the referenced component will be used to determine the run phase of the added element.
By default an error is returned if no component is associated with the specified compLabel. This error can be suppressed by setting relaxedflag=.true., and no entry will be added to the run sequence.
The slot number identifies the run sequence time slot in case multiple sequences are available. Slots start counting from 1.
INTERFACE:
! Private name; call using NUOPC_DriverAddRunElement() recursive subroutine NUOPC_DriverAddRunElementL(driver, slot, linkSlot, rc)ARGUMENTS:
type(ESMF_GridComp) :: driver
integer, intent(in) :: slot
integer, intent(in) :: linkSlot
integer, intent(out), optional :: rc
DESCRIPTION:
Add an element to the run sequence of the Driver that links to the time slot indicated by linkSlot.
INTERFACE:
recursive subroutine NUOPC_DriverEgestRunSequence(driver, freeFormat, rc)ARGUMENTS:
type(ESMF_GridComp) :: driver
type(NUOPC_FreeFormat), intent(out) :: freeFormat
integer, intent(out), optional :: rc
DESCRIPTION:
Egest the run sequence stored in the driver as a FreeFormat object. It is the caller's responsibility to destroy the created freeFormat object.
INTERFACE:
! Private name; call using NUOPC_DriverGetComp()
recursive subroutine NUOPC_DriverGetGridComp(driver, compLabel, comp, petList, &
relaxedflag, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
character(len=*), intent(in) :: compLabel
type(ESMF_GridComp), intent(out), optional :: comp
integer, pointer, optional :: petList(:)
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Query the Driver for a GridComp (i.e. Model, Mediator, or Driver) child component that was added under compLabel.
If provided, the petList argument will be associated with the petList that was used to create the referenced component.
By default an error is returned if no component is associated with the specified compLabel. This error can be suppressed by setting relaxedflag=.true., and unassociated arguments will be returned.
INTERFACE:
! Private name; call using NUOPC_DriverGetComp()
recursive subroutine NUOPC_DriverGetCplComp(driver, srcCompLabel, &
dstCompLabel, comp, petList, relaxedflag, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
character(len=*), intent(in) :: srcCompLabel
character(len=*), intent(in) :: dstCompLabel
type(ESMF_CplComp), intent(out), optional :: comp
integer, pointer , optional :: petList(:)
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Query the Driver for a CplComp (i.e. Connector) child component that was added under compLabel.
If provided, the petList argument will be associated with the petList that was used to create the referenced component.
By default an error is returned if no component is associated with the specified compLabel. This error can be suppressed by setting relaxedflag=.true., and unassociated arguments will be returned.
INTERFACE:
! Private name; call using NUOPC_DriverGetComp()
recursive subroutine NUOPC_DriverGetAllGridComp(driver, compList, petLists, &
rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
type(ESMF_GridComp), pointer, optional :: compList(:)
type(type_petList), pointer, optional :: petLists(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Get all the GridComp (i.e. Model, Mediator, or Driver) child components from a Driver. The incoming compList and petLists arguments must be unassociated. On return it becomes the responsibility of the caller to deallocate the associated compList and petLists arguments
INTERFACE:
! Private name; call using NUOPC_DriverGetComp() recursive subroutine NUOPC_DriverGetAllCplComp(driver, compList, rc)ARGUMENTS:
type(ESMF_GridComp) :: driver
type(ESMF_CplComp), pointer :: compList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Get all the CplComp (i.e. Connector) child components from a Driver. The incoming compList and petLists arguments must be unassociated. On return it becomes the responsibility of the caller to deallocate the associated compList and petLists arguments
INTERFACE:
recursive subroutine NUOPC_DriverIngestRunSequence(driver, freeFormat, &
autoAddConnectors, rc)
ARGUMENTS:
type(ESMF_GridComp) :: driver
type(NUOPC_FreeFormat), intent(in) :: freeFormat
logical, intent(in), optional :: autoAddConnectors
integer, intent(out), optional :: rc
DESCRIPTION:
Ingest the run sequence from a FreeFormat object. Every line in freeFormat corresponds to either a single run sequence element, or contains the time step information of a loop. The default of autoAddConnectors is .false., which means that all components referenced in the freeFormat run sequence, including connectors, must already be available as child components of the driver component, or else an error will be returned. When autoAddConnectors is set to .true., connector components encountered in the run sequence that are no already present in the driver will be added automatically. The default NUOPC_Connector implementation will be used for all automatically added connector instances.
Time loops in the run sequence start with a line in freeFormat that
begins with the 
symbol, followed by the timestep in seconds. A line with
a single symbol closes the time loop. A simple example for a loop with
1 hour timestep:
@3600
...
...
@
Time loops can be nested.
The lines between the time loop markers define the sequence in which the run methods of the components are called. Note that components will execute concurrently as long as this is not prevented by data-dependencies or overlapping petLists.
Each line specifies the precise run method phase for a single component instance. For model, mediator, and driver components the format is this:
compLabel [phaseLabel]
Here compLabel is the label by which the component instance is known to
the driver. It is optionally followed a phaseLabel identifying a
specific run phase. An example of calling the run phase of the ATM instance
that contains the fast processes:
ATM fast
By default, i.e. without phaseLabel, the first
registered run method of the component is used.
The format for connector components is different. It is defined like this:
srcCompLabel -> dstCompLabel [connectionOptions]
A connector instance is uniquely known by the two components it connects,
i.e. by srcCompLabel and dstCompLabel. The syntax requires that
the token -> be specified between source and destination. Optionally
connectionOptions can be supplied using the same format discussed
under section 2.4.5. An example of executing the connector
instance that transfers fields from the ATM component to the OCN component,
using redistribution for remapping:
ATM -> OCN :remapMethod=redist
INTERFACE:
recursive subroutine NUOPC_DriverNewRunSequence(driver, slotCount, rc)ARGUMENTS:
type(ESMF_GridComp) :: driver
integer, intent(in) :: slotCount
integer, intent(out), optional :: rc
DESCRIPTION:
Replace the current run sequence of the Driver with a new one that has slotCount slots. Each slot uses its own clock for time keeping.
INTERFACE:
recursive subroutine NUOPC_DriverPrint(driver, orderflag, rc)ARGUMENTS:
type(ESMF_GridComp) :: driver
logical, intent(in), optional :: orderflag
integer, intent(out), optional :: rc
DESCRIPTION:
Print internal Driver information. If orderflag is provided and set to .true., the output is ordered from lowest to highest PET. Setting this flag makes the method collective.
INTERFACE:
! Private name; call using NUOPC_DriverSetRunSequence() recursive subroutine NUOPC_DriverSetRunSequence(driver, slot, clock, rc)ARGUMENTS:
type(ESMF_GridComp) :: driver
integer, intent(in) :: slot
type(ESMF_Clock), intent(in) :: clock
integer, intent(out), optional :: rc
DESCRIPTION:
Set the clock in the run sequence under slot of the Driver.
MODULE:
module NUOPC_ModelBase
DESCRIPTION:
Partial specialization of a component with a default explicit time dependency. Each time the Run method is called the component steps one timeStep forward on the passed in parent
clock. The component flags incompatibility during Run if the current time of the incoming
clock does not match the current time of the internal clock.
SUPER:
ESMF_GridComp
USE DEPENDENCIES:
use ESMF
SETSERVICES:
subroutine SetServices(modelBase, rc)
type(ESMF_GridComp) :: modelBase
integer, intent(out) :: rc
INITIALIZE:
RUN:
FINALIZE:
MODULE:
module NUOPC_Model
DESCRIPTION:
Model component with a default explicit time dependency. Each time the Run method is called the model integrates one timeStep forward on the passed in parent clock. The internal clock is advanced at the end of each Run call. The component flags incompatibility during Run if the current time of the incoming clock does not match the current time of the internal clock.
SUPER:
NUOPC_ModelBase
USE DEPENDENCIES:
use ESMF
SETSERVICES:
subroutine SetServices(model, rc)
type(ESMF_GridComp) :: model
integer, intent(out) :: rc
INITIALIZE:
The NUOPC_Realize methods (3.9.20, 3.9.21) are used to realize fields. Only previously advertised fields can be realized and the field's name is used to search the state for the previously advertised field.
*Note: This phase is not required if all fields are accepting a geometric object.
This phase is useful when accepting a Grid from another component, but when the PET counts differ between components. In this case, a new decomposition needs to be set based on the current processor count.
The NUOPC_Realize methods (3.9.20, 3.9.21) are used to realize fields. Only previously advertised fields can be realized and the field's name is used to search the state for the previously advertised field.
*Note: This phase is not required if all fields are providing a geometric object.
RUN:
FINALIZE:
The specialization method can change aspects of the internal clock, which defaults to a copy of the incoming parent clock. For example, the timeStep size may be changed and/or Alarms may be set on the clock.
The method NUOPC_CompSetClock(comp, externalClock, stabilityTimeStep) (3.6.32) can be used to set the internal clock as a copy of externalClock, but with a timeStep that is less than or equal to the stabilityTimeStep. At the same time it ensures that the timeStep of the external clock is a multiple of the timeStep of the internal clock. If the stabilityTimeStep argument is not provided then the internal clock will simply be set as a copy of the external clock.
The specialization method should initialize field data in the export state. Fields in the export state will be timestamped automatically by the calling phase for all fields that have the ``Updated'' attribute set to ``true''.
A specialization method to check and set the internal clock against the incoming clock. This method is called by the default run phase.
If not overridden, the default method will check that the internal clock and incoming clock agree on the current time and that the time step of the incoming clock is a multiple of the internal clock time step. Under these conditions set the internal stop time to one time step interval of the incoming clock. Otherwise exit with error, flagging an incompatibility.
A specialization method to verify import fields before advancing in time. If not overridden, the default method verifies that all import fields are at the current time of the internal clock.
A specialization method that advances the model forward in time by one timestep of the internal clock. This method will be called iteratively by the default run phase until reaching the stop time on the internal clock.
A specialization method to set the timestamp on export fields after the model has advanced. If not overridden, the default method sets the timestamp on all export fields to the stop time on the internal clock (which is also now the current model time).
An optional specialization method for custom finalization code and deallocations of user data structures.
INTERFACE:
subroutine NUOPC_ModelGet(model, driverClock, modelClock, &
importState, exportState, rc)
ARGUMENTS:
type(ESMF_GridComp) :: model
type(ESMF_Clock), intent(out), optional :: driverClock
type(ESMF_Clock), intent(out), optional :: modelClock
type(ESMF_State), intent(out), optional :: importState
type(ESMF_State), intent(out), optional :: exportState
integer, intent(out), optional :: rc
DESCRIPTION:
Access Model information.
MODULE:
module NUOPC_Mediator
DESCRIPTION:
Mediator component with a default explicit time dependency. Each time the Run method is called, the time stamp on the imported Fields must match the current time (on both the incoming and internal clock). Before returning, the Mediator time stamps the exported Fields with the same current time, before advancing the internal clock one timeStep forward.
SUPER:
NUOPC_ModelBase
USE DEPENDENCIES:
use ESMF
SETSERVICES:
subroutine SetServices(mediator, rc)
type(ESMF_GridComp) :: mediator
integer, intent(out) :: rc
INITIALIZE:
RUN:
FINALIZE:
INTERFACE:
subroutine NUOPC_MediatorGet(mediator, driverClock, mediatorClock, &
importState, exportState, rc)
ARGUMENTS:
type(ESMF_GridComp) :: mediator
type(ESMF_Clock), intent(out), optional :: driverClock
type(ESMF_Clock), intent(out), optional :: mediatorClock
type(ESMF_State), intent(out), optional :: importState
type(ESMF_State), intent(out), optional :: exportState
integer, intent(out), optional :: rc
DESCRIPTION:
Access Mediator information.
MODULE:
module NUOPC_Connector
DESCRIPTION:
Component that makes a unidirectional connection between model, mediator, and or driver components. During initialization field pairing is performed between the import and export side according to section 2.4.3, and paired fields are connected. By default the bilinear regrid method is used during Run to transfer data from the connected import Fields to the connected export Fields.
SUPER:
ESMF_CplComp
USE DEPENDENCIES:
use ESMF
SETSERVICES:
subroutine SetServices(connector, rc)
type(ESMF_CplComp) :: connector
integer, intent(out) :: rc
INITIALIZE:
RUN:
FINALIZE:
INTERFACE:
subroutine NUOPC_ConnectorGet(connector, srcFields, dstFields, rh, state, &
CplSet, cplSetList, rc)
ARGUMENTS:
type(ESMF_CplComp) :: connector
type(ESMF_FieldBundle), intent(out), optional :: srcFields
type(ESMF_FieldBundle), intent(out), optional :: dstFields
type(ESMF_RouteHandle), intent(out), optional :: rh
type(ESMF_State), intent(out), optional :: state
character(*), intent(in), optional :: CplSet
character(ESMF_MAXSTR), pointer, optional :: cplSetList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Get parameters from the connector internal state.
INTERFACE:
subroutine NUOPC_ConnectorSet(connector, srcFields, dstFields, rh, state, &
CplSet, rc)
ARGUMENTS:
type(ESMF_CplComp) :: connector
type(ESMF_FieldBundle), intent(in), optional :: srcFields
type(ESMF_FieldBundle), intent(in), optional :: dstFields
type(ESMF_RouteHandle), intent(in), optional :: rh
type(ESMF_State), intent(in), optional :: state
character(*), intent(in), optional :: CplSet
integer, intent(out), optional :: rc
DESCRIPTION:
Set parameters in the connector internal state.
INTERFACE:
! Private name; call using NUOPC_CompAreServicesSet() function NUOPC_GridCompAreServicesSet(comp, rc)RETURN VALUE:
logical :: NUOPC_GridCompAreServicesSetARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if SetServices has been called for comp. Otherwise return .false..
INTERFACE:
! Private name; call using NUOPC_CompAreServicesSet() function NUOPC_CplCompAreServicesSet(comp, rc)RETURN VALUE:
logical :: NUOPC_CplCompAreServicesSetARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if SetServices has been called for comp. Otherwise return .false..
INTERFACE:
! Private name; call using NUOPC_CompAttributeAdd() subroutine NUOPC_GridCompAttributeAdd(comp, attrList, rc)ARGUMENTS:
type(ESMF_GridComp) :: comp
character(len=*), intent(in) :: attrList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Add Attributes to the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
INTERFACE:
! Private name; call using NUOPC_CompAttributeAdd() subroutine NUOPC_CplCompAttributeAdd(comp, attrList, rc)ARGUMENTS:
type(ESMF_CplComp) :: comp
character(len=*), intent(in) :: attrList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Add Attributes to the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
INTERFACE:
! Private name; call using NUOPC_CompAttributeEgest() subroutine NUOPC_GridCompAttributeEge(comp, freeFormat, rc)ARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
type(NUOPC_FreeFormat), intent(out) :: freeFormat
integer, intent(out), optional :: rc
DESCRIPTION:
Egest the Attributes of the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance") as a FreeFormat object. It is the caller's responsibility to destroy the created freeFormat object.
INTERFACE:
! Private name; call using NUOPC_CompAttributeEgest() subroutine NUOPC_CplCompAttributeEge(comp, freeFormat, rc)ARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
type(NUOPC_FreeFormat), intent(out) :: freeFormat
integer, intent(out), optional :: rc
DESCRIPTION:
Egest the Attributes of the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance") as a FreeFormat object. It is the caller's responsibility to destroy the created freeFormat object.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet() subroutine NUOPC_GridCompAttributeGet(comp, name, value, rc)ARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
character(*), intent(in) :: name
character(*), intent(out) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Access the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet() subroutine NUOPC_CplCompAttributeGet(comp, name, value, rc)ARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
character(*), intent(in) :: name
character(*), intent(out) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Access the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet() subroutine NUOPC_GridCompAttributeGetI(comp, name, value, rc)ARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
character(*), intent(in) :: name
integer, intent(out) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Access the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet() subroutine NUOPC_CplCompAttributeGetI(comp, name, value, rc)ARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
character(*), intent(in) :: name
integer, intent(out) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Access the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet()
subroutine NUOPC_GridCompAttributeGetSL(comp, name, valueList, itemCount, &
rc)
ARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
character(*), intent(in) :: name
character(*), intent(out), optional :: valueList(:)
integer, intent(out), optional :: itemCount
integer, intent(out), optional :: rc
DESCRIPTION:
Access the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet()
subroutine NUOPC_CplCompAttributeGetSL(comp, name, valueList, itemCount, &
rc)
ARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
character(*), intent(in) :: name
character(*), intent(out), optional :: valueList(:)
integer, intent(out), optional :: itemCount
integer, intent(out), optional :: rc
DESCRIPTION:
Access the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet() subroutine NUOPC_GridCompAttributeGetTK(comp, name, typekind, rc)ARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
character(*), intent(in) :: name
type(ESMF_TypeKind_Flag), intent(out) :: typekind
integer, intent(out), optional :: rc
DESCRIPTION:
Query the typekind of the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeGet() subroutine NUOPC_CplCompAttributeGetTK(comp, name, typekind, rc)ARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
character(*), intent(in) :: name
type(ESMF_TypeKind_Flag), intent(out) :: typekind
integer, intent(out), optional :: rc
DESCRIPTION:
Query the typekind of the Attribute name inside of comp using the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeIngest() subroutine NUOPC_GridCompAttributeIng(comp, freeFormat, addFlag, rc)ARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
type(NUOPC_FreeFormat), intent(in) :: freeFormat
logical, intent(in), optional :: addFlag
integer, intent(out), optional :: rc
DESCRIPTION:
Ingest the Attributes from a FreeFormat object onto the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
If addFlag is .false. (default), an error will be returned if an attribute is to be ingested that was not previously added to the comp object. If addFlag is .true., all missing attributes will be added by this method automatically as needed.
Each line in freeFormat is of this format:
attributeName = attributeValue
For example:
Verbosity = 0
Profiling = 0
could directly be ingested as Attributes for any instance of the four
standard NUOPC component kinds. This is because Verbosity and
Profiling are pre-defined Attributes of the NUOPC component kinds
according to sections 2.3.1, 2.3.2,
2.3.3, and 2.3.4.
When Attributes are specified in freeFormat that are not pre-defined for a specific component kind, they can still be ingested by a component instance using the addFlag=.true. option. For instance:
ModelOutputChoice = 2
specifies a user-level Attribute, which is not part of the pre-defined
Attributes of any of the standard NUOPC component kinds.
INTERFACE:
! Private name; call using NUOPC_CompAttributeIngest() subroutine NUOPC_CplCompAttributeIng(comp, freeFormat, addFlag, rc)ARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
type(NUOPC_FreeFormat), intent(in) :: freeFormat
logical, intent(in), optional :: addFlag
integer, intent(out), optional :: rc
DESCRIPTION:
Ingest the Attributes from a FreeFormat object onto the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
If addFlag is .false. (default), an error will be returned if an attribute is to be ingested that was not previously added to the comp object. If addFlag is .true., all missing attributes will be added by this method automatically as needed.
Each line in freeFormat is of this format:
attributeName = attributeValue
For example:
Verbosity = 0
Profiling = 0
could directly be ingested as Attributes for any instance of the four
standard NUOPC component kinds. This is because Verbosity and
Profiling are pre-defined Attributes of the NUOPC component kinds
according to sections 2.3.1, 2.3.2,
2.3.3, and 2.3.4.
When Attributes are specified in freeFormat that are not pre-defined for a specific component kind, they can still be ingested by a component instance using the addFlag=.true. option. For instance:
ModelOutputChoice = 2
specifies a user-level Attribute, which is not part of the pre-defined
Attributes of any of the standard NUOPC component kinds.
INTERFACE:
! Private name; call using NUOPC_CompAttributeSet() subroutine NUOPC_GridCompAttributeSetS(comp, name, value, rc)ARGUMENTS:
type(ESMF_GridComp) :: comp
character(*), intent(in) :: name
character(*), intent(in) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Set the Attribute name inside of comp on the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeSet() subroutine NUOPC_CplCompAttributeSetS(comp, name, value, rc)ARGUMENTS:
type(ESMF_CplComp) :: comp
character(*), intent(in) :: name
character(*), intent(in) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Set the Attribute name inside of comp on the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeSet() subroutine NUOPC_GridCompAttributeSetI(comp, name, value, rc)ARGUMENTS:
type(ESMF_GridComp) :: comp
character(*), intent(in) :: name
integer, intent(in) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Set the Attribute name inside of comp on the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeSet() subroutine NUOPC_CplCompAttributeSetI(comp, name, value, rc)ARGUMENTS:
type(ESMF_CplComp) :: comp
character(*), intent(in) :: name
integer, intent(in) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Set the Attribute name inside of comp on the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeSet() subroutine NUOPC_GridCompAttributeSetSL(comp, name, valueList, rc)ARGUMENTS:
type(ESMF_GridComp) :: comp
character(*), intent(in) :: name
character(*), intent(in) :: valueList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Set the Attribute name inside of comp on the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompAttributeSet() subroutine NUOPC_CplCompAttributeSetSL(comp, name, valueList, rc)ARGUMENTS:
type(ESMF_CplComp) :: comp
character(*), intent(in) :: name
character(*), intent(in) :: valueList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Set the Attribute name inside of comp on the highest level of the standard NUOPC AttPack hierarchy (convention="NUOPC", purpose="Instance").
Return with error if the Attribute is not present or not set.
INTERFACE:
! Private name; call using NUOPC_CompCheckSetClock() subroutine NUOPC_GridCompCheckSetClock(comp, externalClock, rc)ARGUMENTS:
type(ESMF_GridComp), intent(inout) :: comp
type(ESMF_Clock), intent(in) :: externalClock
integer, intent(out), optional :: rc
DESCRIPTION:
Compare externalClock to the internal clock of comp to make sure they match in their current time. Also ensure that the time step of the external clock is a multiple of the time step of the internal clock. If both conditions are satisfied then set the stop time of the internal clock so it is reached in one time step of the external clock. Otherwise leave the internal clock unchanged and return with error. The direction of the involved clocks is taking into account.
INTERFACE:
! Private name; call using NUOPC_CompDerive() recursive subroutine NUOPC_GridCompDerive(comp, genericSetServicesRoutine, rc)ARGUMENTS:
type(ESMF_GridComp), intent(in) :: comp
interface
subroutine genericSetServicesRoutine(gridcomp, rc)
use ESMF
implicit none
type(ESMF_GridComp) :: gridcomp ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(out), optional :: rc
DESCRIPTION:
Derive a GridComp (i.e. Model, Mediator, or Driver) from a generic component by calling into the specified SetServices() routine of the generic component. This is typically the first call in the SetServices() routine of the specializing component, and is followed by NUOPC_CompSpecialize() calls.
INTERFACE:
! Private name; call using NUOPC_CompDerive() recursive subroutine NUOPC_CplCompDerive(comp, genericSetServicesRoutine, rc)ARGUMENTS:
type(ESMF_CplComp), intent(in) :: comp
interface
subroutine genericSetServicesRoutine(cplcomp, rc)
use ESMF
implicit none
type(ESMF_CplComp) :: cplcomp ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(out), optional :: rc
DESCRIPTION:
Derive a CplComp (i.e. Connector) from a generic component by calling into the specified SetServices() routine of the generic component. This is typically the first call in the SetServices() routine of the specializing component, and is followed by NUOPC_CompSpecialize() calls.
INTERFACE:
! Private name; call using NUOPC_CompFilterPhaseMap()
subroutine NUOPC_GridCompFilterPhaseMap(comp, methodflag, acceptStringList, &
rc)
ARGUMENTS:
type(ESMF_GridComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
character(len=*), intent(in) :: acceptStringList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Filter all PhaseMap entries in a GridComp (i.e. Model, Mediator, or Driver) that do not match any entry in the acceptStringList.
INTERFACE:
! Private name; call using NUOPC_CompFilterPhaseMap()
subroutine NUOPC_CplCompFilterPhaseMap(comp, methodflag, acceptStringList, &
rc)
ARGUMENTS:
type(ESMF_CplComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
character(len=*), intent(in) :: acceptStringList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Filter all PhaseMap entries in a CplComp (i.e. Connector) that do not match any entry in the acceptStringList.
INTERFACE:
! Private name; call using NUOPC_CompSearchPhaseMap()
subroutine NUOPC_GridCompSearchPhaseMap(comp, methodflag, phaseLabel, &
phaseIndex, rc)
ARGUMENTS:
type(ESMF_GridComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
character(len=*), intent(in), optional :: phaseLabel
integer, intent(out) :: phaseIndex
integer, intent(out), optional :: rc
DESCRIPTION:
Search all PhaseMap entries in a GridComp (i.e. Model, Mediator, or Driver) to see if phaseLabel is found. Return the associated ESMF phaseIndex, or -1 if not found. If phaseLabel is not specified, set phaseIndex to the first entry in the PhaseMap, or -1 if there are no entries.
INTERFACE:
! Private name; call using NUOPC_CompSearchPhaseMap()
subroutine NUOPC_CplCompSearchPhaseMap(comp, methodflag, phaseLabel, &
phaseIndex, rc)
ARGUMENTS:
type(ESMF_CplComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
character(len=*), intent(in), optional :: phaseLabel
integer, intent(out) :: phaseIndex
integer, intent(out), optional :: rc
DESCRIPTION:
Search all PhaseMap entries in a CplComp (i.e. Connector) to see if phaseLabel is found. Return the associated ESMF phaseIndex, or -1 if not found. If phaseLabel is not specified, set phaseIndex to the first entry in the PhaseMap, or -1 if there are no entries.
INTERFACE:
! Private name; call using NUOPC_CompSearchRevPhaseMap()
subroutine NUOPC_GridCompSearchRevPhaseMap(comp, methodflag, internalflag, &
phaseIndex, phaseLabel, rc)
ARGUMENTS:
type(ESMF_GridComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
logical, intent(in), optional :: internalflag
integer, intent(in), optional :: phaseIndex
character(len=*), intent(out) :: phaseLabel
integer, intent(out), optional :: rc
DESCRIPTION:
Search all PhaseMap entries in a GridComp (i.e. Model, Mediator, or Driver) to see if the ESMF phaseIndex is found. Return the associated phaseLabel, or an empty string if not found. If phaseIndex is not specified, set phaseLabel to the first entry in the PhaseMap, or an empty string if there are no entries. The internalflag argument allows to search the internal phase maps of driver components. The default is internalflag=.false..
INTERFACE:
! Private name; call using NUOPC_CompSearchRevPhaseMap()
subroutine NUOPC_CplCompSearchRevPhaseMap(comp, methodflag, phaseIndex, &
phaseLabel, rc)
ARGUMENTS:
type(ESMF_CplComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
integer, intent(in), optional :: phaseIndex
character(len=*), intent(out) :: phaseLabel
integer, intent(out), optional :: rc
DESCRIPTION:
Search all PhaseMap entries in a CplComp (i.e. Connector) to see if the ESMF phaseIndex is found. Return the associated phaseLabel, or an empty string if not found. If phaseIndex is not specified, set phaseLabel to the first entry in the PhaseMap, or an empty string if there are no entries.
INTERFACE:
! Private name; call using NUOPC_CompSetClock() subroutine NUOPC_GridCompSetClock(comp, externalClock, stabilityTimeStep, rc)ARGUMENTS:
type(ESMF_GridComp), intent(inout) :: comp
type(ESMF_Clock), intent(in) :: externalClock
type(ESMF_TimeInterval), intent(in), optional :: stabilityTimeStep
integer, intent(out), optional :: rc
DESCRIPTION:
Set the component internal clock as a copy of externalClock, but with a timeStep that is less than or equal to the stabilityTimeStep. At the same time ensure that the timeStep of the external clock is a multiple of the timeStep of the internal clock. If the stabilityTimeStep argument is not provided then the internal clock will simply be set as a copy of the external clock.
INTERFACE:
! Private name; call using NUOPC_CompSetEntryPoint()
subroutine NUOPC_GridCompSetEntryPoint(comp, methodflag, phaseLabelList, &
userRoutine, rc)
ARGUMENTS:
type(ESMF_GridComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
character(len=*), intent(in) :: phaseLabelList(:)
interface
subroutine userRoutine(gridcomp, importState, exportState, clock, rc)
use ESMF_CompMod
use ESMF_StateMod
use ESMF_ClockMod
implicit none
type(ESMF_GridComp) :: gridcomp ! must not be optional
type(ESMF_State) :: importState ! must not be optional
type(ESMF_State) :: exportState ! must not be optional
type(ESMF_Clock) :: clock ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(out), optional :: rc
DESCRIPTION:
Set an entry point for a GridComp (i.e. Model, Mediator, or Driver). Publish the new entry point in the correct PhaseMap component attribute.
INTERFACE:
! Private name; call using NUOPC_CompSetEntryPoint()
subroutine NUOPC_CplCompSetEntryPoint(comp, methodflag, phaseLabelList, &
userRoutine, rc)
ARGUMENTS:
type(ESMF_CplComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
character(len=*), intent(in) :: phaseLabelList(:)
interface
subroutine userRoutine(cplcomp, importState, exportState, clock, rc)
use ESMF_CompMod
use ESMF_StateMod
use ESMF_ClockMod
implicit none
type(ESMF_CplComp) :: cplcomp ! must not be optional
type(ESMF_State) :: importState ! must not be optional
type(ESMF_State) :: exportState ! must not be optional
type(ESMF_Clock) :: clock ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(out), optional :: rc
DESCRIPTION:
Set an entry point for a CplComp (i.e. Connector). Publish the new entry point in the correct PhaseMap component attribute.
INTERFACE:
! Private name; call using NUOPC_CompSetInternalEntryPoint()
subroutine NUOPC_GridCompSetIntEntryPoint(comp, methodflag, phaseLabelList, &
userRoutine, rc)
ARGUMENTS:
type(ESMF_GridComp) :: comp
type(ESMF_Method_Flag), intent(in) :: methodflag
character(len=*), intent(in) :: phaseLabelList(:)
interface
subroutine userRoutine(gridcomp, importState, exportState, clock, rc)
use ESMF_CompMod
use ESMF_StateMod
use ESMF_ClockMod
implicit none
type(ESMF_GridComp) :: gridcomp ! must not be optional
type(ESMF_State) :: importState ! must not be optional
type(ESMF_State) :: exportState ! must not be optional
type(ESMF_Clock) :: clock ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(out), optional :: rc
DESCRIPTION:
Set an internal entry point for a GridComp (i.e. Driver). Only Drivers currently utilize internal entry points. Internal entry points allow user specialization on the driver level during initialization and run sequencing.
INTERFACE:
! Private name; call using NUOPC_CompSetServices() recursive subroutine NUOPC_GridCompSetServices(comp, sharedObj, userRc, rc)ARGUMENTS:
type(ESMF_GridComp), intent(inout) :: comp
character(len=*), intent(in), optional :: sharedObj
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc
DESCRIPTION:
Try to find a routine called "SetServices" in the sharedObj file and execute the routine. An attempt is made to find a routine that is close in name to "SetServices", allowing for compiler name mangling, i.e. upper and lower case, as well as trailing underscores.
INTERFACE:
! Private name; call using NUOPC_CompSpecialize()
subroutine NUOPC_GridCompSpecialize(comp, specLabel, specPhaseLabel, &
specRoutine, rc)
ARGUMENTS:
type(ESMF_GridComp) :: comp
character(len=*), intent(in) :: specLabel
character(len=*), intent(in), optional :: specPhaseLabel
interface
subroutine specRoutine(gridcomp, rc)
use ESMF
implicit none
type(ESMF_GridComp) :: gridcomp ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(out), optional :: rc
DESCRIPTION:
Specialize a derived GridComp (i.e. Model, Mediator, or Driver). If specPhaseLabel is specified, the specialization only applies to the associated phase. Otherwise the specialization applies to all phases.
INTERFACE:
! Private name; call using NUOPC_CompSpecialize()
subroutine NUOPC_CplCompSpecialize(comp, specLabel, specPhaseLabel, &
specRoutine, rc)
ARGUMENTS:
type(ESMF_CplComp) :: comp
character(len=*), intent(in) :: specLabel
character(len=*), intent(in), optional :: specPhaseLabel
interface
subroutine specRoutine(cplcomp, rc)
use ESMF
implicit none
type(ESMF_CplComp) :: cplcomp ! must not be optional
integer, intent(out) :: rc ! must not be optional
end subroutine
end interface
integer, intent(out), optional :: rc
DESCRIPTION:
Specialize a derived CplComp (i.e. Connector). If specPhaseLabel is specified, the specialization only applies to the associated phase. Otherwise the specialization applies to all phases.
INTERFACE:
subroutine NUOPC_FieldDictionaryAddEntry(standardName, canonicalUnits, rc)ARGUMENTS:
character(*), intent(in) :: standardName
character(*), intent(in) :: canonicalUnits
integer, intent(out), optional :: rc
DESCRIPTION:
Add an entry to the NUOPC Field dictionary. If necessary the dictionary is first set up.
INTERFACE:
subroutine NUOPC_FieldDictionaryEgest(freeFormat, rc)ARGUMENTS:
type(NUOPC_FreeFormat), intent(out) :: freeFormat
integer, intent(out), optional :: rc
DESCRIPTION:
Egest the contents of the NUOPC Field dictionary into a FreeFormat object. It is the caller's responsibility to destroy the created freeFormat object.
INTERFACE:
subroutine NUOPC_FieldDictionaryGetEntry(standardName, canonicalUnits, rc)ARGUMENTS:
character(*), intent(in) :: standardName
character(*), intent(out), optional :: canonicalUnits
integer, intent(out), optional :: rc
DESCRIPTION:
Return the canonical units that the NUOPC Field dictionary associates with the standardName.
INTERFACE:
function NUOPC_FieldDictionaryHasEntry(standardName, rc)RETURN VALUE:
logical :: NUOPC_FieldDictionaryHasEntryARGUMENTS:
character(*), intent(in) :: standardName
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if the NUOPC Field dictionary has an entry with the specified standardName, .false. otherwise.
INTERFACE:
function NUOPC_FieldDictionaryMatchSyno(standardName1, standardName2, rc)RETURN VALUE:
logical :: NUOPC_FieldDictionaryMatchSynoARGUMENTS:
character(*), intent(in) :: standardName1
character(*), intent(in) :: standardName2
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if the NUOPC Field dictionary considers standardName1 and standardName2 synonyms, .false. otherwise. Also, if standardName1 and/or standardName2 do not correspond to an existing dictionary entry, .false. will be returned.
INTERFACE:
subroutine NUOPC_FieldDictionarySetSyno(standardNames, rc)ARGUMENTS:
character(*), intent(in) :: standardNames(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Set all of the elements of the standardNames argument to be considered synonyms by the field dictionary. Every element in standardNames must correspond to the standard name of already existing entries in the field dictionary, or else an error will be returned.
INTERFACE:
subroutine NUOPC_FieldDictionarySetup(rc)ARGUMENTS:
integer, intent(out), optional :: rcDESCRIPTION:
Setup the NUOPC Field dictionary.
INTERFACE:
subroutine NUOPC_FreeFormatAdd(freeFormat, stringList, rc)ARGUMENTS:
type(NUOPC_FreeFormat), intent(inout) :: freeFormat
character(len=*), intent(in) :: stringList(:)
integer, optional, intent(out) :: rc
DESCRIPTION:
Add lines to a FreeFormat object. The capacity of freeFormat may increase during this operation. The elements in stringList are added to the end of freeFormat.
INTERFACE:
! call using generic interface: NUOPC_FreeFormatCreate function NUOPC_FreeFormatCreateDefault(stringList, capacity, rc)RETURN VALUE:
type(NUOPC_FreeFormat) :: NUOPC_FreeFormatCreateDefaultARGUMENTS:
character(len=*), optional, intent(in) :: stringList(:)
integer, optional, intent(in) :: capacity
integer, optional, intent(out) :: rc
DESCRIPTION:
Create a new FreeFormat object. If stringList is provided, then the newly created object will hold the provided strings and the count is that of size(stringList). If capacity is provided, it is used to set the capacity of the newly created FreeFormat object. Providing a capacity that is smaller than size(stringList) triggers an error.
INTERFACE:
! call using generic interface: NUOPC_FreeFormatCreate function NUOPC_FreeFormatCreateRead(config, label, relaxedflag, rc)RETURN VALUE:
type(NUOPC_FreeFormat) :: NUOPC_FreeFormatCreateReadARGUMENTS:
type(ESMF_Config) :: config
character(len=*), intent(in) :: label
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Create a new FreeFormat object from ESMF_Config object. The config object must exist, and label must reference a table attribute within config.
By default an error is returned if label is not found in config. This error can be suppressed by setting relaxedflag=.true., and an empty FreeFormat object will be returned.
INTERFACE:
subroutine NUOPC_FreeFormatDestroy(freeFormat, rc)ARGUMENTS:
type(NUOPC_FreeFormat), intent(inout) :: freeFormat
integer, optional, intent(out) :: rc
DESCRIPTION:
Destroy a FreeFormat object. All internal memory is deallocated.
INTERFACE:
subroutine NUOPC_FreeFormatGet(freeFormat, lineCount, capacity, stringList, rc)ARGUMENTS:
type(NUOPC_FreeFormat), intent(in) :: freeFormat
integer, optional, intent(out) :: lineCount
integer, optional, intent(out) :: capacity
character(len=NUOPC_FreeFormatLen), optional, pointer :: stringList(:)
integer, optional, intent(out) :: rc
DESCRIPTION:
Get information from a FreeFormat object.
INTERFACE:
subroutine NUOPC_FreeFormatGetLine(freeFormat, line, lineString, tokenCount, &
tokenList, rc)
ARGUMENTS:
type(NUOPC_FreeFormat), intent(in) :: freeFormat
integer, intent(in) :: line
character(len=NUOPC_FreeFormatLen), optional, intent(out) :: lineString
integer, optional, intent(out) :: tokenCount
character(len=NUOPC_FreeFormatLen), optional, intent(out) :: tokenList(:)
integer, optional, intent(out) :: rc
DESCRIPTION:
Get information about a specific line in a FreeFormat object.
INTERFACE:
subroutine NUOPC_FreeFormatLog(freeFormat, rc)ARGUMENTS:
type(NUOPC_FreeFormat), intent(in) :: freeFormat
integer, optional, intent(out) :: rc
DESCRIPTION:
Write a FreeFormat object to the default Log.
INTERFACE:
subroutine NUOPC_FreeFormatPrint(freeFormat, rc)ARGUMENTS:
type(NUOPC_FreeFormat), intent(in) :: freeFormat
integer, optional, intent(out) :: rc
DESCRIPTION:
Print a FreeFormat object.
INTERFACE:
subroutine NUOPC_AddNamespace(state, Namespace, nestedStateName, &
nestedState, rc)
ARGUMENTS:
type(ESMF_State), intent(inout) :: state
character(len=*), intent(in) :: Namespace
character(len=*), intent(in), optional :: nestedStateName
type(ESMF_State), intent(out), optional :: nestedState
integer, intent(out), optional :: rc
DESCRIPTION:
Add a Namespace to state. Namespaces are implemented via nested states. This creates a nested state inside of state. The nested state is returned as nestedState. If provided, nestedStateName will be used to name the newly created nested state. The default name of the nested state is equal to Namespace.
The arguments are:
INTERFACE:
subroutine NUOPC_AddNestedState(state, Namespace, CplSet, nestedStateName, &
nestedState, rc)
ARGUMENTS:
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_State), intent(out), optional :: nestedState
integer, intent(out), optional :: rc
DESCRIPTION:
Create a nested state inside of state. The arguments Namespace and tt CplSet are used to set NUOPC attributes on the newly created state. The nested state is returned as nestedState. If provided, nestedStateName will be used to name the newly created nested state. The default name of the nested state is equal to Namespace_CplSet, Namespace, or CplSet if the arguments are provided.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_Advertise
subroutine NUOPC_AdvertiseField(state, StandardName, Units, &
LongName, ShortName, name, TransferOfferField, SharePolicyField, &
TransferOfferGeomObject, SharePolicyGeomObject, rc)
ARGUMENTS:
type(ESMF_State), intent(inout) :: state
character(*), intent(in) :: StandardName
character(*), intent(in), optional :: Units
character(*), intent(in), optional :: LongName
character(*), intent(in), optional :: ShortName
character(*), intent(in), optional :: name
character(*), intent(in), optional :: TransferOfferField
character(*), intent(in), optional :: SharePolicyField
character(*), intent(in), optional :: TransferOfferGeomObject
character(*), intent(in), optional :: SharePolicyGeomObject
integer, intent(out), optional :: rc
DESCRIPTION:
Advertise a field in a state. This creates an empty field and adds it to state. The "StandardName", "Units", "LongName", "ShortName", and "TransferOfferGeomObject" attributes of the field are set according to the provided input..
The call checks the provided information against the NUOPC Field Dictionary to ensure correctness. Defaults are set according to the NUOPC Field Dictionary.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_Advertise
subroutine NUOPC_AdvertiseFields(state, StandardNames, &
TransferOfferField, SharePolicyField, &
TransferOfferGeomObject, SharePolicyGeomObject, rc)
ARGUMENTS:
type(ESMF_State), intent(inout) :: state
character(*), intent(in) :: StandardNames(:)
character(*), intent(in), optional :: TransferOfferField
character(*), intent(in), optional :: SharePolicyField
character(*), intent(in), optional :: TransferOfferGeomObject
character(*), intent(in), optional :: SharePolicyGeomObject
integer, intent(out), optional :: rc
DESCRIPTION:
Advertise a list of fields in a state. This creates a list of empty fields and adds it to the state. The "StandardName", and "TransferOfferGeomObject" attributes of all the fields are set according to the provided input. The "Units", "LongName", and "ShortName" attributes for each field are set according to the defaults documented under method 3.9.3
The call checks the provided information against the NUOPC Field Dictionary to ensure correctness.
The arguments are:
INTERFACE:
subroutine NUOPC_AdjustClock(clock, maxTimestep, rc)ARGUMENTS:
type(ESMF_Clock) :: clock
type(ESMF_TimeInterval), intent(in), optional :: maxTimestep
integer, intent(out), optional :: rc
DESCRIPTION:
Adjust the clock to have a potentially smaller timestep. The timestep on the incoming clock object is compared to the maxTimestep, and reset to the smaller of the two.
The arguments are:
INTERFACE:
subroutine NUOPC_CheckSetClock(setClock, checkClock, setStartTimeToCurrent, rc)ARGUMENTS:
type(ESMF_Clock), intent(inout) :: setClock
type(ESMF_Clock), intent(in) :: checkClock
logical, intent(in), optional :: setStartTimeToCurrent
integer, intent(out), optional :: rc
DESCRIPTION:
Compare setClock to checkClock to ensure they match in their current fime. Further ensure that the timeStep of checkClock is a multiple of the timeStep of setClock. If both conditions are satisfied then the stopTime of the setClock is set one checkClock timeStep ahead of the current time. The direction of the clock is considered.
By default the startTime of the setClock is not modified. However, if setStartTimeToCurrent == .true. the startTime of setClock is set to the currentTime of checkClock.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_GetAttribute subroutine NUOPC_GetAttributeFieldVal(field, name, value, rc)ARGUMENTS:
type(ESMF_Field), intent(in) :: field
character(*), intent(in) :: name
character(*), intent(out) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Access the attribute name inside of field using the convention NUOPC and purpose Instance. Returns with error if the attribute is not present or not set.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_GetAttribute subroutine NUOPC_GetAttributeFieldTK(field, name, typekind, rc)ARGUMENTS:
type(ESMF_Field), intent(in) :: field
character(*), intent(in) :: name
type(ESMF_TypeKind_Flag), intent(out) :: typekind
integer, intent(out), optional :: rc
DESCRIPTION:
Query the typekind of the attribute name inside of field using the convention NUOPC and purpose Instance. Returns with error if the attribute is not present or not set.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_GetAttribute subroutine NUOPC_GetAttributeState(state, name, value, rc)ARGUMENTS:
type(ESMF_State), intent(in) :: state
character(*), intent(in) :: name
character(*), intent(out) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Access the attribute name inside of state using the convention NUOPC and purpose Instance. Returns with error if the attribute is not present or not set.
The arguments are:
INTERFACE:
recursive subroutine NUOPC_GetStateMemberLists(state, StandardNameList, &
ConnectedList, NamespaceList, CplSetList, itemNameList, fieldList, rc)
ARGUMENTS:
type(ESMF_State), intent(in) :: state
character(ESMF_MAXSTR), pointer, optional :: StandardNameList(:)
character(ESMF_MAXSTR), pointer, optional :: ConnectedList(:)
character(ESMF_MAXSTR), pointer, optional :: NamespaceList(:)
character(ESMF_MAXSTR), pointer, optional :: CplSetList(:)
character(ESMF_MAXSTR), pointer, optional :: itemNameList(:)
type(ESMF_Field), pointer, optional :: fieldList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Construct lists containing the StandardNames, field names, and connected status of the fields in state. Return this information in the list arguments. Recursively parse through nested States.
All pointer arguments present must enter this method unassociated. On return, the deallocation of an associated pointer becomes the responsibility of the caller.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_IsAtTime function NUOPC_IsAtTimeField(field, time, rc)RETURN VALUE:
logical :: NUOPC_IsAtTimeFieldARGUMENTS:
type(ESMF_Field), intent(in) :: field
type(ESMF_Time), intent(in) :: time
integer, intent(out), optional :: rc
DESCRIPTION:
Returns .true. if field has a timestamp attribute that matches time. Otherwise returns .false..
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_IsAtTime function NUOPC_IsAtTimeState(state, time, fieldName, count, fieldList, rc)RETURN VALUE:
logical :: NUOPC_IsAtTimeStateARGUMENTS:
type(ESMF_State), intent(in) :: state
type(ESMF_Time), intent(in) :: time
character(*), intent(in), optional :: fieldName
integer, intent(out), optional :: count
type(ESMF_Field), allocatable, intent(out), optional :: fieldList(:)
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if the field(s) in state have a timestamp attribute that matches time. Otherwise return .false..
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_IsConnected function NUOPC_IsConnectedField(field, rc)RETURN VALUE:
logical :: NUOPC_IsConnectedFieldARGUMENTS:
type(ESMF_Field), intent(in) :: field
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if the field is connected. Otherwise return .false..
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_IsConnected function NUOPC_IsConnectedState(state, fieldName, count, rc)RETURN VALUE:
logical :: NUOPC_IsConnectedStateARGUMENTS:
type(ESMF_State), intent(in) :: state
character(*), intent(in), optional :: fieldName
integer, intent(out), optional :: count
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if the field(s) in state are connected. Otherwise return .false..
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_IsUpdated function NUOPC_IsUpdatedField(field, rc)RETURN VALUE:
logical :: NUOPC_IsUpdatedFieldARGUMENTS:
type(ESMF_Field), intent(in) :: field
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if the field has its "Updated" attribute set to "true". Otherwise return .false..
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_IsUpdated function NUOPC_IsUpdatedState(state, fieldName, count, rc)RETURN VALUE:
logical :: NUOPC_IsUpdatedStateARGUMENTS:
type(ESMF_State), intent(in) :: state
character(*), intent(in), optional :: fieldName
integer, intent(out), optional :: count
integer, intent(out), optional :: rc
DESCRIPTION:
Return .true. if the field(s) in state have the "Updated" attribute set to "true". Otherwise return .false..
The arguments are:
INTERFACE:
subroutine NUOPC_NoOp(gcomp, rc)ARGUMENTS:
type(ESMF_GridComp) :: gcomp
integer, intent(out) :: rc
DESCRIPTION:
No-Op method with an interface that matches the requirements for a attachable method for ESMF_GridComp objects.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_Realize
subroutine NUOPC_RealizeCompleteG(state, grid, fieldName, typekind, selection,&
dataFillScheme, rc)
ARGUMENTS:
type(ESMF_State) :: state
type(ESMF_Grid), intent(in) :: grid
character(*), intent(in), optional :: fieldName
type(ESMF_TypeKind_Flag), intent(in), optional :: typekind
character(len=*), intent(in), optional :: selection
character(len=*), intent(in), optional :: dataFillScheme
integer, intent(out), optional :: rc
DESCRIPTION:
Realize or remove fields inside of state according to selection. All of the fields that are realized are created internally on the same grid object, allocating memory for as many field dimensions as there are grid dimensions.
The type and kind of the created fields is according to argument typekind.
Realized fields are filled with data according to the dataFillScheme argument.
The arguments are:
![[*]](crossref.png)
for fill schemes. Default is to leave
the data in realized fields uninitialized.
INTERFACE:
! call using generic interface: NUOPC_Realize
subroutine NUOPC_RealizeCompleteLS(state, locstream, fieldName, typekind, selection,&
dataFillScheme, rc)
ARGUMENTS:
type(ESMF_State) :: state
type(ESMF_LocStream), intent(in) :: locstream
character(*), intent(in), optional :: fieldName
type(ESMF_TypeKind_Flag), intent(in), optional :: typekind
character(len=*), intent(in), optional :: selection
character(len=*), intent(in), optional :: dataFillScheme
integer, intent(out), optional :: rc
DESCRIPTION:
Realize or remove fields inside of state according to selection. All of the fields that are realized are created internally on the same locstream object, allocating memory accordingly.
The type and kind of the created fields is according to argument typekind.
Realized fields are filled with data according to the dataFillScheme argument.
The arguments are:
for fill schemes. Default is to leave
the data in realized fields uninitialized.
INTERFACE:
! call using generic interface: NUOPC_Realize
subroutine NUOPC_RealizeCompleteM(state, mesh, fieldName, typekind, selection,&
dataFillScheme, rc)
ARGUMENTS:
type(ESMF_State) :: state
type(ESMF_Mesh), intent(in) :: mesh
character(*), intent(in), optional :: fieldName
type(ESMF_TypeKind_Flag), intent(in), optional :: typekind
character(len=*), intent(in), optional :: selection
character(len=*), intent(in), optional :: dataFillScheme
integer, intent(out), optional :: rc
DESCRIPTION:
Realize or remove fields inside of state according to selection. All of the fields that are realized are created internally on the same mesh object, allocating memory accordingly.
The type and kind of the created fields is according to argument typekind.
Realized fields are filled with data according to the dataFillScheme argument.
The arguments are:
for fill schemes. Default is to leave
the data in realized fields uninitialized.
INTERFACE:
! call using generic interface: NUOPC_Realize subroutine NUOPC_RealizeField(state, field, rc)ARGUMENTS:
type(ESMF_State), intent(inout) :: state
type(ESMF_Field), intent(in) :: field
integer, intent(out), optional :: rc
DESCRIPTION:
Realize a previously advertised field in state by replacing the advertised field with field of the same name.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_SetAttribute subroutine NUOPC_SetAttributeField(field, name, value, rc)ARGUMENTS:
type(ESMF_Field) :: field
character(*), intent(in) :: name
character(*), intent(in) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Set the attribute name inside of field using the convention NUOPC and purpose Instance.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_SetAttribute subroutine NUOPC_SetAttributeState(state, name, value, rc)ARGUMENTS:
type(ESMF_State) :: state
character(*), intent(in) :: name
character(*), intent(in) :: value
integer, intent(out), optional :: rc
DESCRIPTION:
Set the attribute name inside of state using the convention NUOPC and purpose Instance.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_Write
subroutine NUOPC_SCRIPWrite(factorList, factorIndexList, fileName, &
relaxedflag, rc)
ARGUMENTS:
real(ESMF_KIND_R8), intent(in), target :: factorList(:)
integer, intent(in), target :: factorIndexList(:,:)
character(*), intent(in) :: fileName
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Write the destributed interpolaton matrix provided by factorList and factorIndexList to a SCRIP formatted NetCDF file. Each PET calls with its local list of factors and indices. The call then writes the distributed factors into a single file. If the file already exists, the contents is replaced by this call.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_Write subroutine NUOPC_FactorsWrite(factorList, fileName, rc)ARGUMENTS:
real(ESMF_KIND_R8), pointer :: factorList(:)
character(*), intent(in) :: fileName
integer, intent(out), optional :: rc
DESCRIPTION:
THIS METHOD IS DEPRECATED. Use 3.10.1 instead.
Write the destributed factorList to file. Each PET calls with its local list of factors. The call then writes the distributed factors into a single file. The order of the factors in the file is first by PET, and within each PET the PET-local order is preserved. Changing the number of PETs for the same regrid operation will likely change the order of factors across PETs, and therefore files written will differ.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_Write
subroutine NUOPC_FieldWrite(field, fileName, overwrite, status, timeslice, &
iofmt, relaxedflag, rc)
ARGUMENTS:
type(ESMF_Field), intent(in) :: field
character(*), intent(in) :: fileName
logical, intent(in), optional :: overwrite
type(ESMF_FileStatus_Flag), intent(in), optional :: status
integer, intent(in), optional :: timeslice
type(ESMF_IOFmt_Flag), intent(in), optional :: iofmt
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Write the data in field to file under the field's "StandardName" attribute if supported by the iofmt.
The arguments are:
INTERFACE:
! call using generic interface: NUOPC_Write
subroutine NUOPC_StateWrite(state, fieldNameList, fileNamePrefix, overwrite, &
status, timeslice, relaxedflag, rc)
ARGUMENTS:
type(ESMF_State), intent(in) :: state
character(len=*), intent(in), optional :: fieldNameList(:)
character(len=*), intent(in), optional :: fileNamePrefix
logical, intent(in), optional :: overwrite
type(ESMF_FileStatus_Flag), intent(in), optional :: status
integer, intent(in), optional :: timeslice
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
DESCRIPTION:
Write the data of the fields within a state to NetCDF files. Each field is written to an individual file using the "StandardName" attribute as NetCDF attribute.
The arguments are: