HydroCouple Vocabulary

2.0.0-beta.1 · interface ABI 5 · namespace https://hydrocouple.org/HydroCouple/vocabulary/#

The concepts of the HydroCouple interface standard, generated from its C++ headers (which remain normative). Machine-readable: Turtle · JSON-LD.

Classes

BufferDescriptor

HydroCouple::BufferDescriptor

BufferDescriptor describes a typed, possibly strided, possibly device-resident multi-dimensional array. It is the sole currency of field data exchange.

PropertyRangeMeaning
backendDeviceBackendRuntime owning the device memory when space is Device/Unified.
dataBase address of element (0, 0, ..., 0).
deviceIdxsd:intDevice ordinal within the backend when space is Device/Unified.
itemSizeBytesxsd:longSize of one element; 0 => the kind's natural size (illegal for Opaque).
kindDataKindElement type.
queueOpaque backend stream/queue for asynchronous transfers; nullptr => default stream, synchronous.
rankxsd:intNumber of dimensions; 0 denotes a scalar.
shapexsd:longExtent per dimension; length == rank.
spaceMemorySpaceMemory space holding the bytes.
stridesBytesxsd:longByte step per dimension; nullptr => C-contiguous.

DifferentialEntry

HydroCouple::DifferentialEntry

DifferentialEntry pairs one data item, in one role, with a buffer holding its tangent (forward mode) or cotangent (reverse mode).

PropertyRangeMeaning
itemIComponentDataItemThe item this derivative belongs to.
roleDifferentialRoleWhich side of the step.
valueBufferDescriptorThe tangent or cotangent buffer.

Endpoint

HydroCouple::Distributed::ITransport::Endpoint

Endpoint identifies one participant reachable through this transport.

PropertyRangeMeaning
addressxsd:stringTransport-specific address (empty for rank-addressed transports).
rankxsd:intParticipant rank for rank-addressed transports; -1 otherwise.

ErrorEntry

HydroCouple::ErrorEntry

ErrorEntry is one diagnostic record in a component's error queue.

PropertyRangeMeaning
codexsd:intImplementation-defined error code.
messagexsd:stringHuman-readable description.
severitySeveritySeverity of this record.
sourcexsd:stringId of the originating entity.

IAdaptedOutput

HydroCouple::IAdaptedOutput

An IAdaptedOutput adds one or more data operations on top of an IOutput.

Specializes IOutput.

PropertyRangeMeaning
adaptedOutputFactoryIAdaptedOutputFactoryIAdaptedOutputFactory that generated this IAdaptedOutput.
adapteeIOutputIOutput that this IAdaptedOutput extracts content from. In the adapter design pattern, it is the item being adapted.
argumentsIArgumentIArgument represents input parameters needed for this IAdaptedOutput.
statesIComponentDataItemThe data items that make up the state carried from one refresh() to the next.

IAdaptedOutputFactory

HydroCouple::IAdaptedOutputFactory

IAdaptedOutputFactory is used to create instances of IAdaptedOutput.

Specializes IIdentity.

IAdaptedOutputFactoryComponent

HydroCouple::IAdaptedOutputFactoryComponent

IAdaptedOutputFactoryComponent is an IAdaptedOutputFactory generated from an IAdaptedOutputFactoryComponentInfo.

Specializes IAdaptedOutputFactory.

PropertyRangeMeaning
componentInfoIAdaptedOutputFactoryComponentInfoContains the metadata about this IAdaptedOutputFactoryComponent.

IAdaptedOutputFactoryComponentInfo

HydroCouple::IAdaptedOutputFactoryComponentInfo

IAdaptedOutputFactoryComponentInfo interface class provides information about an IAdaptedOutputFactoryComponent.

Specializes IComponentInfo.

IArgument

HydroCouple::IArgument

IArgument interface class used to set the arguments for components. They can be complex or simple multi-dimensional datasets

Specializes IComponentDataItem.

PropertyRangeMeaning
currentArgumentInputTypeArgumentInputTypeGets the current input type used for this argument.
fileFiltersxsd:stringFile type extensions that can be read by this IArgument.
isOptionalxsd:booleanSpecifies whether the argument is optional or not.
isReadOnlyxsd:booleanWhether the argument's values may be changed (through initialize() or setValuesFrom()).
roleArgumentRoleWhat this argument is to the model.
toStringxsd:stringA human-readable rendering of this argument's current value, for display and logs. serialize() is the round-trippable form.
validComponentDataItemTypesGets the valid IComponentDataItem instance types that can be read by this argument.

ICheckpointableAdaptedOutput

HydroCouple::ICheckpointableAdaptedOutput

ICheckpointableAdaptedOutput is an adapted output that can save and restore the state it carries between refreshes.

Specializes IAdaptedOutput.

ICheckpointableModelComponent

HydroCouple::ICheckpointableModelComponent

ICheckpointableModelComponent is an IModelComponent that can save and restore its complete simulation state.

Specializes IModelComponent.

ICloneableModelComponent

HydroCouple::ICloneableModelComponent

The ICloneableModelComponent class is an IModelComponent that supports deep cloning of itself and its configuration.

Specializes IModelComponent.

PropertyRangeMeaning
clonesICloneableModelComponentThe ICloneableModelComponent instances cloned from this instance that are still alive.
parentICloneableModelComponentParent ICloneableModelComponent object from which current component was cloned from.

IComponentDataItem

HydroCouple::IComponentDataItem

IComponentDataItem is a fundamental unit of data for a component.

Specializes IIdentity.

PropertyRangeMeaning
dataKindDataKindThe element type of this data item's values.
dimensionsIDimensionThe axes of this item's index space, in storage order.
modelComponentIModelComponentGets the owner IModelComponent of this IComponentItem. For an IOutput component item this is the component responsible for providing the content of the IOutput.
shapexsd:longThe extent of each dimension of this data item's index space.
valueDefinitionIValueDefinitionIValueDefinition for this IComponentDataItem defines the variable type associated with this object.

IComponentDataItemValueChanged

HydroCouple::IComponentDataItemValueChanged

IComponentDataItemValueChanged interface class used to notify when the values of a IComponentDataItem change.

PropertyRangeMeaning
componentDataItemIComponentDataItemGets the IComponentDataItem that fired the event.
countxsd:longGets the extent of the hyperslab that changed.
startxsd:longGets the start index of the hyperslab that changed.

IComponentInfo

HydroCouple::IComponentInfo

IComponentInfo interface class is a factory that provides detailed metadata about a component and creates new instances of a component.

Specializes IIdentity.

PropertyRangeMeaning
copyrightxsd:stringComponent copyright info.
developerxsd:stringComponent developer information.
documentationxsd:stringDocumentation associated with this component.
emailxsd:stringComponent developer email.
iconFilePathxsd:stringFile path to Component icon. Must be specified relative to the component library.
libraryFilePathxsd:stringFile path to Component library.
licensexsd:stringComponent license info.
tagsxsd:stringtags used to classify this component.
urlxsd:stringComponent developer url.
versionxsd:stringComponent version info.

IComponentStatusChangeEventArgs

HydroCouple::IComponentStatusChangeEventArgs

The IComponentStatusChangeEventArgs contains the information that will be passed when the IModelComponent fires a signal.

PropertyRangeMeaning
componentIModelComponentGets the IModelComponent that fired the event.
hasProgressMonitorxsd:booleanIndicates whether this event has a progress monitor.
messagexsd:stringGets additional information about the status change.
percentProgressxsd:floatNumber between 0 and 100 indicating the progress made by a component in its simulation.
previousStatusComponentStatusGets the IModelComponent's status before the status change.
statusComponentStatusGets the IModelComponent's status after the status change.

ICrossSection

HydroCouple::Spatial::ICrossSection

The shape of a channel at one place, as a function of stage.

PropertyRangeMeaning
invertElevationxsd:doubleLowest elevation in the section (positive up).
kindCrossSectionKindHow the producer holds this shape.
stationCountxsd:longNumber of survey points, or 0 when the producer holds no points.

ICurve

HydroCouple::Spatial::ICurve

A Curve is a 1-dimensional geometric object usually stored as a sequence of IPoints, with the subtype of ICurve specifying the form of the interpolation between IPoints.

Specializes IGeometry.

PropertyRangeMeaning
endPointIPointThe end IPoint of this ICurve.
isClosedxsd:booleanReturns True if this ICurve is closed[startPoint() = endPoint()].
isRingxsd:booleanand this ICurve is simple(does not pass through the same Point more than once).
lengthxsd:doubleThe length of this ICurve in its associated ISpatialReferenceSystem.
startPointIPointThe start IPoint of this ICurve.

IDateTime

HydroCouple::Temporal::IDateTime

