Loading...
Searching...
No Matches
HydroCouple::Spatial Namespace Reference

HydroCouple's interfaces that have a spatial component. More...

Classes

class  ICrossSection
 The shape of a channel at one place, as a function of stage. More...
 
class  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. More...
 
class  IEdge
 A directed edge from one vertex to another, adjacent to two faces. More...
 
class  IEnvelope
 IEnvelope represents the minimum bounding box of a geometry. More...
 
class  IGeometry
 IGeometry is the root class of the geometry hierarchy. More...
 
class  IGeometryCollection
 An IGeometryCollection is a geometric object that is a collection of some number of IGeometry objects. More...
 
class  IGeometryComponentDataItem
 IGeometryComponentDataItem is an IComponentDataItem whose data is associated with a collection of IGeometry objects. More...
 
class  ILayeredMeshComponentDataItem
 A polyhedral surface whose values are resolved into vertical layers. More...
 
class  ILayeredNetworkComponentDataItem
 A network carrying a vertical profile, and optionally a channel shape, at each node or edge. More...
 
class  ILayering
 Values resolved into vertical layers, whatever the plan geometry. More...
 
class  ILine
 The ILine class is an ILineString with exactly 2 IPoints. More...
 
class  ILinearRing
 An ILinearRing is an ILineString that is both isClosed() and isSimple(). More...
 
class  ILineString
 An ILineString is a Curve with linear interpolation between Points. More...
 
class  IMeshView
 IMeshView is a bulk, structure-of-arrays view of an unstructured mesh or network: flat coordinate spans plus CSR (compressed sparse row) connectivity. More...
 
class  IMultiCurve
 An IMultiCurve is a 1-dimensional IGeometryCollection whose elements are ICurves. More...
 
class  IMultiLineString
 An IMultiLineString is an IMultiCurve whose elements are ILineStrings. More...
 
class  IMultiPoint
 An IMultiPoint is a 0-dimensional IGeometryCollection. More...
 
class  IMultiPolygon
 An IMultiPolygon is an IMultiSurface whose elements are IPolygons. More...
 
class  IMultiSurface
 A MultiSurface is a 2-dimensional GeometryCollection whose elements are Surfaces, all using coordinates from the same coordinate reference system. More...
 
class  INetwork
 INetwork represents a graph structure of connected vertices and edges. More...
 
class  INetworkComponentDataItem
 INetworkComponentDataItem is an IComponentDataItem whose data is associated with the edges or the nodes of an INetwork. More...
 
class  IPoint
 An IPoint is a 0-dimensional geometric object and represents a single location in coordinate space. More...
 
class  IPolygon
 A IPolygon is a planar ISurface defined by 1 exterior boundary and 0 or more interior boundaries. More...
 
class  IPolyhedralSurface
 An IPolyhedralSurface is a contiguous collection of polygon patches or facets stitched together along their shared boundary edges. More...
 
class  IPolyhedralSurfaceComponentDataItem
 IPolyhedralSurfaceComponentDataItem is an IComponentDataItem whose data is associated with the faces (patches), edges, or nodes of an IPolyhedralSurface. More...
 
class  IRaster
 A Raster spatial feature. More...
 
class  IRasterBand
 IRasterBand is a single raster band for an IRaster. More...
 
class  IRasterComponentDataItem
 IRasterComponentDataItem is an IComponentDataItem whose data is associated with an IRaster. More...
 
class  IRegularGrid2D
 IRegularGrid2D represents a two-dimensional structured grid of nodes and cells. More...
 
class  IRegularGrid2DComponentDataItem
 IRegularGrid2DComponentDataItem is an IComponentDataItem whose data is associated with the cells of an IRegularGrid2D. More...
 
class  IRegularGrid3D
 IRegularGrid3D represents a three-dimensional structured grid of nodes and cells. More...
 
class  IRegularGrid3DComponentDataItem
 IRegularGrid3DComponentDataItem is an IComponentDataItem whose data is associated with the cells of an IRegularGrid3D. More...
 
class  ISpatialReferenceSystem
 ISpatialReferenceSystem describes the coordinate reference system for spatial geometric objects. More...
 
class  ISurface
 A ISurface is a 2-dimensional IGeometry object. More...
 
class  ITIN
 An ITIN is a triangulated irregular network IPolyhedralSurface consisting only of ITriangle patches. More...
 
class  ITINComponentDataItem
 ITINComponentDataItem is an IPolyhedralSurfaceComponentDataItem whose surface is an ITIN. More...
 
class  ITriangle
 An ITriangle is a IPolygon with 3 distinct, non-collinear vertices and no interior boundary. More...
 
class  IVertex
 The IVertex class is an IPoint of a topologically aware IGeometry. More...
 
class  IVerticalCoordinate
 Where the layers of a layered or volumetric data item actually are. More...
 