IDateTime interface based on a Julian day

Specializes IPropertyChanged.

PropertyRangeMeaning
julianDayxsd:doubleDate and time as a Julian day value (days since 4713 BC January 1, 12:00 UTC).
modifiedJulianDayxsd:doubleModified Julian day value: julianDay() - 2400000.5 (days since 1858-11-17 00:00 UTC).
serialDatexsd:doubleSerial date number in the MATLAB `datenum` convention: days since 0000-01-00 in the proleptic Gregorian calendar, i.e. julianDay() - 1721058.5. (Excel's 1900 serial differs from this by 693960 days and is not what is meant.)

IDescription

HydroCouple::IDescription

IDescription interface class provides descriptive information on a HydroCouple object.

Specializes IPropertyChanged.

PropertyRangeMeaning
captionxsd:stringGets caption for the entity.
descriptionxsd:stringGets additional descriptive information for the entity.

IDifferentiableAdaptedOutput

HydroCouple::IDifferentiableAdaptedOutput

IDifferentiableAdaptedOutput is an adapted output that can report the derivative of its most recent refresh().

Specializes IAdaptedOutput.

PropertyRangeMeaning
differentiableArgumentsIArgumentThe arguments of this adapter a derivative reaches (may be empty).
differentiableStatesIComponentDataItemThe data items that carry state from one refresh() to the next and that the derivative follows; a subset of states().

IDifferentiableModelComponent

HydroCouple::IDifferentiableModelComponent

IDifferentiableModelComponent is a model component that can report the derivative of its most recent step.

Specializes IModelComponent.

PropertyRangeMeaning
differentiableArgumentsIArgumentThe arguments (parameters) a derivative reaches.
differentiableInputsIInputThe inputs a derivative reaches. Inputs not listed are treated as constant.
differentiableOutputsIOutputThe outputs whose derivative the component can report.
differentiableStatesIComponentDataItemThe data items that make up the state carried from one step to the next.

IDimension

HydroCouple::IDimension

IDimension provides the properties of one axis of a data item's index space.

Specializes IIdentity.

PropertyRangeMeaning
lengthTypeLengthTypeGets the length type of the dimension.
roleDimensionRoleWhat this axis means.

IDistributedModelComponent

HydroCouple::Distributed::IDistributedModelComponent

IDistributedModelComponent is an IModelComponent that participates in distributed execution through a transport.

Specializes IModelComponent.

PropertyRangeMeaning
partitionCountxsd:intThe number of partitions this component's domain is decomposed into.
partitionRankxsd:intThe partition this instance computes.
transportITransportThe transport this component communicates through.

IEdge

HydroCouple::Spatial::IEdge

A directed edge from one vertex to another, adjacent to two faces. Based on Dani Lischinski's code from Graphics Gems IV. Original quad-edge data structure due to Guibas and Stolfi (1985). Does not inherit from geometry to reduce size. since each edge has 4 pointers.

PropertyRangeMeaning
destIVertexThe destination IVertex of this IEdge.
destNextIEdgeThe next ccw edge around (into) the destination of this edge.
destPrevIEdgeThe next cw edge around (into) the destination of this edge.
faceIPolygonThe target face of this edge, if dual. Otherwise null if not dual.
indexxsd:longIndex of this edge in its owning mesh or network (IMeshView::edgeNodes() order).
invRotIEdgeThe dual of this IEdge, directed from its left to its right.
leftIPolygonThe left face of this edge.
leftNextIEdgeThe ccw edge around the left face following this edge.
leftPrevIEdgeThe ccw edge around the left face before this edge.
origIVertexThe origin IVertex of this IEdge.
origNextIEdgeThe next ccw edge around (from) the origin of this IEdge.
origPrevIEdgeThe next cw edge around (from) the origin of this edge.
rightIPolygonThe right face of this edge.
rightNextIEdgeThe edge around the right face ccw following this edge.
rightPrevIEdgeThe IEdge around the right face ccw before this IEdge.
rotIEdgeThe dual of this edge, directed from its right to its left.
symIEdgeThe IEdge from the destination to the origin of this IEdge.

IEnvelope

HydroCouple::Spatial::IEnvelope

IEnvelope represents the minimum bounding box of a geometry.

PropertyRangeMeaning
maxXxsd:doubleThe maximum x-coordinate value for this IEnvelope.
maxYxsd:doubleThe maximum y-coordinate value for this IEnvelope.
maxZxsd:doubleThe maximum z-coordinate value for this IEnvelope.
minXxsd:doubleThe minimum x-coordinate value for this IEnvelope.
minYxsd:doubleThe minimum y-coordinate value for this IEnvelope.
minZxsd:doubleThe minimum z-coordinate value for this IEnvelope.

IExchangeItem

HydroCouple::IExchangeItem

IExchangeItem the base data item the can be exchanged between components at runtime.

Specializes IComponentDataItem.

IExchangeRequest

HydroCouple::Distributed::IExchangeRequest

IExchangeRequest is a handle to an asynchronous communication operation.

IGeometry

HydroCouple::Spatial::IGeometry

IGeometry is the root class of the geometry hierarchy.

PropertyRangeMeaning
boundaryIGeometryReturns the closure of the combinatorial boundary of this geometric object (Reference [1], section 3.12.2).
convexHullIGeometryReturns a geometric object that represents the convex hull of this geometric object.
coordinateDimensionxsd:intGet the dimension of the coordinates in this object.
dimensionxsd:intThe inherent dimension of this geometric object, which must be less than or equal to the coordinate dimension. In non - homogeneous collections, this will return the largest topological dimension of the contained objects.
envelopeIEnvelopeThe minimum bounding box for this Geometry.
geometryTypeGeometryTypeGets the geometry type of this object.
getWKBxsd:unsignedByteExports this geometric object to a specific Well-known byte Representation of Geometry.
getWKTxsd:stringExports this geometric object to a specific Well-known Text Representation of Geometry.
idxsd:stringid of the geometry.
indexxsd:longindex of the geometry if it is part of a collection.
is3Dxsd:booleanReturns true if this geometric object has z coordinate values.
isEmptyxsd:booleanIf true, then this geometric object represents the empty point set ∅ for the coordinate space.
isMeasuredxsd:booleanReturns true if this geometric object has m coordinate values.
isSimplexsd:booleanReturns true if this geometric object has no anomalous geometric points, such as self intersection or self tangency.
spatialReferenceSystemISpatialReferenceSystemSpatial reference system of geometric object.

IGeometryCollection

HydroCouple::Spatial::IGeometryCollection

An IGeometryCollection is a geometric object that is a collection of some number of IGeometry objects.

Specializes IGeometry.

PropertyRangeMeaning
geometryCountxsd:longThe number of geometries in this IGeometryCollection

IGeometryComponentDataItem

HydroCouple::Spatial::IGeometryComponentDataItem

IGeometryComponentDataItem is an IComponentDataItem whose data is associated with a collection of IGeometry objects. This class must be implemented as an abstract class.

Specializes IComponentDataItem.

Canonical dimension ordering: the geometry dimension is dimension 0 of shape() (IDimension::DimensionRole::Entity); any additional dimensions follow.

PropertyRangeMeaning
envelopeIEnvelopeThe IEnvelope bounding all geometries of this data item.
geometryCountxsd:longThe number of geometries associated with this data item.
geometryDimensionIDimensionThe IDimension of the geometries (dimension 0 of shape()).
geometryTypeGeometryTypeThe type of the geometries this data item is associated with.

IIdBasedComponentDataItem

HydroCouple::IIdBasedComponentDataItem

IIdBasedComponentDataItem is an IComponentDataItem whose data is indexed by string identifiers.

Specializes IComponentDataItem.

Canonical dimension ordering: the identifier dimension is dimension 0 of shape(); any additional dimensions follow.

PropertyRangeMeaning
identifierDimensionIDimensionidentifierDimension returns the identifier dimension of the id based component item.
identifiersxsd:stringGets the identifiers associated with this id-based component data item.

IIdentity

HydroCouple::IIdentity

IIdentity interface class defines a method to get the Id of an HydroCouple entity.

Specializes IDescription.

PropertyRangeMeaning
idxsd:stringGets a unique identifier for the entity.

IInput

HydroCouple::IInput

An IInput item that can accept values for an IModelComponent.

Specializes IExchangeItem.

PropertyRangeMeaning
providerIOutputGets the producer this consumer should get its values from.

ILayeredMeshComponentDataItem

HydroCouple::Spatial::ILayeredMeshComponentDataItem

A polyhedral surface whose values are resolved into vertical layers.

Specializes IPolyhedralSurfaceComponentDataItem, ILayering.

ILayeredNetworkComponentDataItem

HydroCouple::Spatial::ILayeredNetworkComponentDataItem

A network carrying a vertical profile, and optionally a channel shape, at each node or edge.

Specializes INetworkComponentDataItem, ILayering.

ILayering

HydroCouple::Spatial::ILayering

Values resolved into vertical layers, whatever the plan geometry.

PropertyRangeMeaning
layerDimensionIDimensionThe IDimension of the layers (IDimension::DimensionRole::Layer).
verticalCoordinateIVerticalCoordinateWhere those layers are.

ILicensedComponent

HydroCouple::ILicensedComponent

ILicensedComponent is an optional side interface for components that require license validation.

ILine

HydroCouple::Spatial::ILine

The ILine class is an ILineString with exactly 2 IPoints.

Specializes ILineString.

ILineString

HydroCouple::Spatial::ILineString

An ILineString is a Curve with linear interpolation between Points. Each consecutive pair of Points defines a Line segment.

Specializes ICurve.

PropertyRangeMeaning
pointCountxsd:longThe number of IPoints in this ILineString.

ILinearRing

HydroCouple::Spatial::ILinearRing

An ILinearRing is an ILineString that is both isClosed() and isSimple().

Specializes ILineString.

IMeshView

HydroCouple::Spatial::IMeshView

IMeshView is a bulk, structure-of-arrays view of an unstructured mesh or network: flat coordinate spans plus CSR (compressed sparse row) connectivity.

PropertyRangeMeaning
edgeCountxsd:longThe number of edges in the mesh.
edgeFacesxsd:longThe two faces of every edge: edge e separates edgeFaces()[2*e] (left, looking from edgeNodes()[2*e] toward edgeNodes()[2*e+1]) from edgeFaces()[2*e+1] (right); -1 marks the outside of the mesh, so a boundary edge has exactly one -1 [edge_face_connectivity].
edgeLengthsxsd:doubleLength of every edge in the reference system's distance units; edgeCount() or empty.
edgeNodesxsd:longNode index pairs of all edges: edge e connects edgeNodes()[2*e] and edgeNodes()[2*e + 1].
edgeNormalXxsd:doublex component of every edge's unit normal, pointing from the left face to the right face as edgeFaces() orders them; edgeCount() or empty.
edgeNormalYxsd:doubley component of every edge's unit normal; edgeCount() or empty.
faceAreasxsd:doublePlan area of every face in the reference system's distance units squared; faceCount() or empty.
faceCountxsd:longThe number of faces (patches/cells) in the mesh; 0 for a pure network.
faceEdgeOffsetsxsd:longCSR row offsets into faceEdges(): the edges of face f are faceEdges()[faceEdgeOffsets()[f] ... faceEdgeOffsets()[f+1]).
faceEdgesxsd:longConcatenated edge indexes of all faces [face_edge_connectivity].
faceNodeOffsetsxsd:longCSR row offsets into faceNodes(): the nodes of face f are faceNodes()[faceNodeOffsets()[f] ... faceNodeOffsets()[f+1]).
faceNodesxsd:longConcatenated node indexes of all faces, ordered counter-clockwise per face.
faceXxsd:doublex coordinate of every face's representative point (centroid or circumcentre, producer's choice) [face_x]; faceCount() or empty.
faceYxsd:doubley coordinate of every face's representative point [face_y]; faceCount() or empty.
nodeCountxsd:longThe number of nodes (vertices) in the mesh.
nodeXxsd:doublex coordinates of all nodes; the span has nodeCount() elements.
nodeYxsd:doubley coordinates of all nodes; the span has nodeCount() elements.
nodeZxsd:doublez coordinates of all nodes; the span has nodeCount() elements, or is empty for a 2D mesh.

IModelComponent

HydroCouple::IModelComponent

IModelComponent interface is the core interface in the HydroCouple standard defining a model component.

Specializes IIdentity.

PropertyRangeMeaning
argumentsIArgumentArguments needed to let the component do its work. An unmodifiable list of (modifiable) arguments must be returned that is to be used to get information about the arguments and to set argument values.
capabilitiesCapabilityThe set of optional capabilities this component supports.
componentInfoIModelComponentInfoContains the metadata about this IModelComponent instance.
inputsIInputThe list of consumer items for which a component can receive values.
outputsIOutputThe list of IOutputs for which a component can produce results.
referenceDirectoryxsd:stringGets the reference directory for this component instance.
resultsIComponentDataItemList of the model's output results
statesIComponentDataItemThe data items that make up the state carried from one update() to the next.
statusComponentStatusDefines current status of the IModelComponent. See IModelComponent::ComponentStatus for the possible values.
workflowIWorkflowComponentGets the workflow that this component is part of.

IModelComponentInfo

HydroCouple::IModelComponentInfo

IModelComponentInfo interface inherits from the IComponentInfo interface which provides detailed metadata about an IModelComponent. Additionally, it creates new instances of a component.

Specializes IComponentInfo.

PropertyRangeMeaning
adaptedOutputFactoriesIAdaptedOutputFactoryGets a list of IAdaptedOutputFactories, each allowing to create IAdaptedOutput item for making outputs fit to inputs in case they do not already do so.

IMultiCurve

HydroCouple::Spatial::IMultiCurve

An IMultiCurve is a 1-dimensional IGeometryCollection whose elements are ICurves.

Specializes IGeometryCollection.

PropertyRangeMeaning
isClosedxsd:booleanclosed[startPoint ( ) = endPoint ( ) for each ICurve in this IMultiCurve].
lengthxsd:doubleThe Length of this IMultiCurve which is equal to the sum of the lengths of the element ICurves.

IMultiInput

HydroCouple::IMultiInput

The IMultiInput class is an IInput class that has multiple outputs supplying data to it.

Specializes IInput.

PropertyRangeMeaning
providerLabelsIIdentityThe roles this multi-input's providers fill (empty when it names none).
providersIOutputGets the list of providers supplying data to this multi-input.

IMultiLineString

HydroCouple::Spatial::IMultiLineString

An IMultiLineString is an IMultiCurve whose elements are ILineStrings.

Specializes IMultiCurve.

IMultiPoint

HydroCouple::Spatial::IMultiPoint

An IMultiPoint is a 0-dimensional IGeometryCollection.

Specializes IGeometryCollection.

IMultiPolygon

HydroCouple::Spatial::IMultiPolygon

An IMultiPolygon is an IMultiSurface whose elements are IPolygons.

Specializes IMultiSurface.

IMultiSurface

HydroCouple::Spatial::IMultiSurface

A MultiSurface is a 2-dimensional GeometryCollection whose elements are Surfaces, all using coordinates from the same coordinate reference system.

Specializes IGeometryCollection.

PropertyRangeMeaning
areaxsd:doubleThe area of this ISurface, as measured in the spatial reference system of this ISurface.
centroidIPointThe mathematical centroid for this ISurface as an IPoint. The result is not guaranteed to be on this ISurface. Newly constructed; owned by the caller.
pointOnSurfaceIPointA Point guaranteed to be on this ISurface. Newly constructed; owned by the caller.

INetwork

HydroCouple::Spatial::INetwork

INetwork represents a graph structure of connected vertices and edges.

Specializes IIdentity.

PropertyRangeMeaning
edgeCountxsd:longThe number of edges in the network.
meshViewIMeshViewBulk structure-of-arrays view of this network's geometry and connectivity.
vertexCountxsd:longThe number of vertices in the network.

INetworkComponentDataItem

HydroCouple::Spatial::INetworkComponentDataItem

INetworkComponentDataItem is an IComponentDataItem whose data is associated with the edges or the nodes of an INetwork.

Specializes IComponentDataItem.

Canonical dimension ordering: the entity dimension selected by location() (Node or Edge; DimensionRole::Entity) is dimension 0 of shape(); a Component dimension follows when networkDataType() is not Scalar; any additional dimensions follow that.

PropertyRangeMeaning
entityDimensionIDimensionThe IDimension of the entities (dimension 0 of shape()).
locationMeshLocationWhich network entity (Node or Edge) this data item's values are attached to.
networkINetworkThe INetwork this data item is associated with.
networkDataTypeSpatialDataTypeThe algebraic structure of the value at each entity (scalar, vector, ...).
vectorBasisVectorBasisThe frame of vector/tensor values; VectorBasis::Unknown is legal only when networkDataType() is Scalar or MultiScalar.

IOutput

HydroCouple::IOutput

An output exchange item that can deliver values from an IModelComponent.

Specializes IExchangeItem.

PropertyRangeMeaning
adaptedOutputsIAdaptedOutputThe adaptedOutputs that have this current output item as adaptee.
consumersIInputInput items that will consume the values by calling the IOutput::updateValues() method.