Enumerations

enum class  MeshLocation : uint8_t {
  Node = 0 ,
  Edge ,
  Face ,
  Volume
}
 Which mesh or network entity a data item's values are attached to. More...
 
enum class  SpatialDataType {
  Scalar ,
  MultiScalar ,
  Vector ,
  Tensor
}
 The algebraic structure of the value at each entity: a scalar, a set of independent scalars, a vector or a tensor. More...
 
enum class  VectorBasis : uint8_t {
  Unknown = 0 ,
  Cartesian ,
  EastNorthUp ,
  NormalTangential ,
  AlongEntity
}
 The frame a vector or tensor value is expressed in. More...
 
enum class  RegularGridType {
  Cartesian ,
  Rectilinear ,
  Curvilinear
}
 The types of regular grids. More...
 
enum class  VerticalCoordinateKind : uint8_t {
  Unknown = 0 ,
  Sigma ,
  ZLevel ,
  ZStar ,
  Hybrid ,
  Isopycnal ,
  DepthBelowSurface
}
 The family a vertical coordinate belongs to. More...
 
enum class  CrossSectionKind : uint8_t {
  Unknown = 0 ,
  StationElevation ,
  WidthElevation ,
  Analytic
}
 How a cross-section's shape is held by whoever produced it. More...
 

Detailed Description

HydroCouple's interfaces that have a spatial component.

Enumeration Type Documentation

◆ CrossSectionKind

enum class HydroCouple::Spatial::CrossSectionKind : uint8_t
strong

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

Enumerator
Unknown 

Not declared.

Consumers must not assume.

StationElevation 

Surveyed points across the section (HEC-RAS, SWMM).

WidthElevation 

Width as a function of elevation (CE-QUAL-W2).

Analytic 

A closed form: circular, trapezoidal, and the rest.

◆ MeshLocation

enum class HydroCouple::Spatial::MeshLocation : uint8_t
strong

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

One vocabulary for meshes and networks, named after UGRID's location attribute so that persistence and exchange agree by construction. On a two-dimensional polyhedral surface a "cell" is a face; there is no separate value for it. A network has nodes and edges only. Volume is for a layered mesh whose values live in the extruded cells (patch × layer).

Enumerator
Node 

Mesh nodes / network nodes (vertices).

Edge 

Mesh edges / network edges (links, conduits, reaches).

Face 

Mesh faces: the patches of a polyhedral surface, the triangles of a TIN.

Volume 

Extruded cells of a layered mesh (Spatial::ILayering).

◆ RegularGridType

The types of regular grids.

Enumerator
Cartesian 

Cartesian grid.

Rectilinear 

Rectilinear grid.

Curvilinear 

Curvilinear grid.

◆ SpatialDataType

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

Anything other than Scalar adds a trailing dimension of IDimension::DimensionRole::Component to the item's shape(); its meaning is declared by vectorBasis() on the item.

Enumerator
Scalar 

One value per entity; no component dimension.

MultiScalar 

Several independent scalars per entity (e.g. constituents); component dimension of that count, basis irrelevant.

Vector 

A vector per entity; component dimension of length 2 or 3 in the order vectorBasis() defines.

Tensor 

A rank-2 tensor per entity; component dimension holding the row-major flattening (4 or 9 entries) in the basis vectorBasis() defines.

◆ VectorBasis

enum class HydroCouple::Spatial::VectorBasis : uint8_t
strong

The frame a vector or tensor value is expressed in.

A velocity handed from a Cartesian-grid model to an edge-based finite-volume model is the canonical silent error: both hold "two numbers per entity" and mean different things by them. The basis is therefore part of the value's declaration, not of its documentation.

Enumerator
Unknown 

Not declared.

Consumers must not assume.

Cartesian 

Components along the reference system's x, y (and z) axes, in that order.

EastNorthUp 

Components along local east, north (and up) for geographic reference systems.

NormalTangential 

For 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.

AlongEntity 

For network edges: one component along the edge from its first node to its second.

◆ VerticalCoordinateKind

enum class HydroCouple::Spatial::VerticalCoordinateKind : uint8_t
strong

The family a vertical coordinate belongs to.

Named so that two models can tell whether they agree about what a layer is before they exchange values on one. A sigma model and a z-level model both present values indexed by layer, and those indices mean entirely different things; matching shapes is not agreement.

Enumerator
Unknown 

Not declared.

Consumers must not assume.

Sigma 

Terrain-following; layers stretch with the free surface.

ZLevel 

Fixed elevations; the top layer thins as the surface falls.

ZStar 

Fixed levels rescaled by total depth.

Hybrid 

Sigma near the surface, z below a transition depth.

Isopycnal 

Layers of constant density.

DepthBelowSurface 

Fixed depths measured down from the moving surface.