IPartitionedComponentDataItem

HydroCouple::Distributed::IPartitionedComponentDataItem

IPartitionedComponentDataItem is an IComponentDataItem whose entity dimension is decomposed across partitions, with local virtual (ghost/halo) representation of remotely owned entities.

Specializes IComponentDataItem.

PropertyRangeMeaning
globalCountxsd:longThe global entity count across all partitions.
ownedGlobalIndexesxsd:longGlobal identities of the locally owned entities.
partitionedDimensionxsd:intWhich axis of shape() is decomposed across partitions.
synchronizationEpochxsd:unsignedLongThe synchronization epoch of the virtual entities.
virtualGlobalIndexesxsd:longGlobal identities of the local virtual (ghost/halo) entities.
virtualOwnersxsd:intOwner partition of each virtual entity.

IPoint

HydroCouple::Spatial::IPoint

An IPoint is a 0-dimensional geometric object and represents a single location in coordinate space.

Specializes IGeometry.

PropertyRangeMeaning
mxsd:doubleThe m-coordinate value for this IPoint. Returns NIL otherwise.
xxsd:doubleThe x-coordinate value for this IPoint.
yxsd:doubleThe y-coordinate value for this IPoint.
zxsd:doubleThe z-coordinate value for this IPoint. Returns NIL otherwise.

IPolygon

HydroCouple::Spatial::IPolygon

A IPolygon is a planar ISurface defined by 1 exterior boundary and 0 or more interior boundaries.

Specializes ISurface.

PropertyRangeMeaning
edgeIEdgeAn arbitrary adjacent edge for this IPolygon.
exteriorRingILineStringReturns the exterior ring of this IPolygon.
interiorRingCountxsd:longReturns the number of interior rings in this IPolygon.
polyhedralSurfaceIPolyhedralSurfaceGets the polyhedral surface this polygon belongs to.

IPolyhedralSurface

HydroCouple::Spatial::IPolyhedralSurface

An IPolyhedralSurface is a contiguous collection of polygon patches or facets stitched together along their shared boundary edges.

Specializes ISurface.

PropertyRangeMeaning
isClosedxsd:booleanChecks whether this surface is closed and therefore bounds a solid.
meshViewIMeshViewBulk structure-of-arrays view of this surface's geometry and connectivity.
patchCountxsd:longThe number of polygon patches in this surface.
vertexCountxsd:longThe number of vertices in this surface.

IPolyhedralSurfaceComponentDataItem

HydroCouple::Spatial::IPolyhedralSurfaceComponentDataItem

IPolyhedralSurfaceComponentDataItem is an IComponentDataItem whose data is associated with the faces (patches), edges, or nodes of an IPolyhedralSurface.

Specializes IComponentDataItem.

Canonical dimension ordering: the entity dimension selected by location() (DimensionRole::Entity) is dimension 0 of shape(); a Component dimension follows when meshDataType() is not Scalar; any additional dimensions follow that.

PropertyRangeMeaning
entityDimensionIDimensionThe IDimension of the entities (dimension 0 of shape()).
locationMeshLocationWhich mesh entity (Node, Edge or Face; Volume for a layered item) this data item's values are attached to.
meshDataTypeSpatialDataTypeThe algebraic structure of the value at each entity (scalar, vector, ...).
polyhedralSurfaceIPolyhedralSurfaceThe IPolyhedralSurface this data item is associated with.
vectorBasisVectorBasisThe frame of vector/tensor values; VectorBasis::Unknown is legal only when meshDataType() is Scalar or MultiScalar.

IPropertyChanged

HydroCouple::IPropertyChanged

IPropertyChanged interface is used to emit signal/event when a property of an object changes.

IProxyModelComponent

HydroCouple::Distributed::IProxyModelComponent

The IProxyModelComponent class is a local stand-in for a remote IModelComponent reachable through a transport.

Specializes IDistributedModelComponent.

PropertyRangeMeaning
isConnectedxsd:booleanChecks whether the proxy currently holds a live connection.
remoteEndpointEndpointThe endpoint of the remote component this proxy represents.
remoteIdxsd:stringThe unique identifier of the remote component this proxy represents.
requestTimeoutxsd:doubleThe timeout applied to forwarded requests.

IQuality

HydroCouple::IQuality

IQuality describes qualitative data, where a value is specified as one category within a number of predefined (possible) categories. These categories can be ordered or not.

Specializes IValueDefinition.

PropertyRangeMeaning
categoriesxsd:stringThe possible category labels allowed for this IQuality.
isOrderedxsd:booleanWhether categories() has a defined order (ordinal) or not (nominal).

IQuantity

HydroCouple::IQuantity

IQuantity specifies values as an amount of some unit, usually as a floating point number.

Specializes IValueDefinition.

PropertyRangeMeaning
maxValuexsd:doubleGets the maximum allowed value for this quantity.
minValuexsd:doubleGets the minimum allowed value for this quantity.
unitIUnitUnit of quantity.

IRaster

HydroCouple::Spatial::IRaster

A Raster spatial feature.

Specializes IIdentity.

PropertyRangeMeaning
rasterBandCountxsd:longNumber of raster bands.
spatialReferenceSystemISpatialReferenceSystemThe ISpatialReferenceSystem represents the spatial reference system of this raster.
xSizexsd:longNumber of pixels in the x direction.
ySizexsd:longNumber of pixels in y direction.

IRasterBand

HydroCouple::Spatial::IRasterBand

IRasterBand is a single raster band for an IRaster.

Specializes IIdentity.

PropertyRangeMeaning
dataTypeRasterDataTypeRaster data type
noDataxsd:doubleThe nodata value for this IRasterBand.
rasterIRasterParent IRaster of this IRasterBand
xSizexsd:longNumber of pixels in the x direction
ySizexsd:longNumber of pixels in y direction

IRasterComponentDataItem

HydroCouple::Spatial::IRasterComponentDataItem

IRasterComponentDataItem is an IComponentDataItem whose data is associated with an IRaster.

Specializes IComponentDataItem.

Canonical dimension ordering: band is dimension 0 (DimensionRole::Band), y (row) is dimension 1 (DimensionRole::Row), x (column) is dimension 2 (DimensionRole::Column) of shape().

PropertyRangeMeaning
bandDimensionIDimensionThe IDimension of the raster bands (dimension 0 of shape()).
rasterIRasterThe IRaster this data item is associated with.
xDimensionIDimensionThe IDimension of the raster columns (dimension 2 of shape()).
yDimensionIDimensionThe IDimension of the raster rows (dimension 1 of shape()).

IRegularGrid2D

HydroCouple::Spatial::IRegularGrid2D

IRegularGrid2D represents a two-dimensional structured grid of nodes and cells.

Specializes IIdentity.

PropertyRangeMeaning
activeCellsxsd:unsignedByteBulk activity mask of all cells, row-major [yCell][xCell]; nonzero means active.
gridTypeRegularGridTypeGets the type of regular grid.
nodeXsxsd:doubleBulk x coordinates of all nodes, row-major [yNode][xNode].
nodeYsxsd:doubleBulk y coordinates of all nodes, row-major [yNode][xNode].
numXNodesxsd:longnumXNodes represents the number of nodes in the x direction.
numYNodesxsd:longnumYNodes represents the number of nodes in the y direction.
spatialReferenceSystemISpatialReferenceSystemThe ISpatialReferenceSystem represents the spatial reference system of this geometric object.

IRegularGrid2DComponentDataItem

HydroCouple::Spatial::IRegularGrid2DComponentDataItem

IRegularGrid2DComponentDataItem is an IComponentDataItem whose data is associated with the cells of an IRegularGrid2D.

Specializes IComponentDataItem.

Canonical dimension ordering: y-cell is dimension 0 (DimensionRole::Row), x-cell is dimension 1 (DimensionRole::Column) of shape(); the optional cell edge and cell vertex dimensions (DimensionRole::Other) follow.

PropertyRangeMeaning
cellEdgeDimensionIDimensionThe IDimension of the edges of a cell, when values are attached to cell edges.
cellVertexDimensionIDimensionThe IDimension of the vertices of a cell, when values are attached to cell vertices.
gridIRegularGrid2DThe IRegularGrid2D this data item is associated with.
locationMeshLocationWhich grid entity the values are attached to: Face for cells, Edge for cell edges, Node for cell vertices.
xCellDimensionIDimensionThe IDimension of the cells in the x direction (dimension 1 of shape()).
yCellDimensionIDimensionThe IDimension of the cells in the y direction (dimension 0 of shape()).

IRegularGrid3D

HydroCouple::Spatial::IRegularGrid3D

IRegularGrid3D represents a three-dimensional structured grid of nodes and cells.

Specializes IIdentity.

PropertyRangeMeaning
activeCellsxsd:unsignedByteBulk activity mask of all cells, row-major [zCell][yCell][xCell]; nonzero means active.
gridTypeRegularGridTypeGets the type of regular grid.
nodeXsxsd:doubleBulk x coordinates of all nodes in a horizontal layer, row-major [yNode][xNode].
nodeYsxsd:doubleBulk y coordinates of all nodes in a horizontal layer, row-major [yNode][xNode].
nodeZsxsd:doubleBulk z coordinates of all nodes, row-major [zNode][yNode][xNode].
numXNodesxsd:longnumXNodes represents the number of nodes in the x direction.
numYNodesxsd:longnumYNodes represents the number of nodes in the y direction.
numZNodesxsd:longnumZNodes represents the number of nodes in the z direction.
spatialReferenceSystemISpatialReferenceSystemThe ISpatialReferenceSystem represents the spatial reference system of this grid.

IRegularGrid3DComponentDataItem

HydroCouple::Spatial::IRegularGrid3DComponentDataItem

IRegularGrid3DComponentDataItem is an IComponentDataItem whose data is associated with the cells of an IRegularGrid3D.

Specializes IComponentDataItem.

Canonical dimension ordering: z-cell is dimension 0 (DimensionRole::Depth), y-cell is dimension 1 (DimensionRole::Row), x-cell is dimension 2 (DimensionRole::Column) of shape(); the optional cell face and cell vertex dimensions (DimensionRole::Other) follow.

PropertyRangeMeaning
cellFaceDimensionIDimensionThe IDimension of the faces of a cell, when values are attached to cell faces.
cellVertexDimensionIDimensionThe IDimension of the vertices of a cell, when values are attached to cell vertices.
gridIRegularGrid3DThe IRegularGrid3D this data item is associated with.
locationMeshLocationWhich grid entity the values are attached to: Volume for cells, Face for cell faces, Node for cell vertices.
xCellDimensionIDimensionThe IDimension of the cells in the x direction (dimension 2 of shape()).
yCellDimensionIDimensionThe IDimension of the cells in the y direction (dimension 1 of shape()).
zCellDimensionIDimensionThe IDimension of the cells in the z direction (dimension 0 of shape()).

ISpatialReferenceSystem

HydroCouple::Spatial::ISpatialReferenceSystem

ISpatialReferenceSystem describes the coordinate reference system for spatial geometric objects.

PropertyRangeMeaning
authNamexsd:stringThe Authority Specific Spatial Reference System Identifier.
authSRIDxsd:intReturns the Spatial Reference System ID (SRID) for a geometric object. This will normally be a foreign key to an index of reference systems stored in either the same or some other datastore.
distanceUnitsDistanceUnitsThe measurement distance units for the horizontal axes of the Spatial Reference System.
srTextxsd:stringWell-known Text description of the Spatial Reference System.
verticalAuthNamexsd:stringAuthority of the vertical reference system (e.g. "EPSG"), or empty if undeclared.
verticalAuthSRIDxsd:intThe authority's identifier of the vertical reference system (e.g. 5703 for NAVD88 height), or 0 if undeclared.
verticalDistanceUnitsDistanceUnitsThe measurement distance units of the vertical axis.
verticalSrTextxsd:stringWell-known Text of the vertical reference system, or empty if undeclared.

ISurface

HydroCouple::Spatial::ISurface

A ISurface is a 2-dimensional IGeometry object.

Specializes IGeometry.

PropertyRangeMeaning
areaxsd:doubleThe area of this ISurface, as measured in the spatial reference system of this ISurface.
boundaryMultiCurveIMultiCurveGets the boundary of this surface as a multi-curve.
centroidIPointThe mathematical centroid for this ISurface as a Point. The result is not guaranteed to be on this ISurface. Newly constructed; owned by the caller.
pointOnSurfaceIPointA Point guaranteed to be on this Surface. Newly constructed; owned by the caller.

ITIN

HydroCouple::Spatial::ITIN

An ITIN is a triangulated irregular network IPolyhedralSurface consisting only of ITriangle patches.

Specializes IPolyhedralSurface.

ITINComponentDataItem

HydroCouple::Spatial::ITINComponentDataItem

ITINComponentDataItem is an IPolyhedralSurfaceComponentDataItem whose surface is an ITIN.

Specializes IPolyhedralSurfaceComponentDataItem.

PropertyRangeMeaning
TINITINThe ITIN this data item is associated with.

ITimeGeometryComponentDataItem

HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem

ITimeGeometryComponentDataItem is a geometry component data item whose values also vary in time.

Specializes ITimeSeriesComponentDataItem, IGeometryComponentDataItem.

Canonical dimension ordering: time is dimension 0, the geometry dimension is dimension 1 of shape(); any additional dimensions follow.

ITimeIdBasedComponentDataItem

HydroCouple::Temporal::ITimeIdBasedComponentDataItem

ITimeIdBasedComponentDataItem is an IComponentDataItem with both temporal and identifier-based dimensions for accessing multi-dimensional time-series data.

Specializes ITimeSeriesComponentDataItem.

Canonical dimension ordering: time is dimension 0 (DimensionRole::Time), the identifier dimension is dimension 1 (DimensionRole::Entity); any additional dimensions follow.

PropertyRangeMeaning
identifierDimensionIDimensionidentifierDimension associated with this data item.
identifiersxsd:stringidentifiers associated with the identifier dimension.

ITimeLayeredMeshComponentDataItem

HydroCouple::SpatioTemporal::ITimeLayeredMeshComponentDataItem

A layered mesh item whose values also vary in time.

Specializes ITimeSeriesPolyhedralSurfaceComponentDataItem, ILayeredMeshComponentDataItem.

Canonical dimension ordering: time is dimension 0, the entity (face or volume) dimension is dimension 1, the layer dimension is dimension 2 of shape(); a Component dimension follows when meshDataType() is not Scalar.

ITimeLayeredNetworkComponentDataItem

HydroCouple::SpatioTemporal::ITimeLayeredNetworkComponentDataItem

A layered network item whose values also vary in time.

Specializes ITimeNetworkComponentDataItem, ILayeredNetworkComponentDataItem.

Canonical dimension ordering: time is dimension 0, the entity (node or edge) dimension is dimension 1, the layer dimension is dimension 2 of shape(); a Component dimension follows when networkDataType() is not Scalar.

ITimeModelComponent

HydroCouple::Temporal::ITimeModelComponent

ITimeModelComponent is an IModelComponent that advances through time during simulation and provides access to the current simulation time.

Specializes IModelComponent.

PropertyRangeMeaning
currentDateTimeIDateTimeGets the current date and time of the model simulation.
nextDateTimeJulianDayxsd:doubleThe time (Julian day) the next update() will advance currentDateTime() to.
simulationPeriodITimeSpansimulationPeriod of the model.

ITimeNetworkComponentDataItem

HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem

ITimeNetworkComponentDataItem is a network component data item whose values also vary in time.

Specializes ITimeSeriesComponentDataItem, INetworkComponentDataItem.

Canonical dimension ordering: time is dimension 0, the entity dimension selected by location() is dimension 1 of shape(); a Component dimension follows when networkDataType() is not Scalar.

ITimeRegularGrid2DComponentDataItem

HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem

ITimeRegularGrid2DComponentDataItem is a 2D regular grid component data item whose values also vary in time.

Specializes ITimeSeriesComponentDataItem, IRegularGrid2DComponentDataItem.

Canonical dimension ordering: time is dimension 0, y-cell is dimension 1, x-cell is dimension 2 of shape(); the optional cell edge and cell vertex dimensions follow.

ITimeRegularGrid3DComponentDataItem

HydroCouple::SpatioTemporal::ITimeRegularGrid3DComponentDataItem

ITimeRegularGrid3DComponentDataItem is a 3D regular grid component data item whose values also vary in time.

Specializes ITimeSeriesComponentDataItem, IRegularGrid3DComponentDataItem.

Canonical dimension ordering: time is dimension 0, z-cell is dimension 1, y-cell is dimension 2, x-cell is dimension 3 of shape(); the optional cell face and cell vertex dimensions follow.

ITimeSeriesComponentDataItem

HydroCouple::Temporal::ITimeSeriesComponentDataItem

ITimeSeriesComponentDataItem is an IComponentItem with a temporal attribute.

Specializes IComponentDataItem.

Canonical dimension ordering: the time dimension is dimension 0 of shape() and reports IDimension::DimensionRole::Time; any additional dimensions follow.

PropertyRangeMeaning
intervalLengthxsd:doubleLength of the averaging or accumulation interval (days).
timeCountxsd:longGets the number of times.
timeDimensionIDimensionGets the IDimension of the times.
timeExtrapolationTimeExtrapolationWhat this item does — or, for an input, accepts — outside its held range.
timeInterpolationTimeInterpolationWhat this item does — or, for an input, accepts — between held instants.
timeKindTimeKindWhat each value's time coordinate refers to.
timeSpanITimeSpanGets the ITimeSpan associated with this data item.
timesxsd:doubleBulk access to all time coordinates as Julian day values.

ITimeSeriesPolyhedralSurfaceComponentDataItem

HydroCouple::SpatioTemporal::ITimeSeriesPolyhedralSurfaceComponentDataItem

ITimeSeriesPolyhedralSurfaceComponentDataItem is a polyhedral surface component data item whose values also vary in time.

Specializes ITimeSeriesComponentDataItem, IPolyhedralSurfaceComponentDataItem.

Canonical dimension ordering: time is dimension 0, the entity dimension selected by location() is dimension 1 of shape(); a Component dimension follows when meshDataType() is not Scalar.

ITimeSeriesRasterComponentDataItem

HydroCouple::SpatioTemporal::ITimeSeriesRasterComponentDataItem

ITimeSeriesRasterComponentDataItem is a raster component data item whose values also vary in time.

Specializes ITimeSeriesComponentDataItem, IRasterComponentDataItem.

Canonical dimension ordering: time is dimension 0, band is dimension 1, y (row) is dimension 2, and x (column) is dimension 3 of shape().

ITimeSeriesTINComponentDataItem

HydroCouple::SpatioTemporal::ITimeSeriesTINComponentDataItem

ITimeSeriesTINComponentDataItem is an ITimeSeriesPolyhedralSurfaceComponentDataItem whose surface is an ITIN.

Specializes ITimeSeriesPolyhedralSurfaceComponentDataItem.

PropertyRangeMeaning
TINITINThe ITIN this data item is associated with.

ITimeSpan

HydroCouple::Temporal::ITimeSpan

ITimeSpan specifies an interval of time.

Specializes IDateTime.

PropertyRangeMeaning
durationxsd:doubleDuration of the timespan in days; non-negative.
endJulianDayxsd:doubleEnd of the interval as a Julian day: julianDay() + duration().

ITransport

HydroCouple::Distributed::ITransport

ITransport is a transport-neutral, tagged message channel between processes.

Specializes IIdentity.

PropertyRangeMeaning
localEndpointEndpointThe endpoint of the calling process on this transport.
participantCountxsd:intThe number of participants reachable through this transport.

ITriangle

HydroCouple::Spatial::ITriangle

An ITriangle is a IPolygon with 3 distinct, non-collinear vertices and no interior boundary.

Specializes IPolygon.

PropertyRangeMeaning
vertex1IVertexThe first vertex of this ITriangle.
vertex2IVertexThe second vertex of this ITriangle.
vertex3IVertexThe third vertex of this ITriangle.

IUIProvider

HydroCouple::IUIProvider

IUIProvider is an optional side interface for entities that can present a graphical editor and/or viewer.

PropertyRangeMeaning
hasEditorxsd:booleanhasEditor indicates whether this entity has a UI editor.
hasViewerxsd:booleanhasViewer indicates whether this entity has a UI viewer.

IUnit

HydroCouple::IUnit

IUnit interface, describing the physical unit of a IQuantity.

Specializes IDescription.

PropertyRangeMeaning
conversionFactorToSIxsd:doubleConversion factor to SI ('A' in: SI-value = A * quant-value + B)
dimensionsIUnitDimensionsFundamental dimensions of the unit.
offsetToSIxsd:doubleOffSet to SI ('B' in: SI-value = A * quant-value + B).
symbolxsd:stringThe unit as a UDUNITS-2 string, e.g. "m3 s-1" or "ft3/s".
ucumCodexsd:stringThe unit as a case-sensitive UCUM code, e.g. "m3/s" or "[ft_i]3/s".

IUnitDimensions

HydroCouple::IUnitDimensions

Defines the order of dimension in each FundamentalDimension for a unit.

Specializes IDescription.

IValueDefinition

HydroCouple::IValueDefinition

IValueDefinition describes the type and properties of values held by an IComponentDataItem.

Specializes IDescription.

PropertyRangeMeaning
conceptURIxsd:stringAn absolute URI naming the quantity in a published vocabulary.
defaultValuexsd:doubleGets the default value for this value definition.
missingValuexsd:doubleThe value representing that data is missing.
standardNamexsd:stringThe CF standard name of the quantity these values measure.
valueKindValueKindHow values of this definition behave under regridding and aggregation.

IVertex

HydroCouple::Spatial::IVertex

The IVertex class is an IPoint of a topologically aware IGeometry

Specializes IPoint.

PropertyRangeMeaning
edgeIEdgeAn arbitrary outgoing IEdge from this vertex.

IVerticalCoordinate

HydroCouple::Spatial::IVerticalCoordinate

Where the layers of a layered or volumetric data item actually are.

PropertyRangeMeaning
columnCountxsd:longNumber of columns (plan entities) this coordinate describes.
geometryEpochxsd:unsignedLongCounter incremented every time the elevations change.
interfaceElevationsxsd:doubleAll interface elevations of all columns, row-major [column][interface], top interface first within a column.
isTimeVaryingxsd:booleanWhether interface elevations change from step to step.
kindVerticalCoordinateKindThe coordinate family.
layerCountxsd:longNumber of layers in a column.

IWorkflowComponent

HydroCouple::IWorkflowComponent

IWorkflowComponent manages the execution workflow for a set of coupled IModelComponent instances.

Specializes IIdentity.

PropertyRangeMeaning
componentInfoIWorkflowComponentInfoGets the metadata information about this workflow component.
modelComponentLabelsIIdentityrequiredModelComponentIdentifiers returns the vector of IModelComponent identifiers that are required by this component.
modelComponentsIModelComponentGets the model components managed by this workflow.
statusWorkflowStatusGets the current status of the workflow component.

IWorkflowComponentInfo

HydroCouple::IWorkflowComponentInfo

IWorkflowComponentInfo provides metadata about an IWorkflowComponent and creates new instances of it.

Specializes IComponentInfo.

IWorkflowComponentStatusChangeEventArgs

HydroCouple::IWorkflowComponentStatusChangeEventArgs

The IWorkflowComponentStatusChangeEventArgs contains the information that will be passed when the IWorkflowComponent fires a signal.

PropertyRangeMeaning
hasProgressMonitorxsd:booleanIndicates whether this event has a progress monitor.
messagexsd:stringGets additional information about the status change.
percentProgressxsd:floatNumber between 0 and 100 indicating the progress made by the workflow component.
previousStatusWorkflowStatusGets the IWorkflowComponent's status before the status change.
statusWorkflowStatusGets the IWorkflowComponent's status after the status change.
workflowComponentIWorkflowComponentGets the IWorkflowComponent that fired the event.

Enumerations

ArgumentInputType

HydroCouple::IArgument::ArgumentInputType

Enumeration indicating the type of input for the argument.

ValueConceptMeaning
0StringEnumeration indicating that the argument was read from string.
1FileEnumeration indicating that the argument was read from a file.
2JSONEnumeration indicating that the argument input is in JSON format.
3YAMLEnumeration indicating that the argument input is in YAML format.
4XMLEnumeration indicating that the argument input is in XML format.
5URLEnumeration indicating that the argument was read from a URL.
6MEMORY_OBJECTEnumeration indicating that the argument was read from a memory object.

ArgumentRole

HydroCouple::IArgument::ArgumentRole

What kind of thing an argument is to the model that owns it.

ValueConceptMeaning
0ConfigurationHow the model runs: paths, options, solver settings, output selection.
1ParameterA coefficient of the process equations (roughness, conductivity, rate constants).
2InitialConditionThe state at the start of the simulation.
3ForcingA prescribed time-varying input that is not supplied through an IInput (a boundary time series read from file).
4GeometryThe spatial discretization itself (a mesh, a network, a raster grid).

ByteOrder

HydroCouple::ByteOrder

The ByteOrder enum class indicates the byte order of serialized data.

ValueConceptMeaning
0BigEndianBigEndian serialized data byte order (most significant byte first).
1LittleEndianLittleEndian serialized data byte order (least significant byte first).

Capability

HydroCouple::Capability

Capability identifies an optional behavior a component may support.

ValueConceptMeaning
0DeviceBuffersData items can produce/accept Device/Unified BufferDescriptors.
1PartitionedDataComponent exposes IPartitionedComponentDataItem items (see hydrocoupledistributed.h).
2DistributedExecutionComponent implements IDistributedModelComponent.
3CheckpointingComponent implements ICheckpointableModelComponent.
4CloneableComponent implements ICloneableModelComponent.
5UserInterfaceComponent implements IUIProvider.
6LicensingComponent implements ILicensedComponent.
7DifferentiableComponent implements IDifferentiableModelComponent.
8LayeredDataComponent exposes data items implementing Spatial::ILayering.
2147483648VendorBaseFirst value of the vendor-reserved range (0x80000000).

ComponentStatus

HydroCouple::IModelComponent::ComponentStatus

HydroCouple::ComponentStatus is an enumerator that describes the status of a component over the course of its lifetime.

ValueConceptMeaningMay become
0CreatedThe IModelComponent instance has just been created. This status must and will be followed by HydroCouple::Initializing.Initializing, Failed
1InitializingThe IModelComponent is initializing itself. This status will end in a status change to HydroCouple::Initialized or HydroCouple::Failed.Initialized, Failed
2InitializedThe IModelComponent has successfully initialized itself by calling IModelComponent::initialize(). The connections between its inputs/outputs and those of other components can be established.Initializing, Validating, Finishing, Failed
3ValidatingAfter links between an IModelComponent's inputs/outputs and those of other components have been established, the IModelComponent is HydroCouple::Validating whether its required input will be available when it updates itself, and whether indeed it will be able to provide the required output during this update. This Validating status will when the IModelComponent::status() changes to HydroCouple::Valid or HydroCouple::Invalid.Valid, Invalid, Failed
4ValidThe IModelComponent is in a HydroCouple::Valid state. When updating itself its required input will be available, and it will be able to provide the required output.Validating, Preparing, Finishing, Failed
5WaitingForDataThe IModelComponent wants to update itself, but is not yet able to perform the actual computation, because it is still waiting for input data from other components.Updating, Failed
6InvalidThe IModelComponent is in an HydroCouple::Invalid state. When updating itself not all required input will be available, and/or it will not be able to provide the required output. After the user has modified the connections between the IModelComponent's inputs/outputs and those of other components, the HydroCouple::Validating state can be entered againValidating, Finishing, Failed
7PreparingThe IModelComponent is preparing itself for the first update() and the first IComponentDataItem::getValuesInto() call. This HydroCouple::Preparing state will end in a status change to HydroCouple::Updated or HydroCouple::Failed.Updated, Failed
8UpdatingThe IModelComponent is updating itself. It has received all required input data from other components, and is now performing the actual computation. This HydroCouple::Updating state will end in a status change to HydroCouple::Updated, HydroCouple::Done or HydroCouple::Failed.WaitingForData, Updated, Done, Failed
9UpdatedThe IModelComponent has successfully updated itself.Updating, Checkpointing, Finishing, Failed
10CheckpointingThe IModelComponent is saving or restoring a checkpoint of its state (see ICheckpointableModelComponent). A save returns to the status it was entered from (HydroCouple::Updated or HydroCouple::Done); a successful restore always lands in HydroCouple::Updated; a failure lands in HydroCouple::Failed.Updated, Done, Failed
11DoneThe last update process that the IModelComponent performed was the final one. A next call to the IModelComponent::update() method will leave the IModelComponent's internal state unchanged.Checkpointing, Finishing, Failed
12FinishingThe IModelComponent was requested to perform the actions to be performed before it will either be disposed or re-initialized again.Typical actions would be writing the final result files, close all open files, free memory, etc. When all required actions have been performed, the status switches to HydroCouple::Created when re-initialization is possible. The status switches to HydroCouple::Finished when the IModelComponent is to be disposedCreated, Finished, Failed
13FinishedThe IModelComponent has successfully performed its finalization actions. Re-initialization of the IModelComponent instance is not possible and should not be attempted. Instead the instance should be destroyed by its owner, after its connections are dismantled (see the lifetime convention).
14FailedThe IModelComponent has encountered an unrecoverable error. Reachable from every status except Finished: a failure can be detected while the component rests (a proxy whose peer dies while it is Updated). Diagnostics describing the failure must be available from IModelComponent::errors(). From this state the component may be re-initialized by calling initialize() if it supports re-initialization, or finished and disposed via finish().Initializing, Finishing

CrossSectionKind

HydroCouple::Spatial::CrossSectionKind

How a cross-section's shape is held by whoever produced it.

ValueConceptMeaning
0UnknownNot declared. Consumers must not assume.
1StationElevationSurveyed points across the section (HEC-RAS, SWMM).
2WidthElevationWidth as a function of elevation (CE-QUAL-W2).
3AnalyticA closed form: circular, trapezoidal, and the rest.

DataKind

HydroCouple::DataKind

DataKind identifies the element type of a typed data buffer.

ValueConceptMeaning
0UnknownNo/unknown element type.
1Int8int8_t
2UInt8uint8_t
3Int16int16_t
4UInt16uint16_t
5Int32int32_t
6UInt32uint32_t
7Int64int64_t
8UInt64uint64_t
9Float32float
10Float64double
11Booleanbool (stored one element per byte)
12Stringstd::string (host memory only)
13OpaqueImplementation-defined bytes; meaning agreed out of band, size in BufferDescriptor::itemSizeBytes.

DeviceBackend

HydroCouple::DeviceBackend

DeviceBackend identifies the runtime that owns a device-resident buffer.

ValueConceptMeaning
0NoneHost memory; no device runtime involved.
1CUDANVIDIA CUDA runtime.
2HIPAMD HIP/ROCm runtime.
3SYCLSYCL (any implementation).
4LevelZeroIntel oneAPI Level Zero.
5OpenCLOpenCL.
6OtherAn implementation-defined runtime both endpoints agree on.

DifferentialRole

HydroCouple::DifferentialRole

DifferentialRole says which side of a component's step a derivative buffer belongs to.

ValueConceptMeaning
0InputAn IInput of the component, as consumed by the step.
1ArgumentAn IArgument of the component (a parameter of the step).
2OutputAn IOutput of the component, as produced by the step.
3StateBeforeA state item's value at the start of the step.
4StateAfterThe same state item's value at the end of the step.

DimensionRole

HydroCouple::IDimension::DimensionRole

What an axis of the index space means.

ValueConceptMeaning
0UnknownNot declared.
1TimeTime steps (Temporal::ITimeSeriesComponentDataItem::times()).
2EntitySpatial entities: geometries, mesh nodes/edges/faces, network nodes/edges, or the identifiers of an id-based item.
3LayerVertical layers (Spatial::ILayering), top first.
4BandRaster bands.
5RowRaster rows / structured-grid y index.
6ColumnRaster columns / structured-grid x index.
7DepthStructured-grid z index (IRegularGrid3D).
8ComponentVector or tensor components (Spatial::SpatialDataType).
9RealizationEnsemble members.
10OtherDeclared but none of the above.

DistanceUnits

HydroCouple::IUnit::DistanceUnits

HydroCouple::DistanceUnits are the types of units that can be used to measure distance.

ValueConceptMeaning
0MetersMeters
1KilometersKilometers
2FeetFeet
3NauticalMilesNauticalMiles
4YardsYards
5MilesMiles
6DegreesDegrees (angular; only meaningful for geographic reference systems).
7CentimetersCentimeters
8MillimetersMillimeters
9InchesInches
10UnknownUnknown

FundamentalUnitDimension

HydroCouple::IUnitDimensions::FundamentalUnitDimension

HydroCouple::FundamentalUnitDimension are the fundamental units that can be combined to form all types of units.

ValueConceptMeaning
0LengthFundamental dimension for length.
1MassFundamental dimension for mass.
2TimeFundamental dimension for time.
3ElectricCurrentFundamental dimension for electric current.
4TemperatureFundamental dimension for temperature.
5AmountOfSubstanceFundamental dimension for amount of substance.
6LuminousIntensityFundamental dimension for luminous intensity.
7CurrencyFundamental dimension for currency.
8UnitlessFundamental dimension for unitless quantities (all powers zero).
9PlaneAngleFundamental dimension for plane angle (radian).

GeometryType

HydroCouple::Spatial::IGeometry::GeometryType

The type of IGeometry.

ValueConceptMeaning
0Geometry
1Point
2LineString
3Polygon
17Triangle
4MultiPoint
5MultiLineString
6MultiPolygon
7GeometryCollection
8CircularString
9CompoundCurve
10CurvePolygon
11MultiCurve
12MultiSurface
13Curve
14Surface
15PolyhedralSurface
16TIN
1000GeometryZ
1001PointZ
1002LineStringZ
1003PolygonZ
1017TriangleZ
1004MultiPointZ
1005MultiLineStringZ
1006MultiPolygonZ
1007GeometryCollectionZ
1008CircularStringZ
1009CompoundCurveZ
1010CurvePolygonZ
1011MultiCurveZ
1012MultiSurfaceZ
1013CurveZ
1014SurfaceZ
1015PolyhedralSurfaceZ
1016TINZ
2000GeometryM
2001PointM
2002LineStringM
2003PolygonM
2017TriangleM
2004MultiPointM
2005MultiLineStringM
2006MultiPolygonM
2007GeometryCollectionM
2008CircularStringM
2009CompoundCurveM
2010CurvePolygonM
2011MultiCurveM
2012MultiSurfaceM
2013CurveM
2014SurfaceM
2015PolyhedralSurfaceM
2016TINM
3000GeometryZM
3001PointZM
3002LineStringZM
3003PolygonZM
3017TriangleZM
3004MultiPointZM
3005MultiLineStringZM
3006MultiPolygonZM
3007GeometryCollectionZM
3008CircularStringZM
3009CompoundCurveZM
3010CurvePolygonZM
3011MultiCurveZM
3012MultiSurfaceZM
3013CurveZM
3014SurfaceZM
3015PolyhedralSurfaceZM
3016TINZM

LengthType

HydroCouple::IDimension::LengthType

IDimension::LengthType dimension length type

ValueConceptMeaning
0StaticStatic length type
1DynamicDynamic length type

MemorySpace

HydroCouple::MemorySpace

MemorySpace identifies where a buffer's bytes physically live.

ValueConceptMeaning
0HostOrdinary pageable host memory.
1HostPinnedPage-locked host memory (fast staging to/from devices).
2DeviceAccelerator-resident memory addressed by (backend, deviceId).
3UnifiedUnified/managed memory accessible from host and device.

MeshLocation

HydroCouple::Spatial::MeshLocation

Which mesh or network entity a data item's values are attached to.

ValueConceptMeaning
0NodeMesh nodes / network nodes (vertices).
1EdgeMesh edges / network edges (links, conduits, reaches).
2FaceMesh faces: the patches of a polyhedral surface, the triangles of a TIN.
3VolumeExtruded cells of a layered mesh (Spatial::ILayering).

RasterDataType

HydroCouple::Spatial::IRaster::RasterDataType

The data type associated with a raster band.

ValueConceptMeaning
0UnknownUnknown or unspecified type
1ByteEight bit unsigned integer
2UInt16Sixteen bit unsigned integer
3Int16Sixteen bit signed integer
4UInt32Thirty two bit unsigned integer
5Int32Thirty two bit signed integer
6Float32Thirty two bit floating point
7Float64Sixty four bit floating point
8CInt16Complex Int16
9CInt32Complex Int32
10CFloat32Complex Float32
11CFloat64Complex Float64
12ARGB32Colour: alpha, red, green, blue, one byte each, most significant byte first.
13ARGB32_PremultipliedColour as ARGB32 with red, green and blue premultiplied by alpha.

RegularGridType

HydroCouple::Spatial::RegularGridType

The types of regular grids.

ValueConceptMeaning
0CartesianCartesian grid.
1RectilinearRectilinear grid.
2CurvilinearCurvilinear grid.

Severity

HydroCouple::ErrorEntry::Severity

Severity of an ErrorEntry.

ValueConceptMeaning
0InformationInformational message.
1WarningRecoverable anomaly.
2ErrorOperation failed; component may continue.
3FatalComponent is in the Failed state.

SpatialDataType

HydroCouple::Spatial::SpatialDataType

The algebraic structure of the value at each entity: a scalar, a set of independent scalars, a vector or a tensor.

ValueConceptMeaning
0ScalarOne value per entity; no component dimension.
1MultiScalarSeveral independent scalars per entity (e.g. constituents); component dimension of that count, basis irrelevant.
2VectorA vector per entity; component dimension of length 2 or 3 in the order vectorBasis() defines.
3TensorA rank-2 tensor per entity; component dimension holding the row-major flattening (4 or 9 entries) in the basis vectorBasis() defines.

TimeExtrapolation

HydroCouple::Temporal::TimeExtrapolation

How a provider produces a value at an instant beyond the last (or before the first) it holds.

ValueConceptMeaning
0UnknownNot declared. validate() must treat a connection whose two ends both say Unknown as an error.
1RefuseA query outside the held range is refused; the provider must be advanced first.
2HoldLastRepeat the boundary value.
3LinearExtend the last two values linearly.

TimeInterpolation

HydroCouple::Temporal::TimeInterpolation

How a provider produces a value at an instant that is between two it holds.

ValueConceptMeaning
0UnknownNot declared. validate() must treat a connection whose two ends both say Unknown as an error.
1NoneExact match required (within TIME_EQUALITY_TOLERANCE_DAYS); a query at an instant not held is refused.
2PreviousHold the most recent earlier value (step function).
3NearestThe nearer of the two neighbours.
4LinearLinear in time between neighbours.

TimeKind

HydroCouple::Temporal::TimeKind

What a value's time coordinate refers to.

ValueConceptMeaning
0UnknownNot declared. Consumers must not assume Instantaneous.
1InstantaneousA reading at the time coordinate.
2IntervalMeanMean over the interval ending at the time coordinate.
3IntervalMinimumMinimum over that interval.
4IntervalMaximumMaximum over that interval.
5AccumulatedTotal accumulated over that interval.

ValueKind

HydroCouple::ValueKind

How a value behaves when it is regridded or aggregated.

ValueConceptMeaning
0UnknownNot declared. Adapters must not guess; they should refuse or ask.
1IntensiveIndependent of extent — temperature, concentration, elevation. Averages.
2ExtensiveProportional to extent — mass, volume, heat content. Sums.
3FluxPer unit area and time. Integrates over the area it crosses.
4DensityPer unit volume. Integrates over the volume it fills.

VectorBasis

HydroCouple::Spatial::VectorBasis

The frame a vector or tensor value is expressed in.

ValueConceptMeaning
0UnknownNot declared. Consumers must not assume.
1CartesianComponents along the reference system's x, y (and z) axes, in that order.
2EastNorthUpComponents along local east, north (and up) for geographic reference systems.
3NormalTangentialFor edge/face data: component 0 normal to the entity (positive from left face to right face as IMeshView::edgeFaces() orders them), component 1 tangential, component 2 (if any) vertical.
4AlongEntityFor network edges: one component along the edge from its first node to its second.

VerticalCoordinateKind

HydroCouple::Spatial::VerticalCoordinateKind

The family a vertical coordinate belongs to.

ValueConceptMeaning
0UnknownNot declared. Consumers must not assume.
1SigmaTerrain-following; layers stretch with the free surface.
2ZLevelFixed elevations; the top layer thins as the surface falls.
3ZStarFixed levels rescaled by total depth.
4HybridSigma near the surface, z below a transition depth.
5IsopycnalLayers of constant density.
6DepthBelowSurfaceFixed depths measured down from the moving surface.

WorkflowStatus

HydroCouple::IWorkflowComponent::WorkflowStatus

The WorkflowStatus enum describes the status of a workflow component over the course of its lifetime.

ValueConceptMeaningMay become
0CreatedThe workflow component has just been created.Initializing, Failed
1InitializingThe workflow component is initializing itself.Initialized, Failed
2InitializedThe workflow component has successfully initialized.Initializing, Validating, Finishing, Failed
3ValidatingThe workflow component is validating the composition (cross-component links, required roles).Validated, Failed, Invalid
4ValidatedThe workflow component found the composition valid and ready to prepare.Validating, Preparing, Finishing, Failed
5PreparingThe workflow component is preparing the composition for computation (e.g., driving IModelComponent::prepare(), building execution schedules, negotiating exchange patterns).Prepared, Failed
6PreparedThe workflow component has prepared the composition and can begin updating.Updating, Finishing, Failed
7UpdatingThe workflow component is performing an update step.Updated, Paused, Done, Failed
8UpdatedThe workflow component has successfully updated.Updating, Finishing, Failed
9PausedThe workflow component is paused at a synchronization point (see requestPause()) and can be resumed.Updated, Finishing, Failed
10DoneThe workflow component has completed all update steps.Finishing, Failed
11FinishingThe workflow component is finalizing and releasing resources.Finished, Failed
12FinishedThe workflow component has finished and cannot be restarted.
13FailedThe workflow component encountered an unrecoverable error.Initializing, Finishing
14InvalidThe workflow component found problems in the composition; fix the composition and validate() again.Validating, Finishing, Failed

Vocabulary properties

PropertyMeaning
mayTransitionToA legal lifecycle transition (normative: Helpers::isValidComponentStatusTransition() and isValidWorkflowStatusTransition()).
canonicalDimensionOrderingThe order of a data item's axes, as its C++ documentation states it.
cppNameThe fully qualified C++ name the term is generated from.