HydroCouple  2.0.0-alpha.1
HydroCouple Interface Definitions
Loading...
Searching...
No Matches
HydroCouple::Spatial::ILayering Class Referenceabstract

Values resolved into vertical layers, whatever the plan geometry. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::ILayering:
Collaboration diagram for HydroCouple::Spatial::ILayering:

Public Member Functions

virtual ~ILayering ()=default
 
virtual IDimension * layerDimension () const =0
 The IDimension of the layers (IDimension::DimensionRole::Layer).
 
virtual IVerticalCoordinate * verticalCoordinate () const =0
 Where those layers are.
 

Detailed Description

Values resolved into vertical layers, whatever the plan geometry.

Mixed into the layered mesh and layered network items rather than declared twice, so that a consumer needing only "values by layer, with elevations I can trust" can dynamic_cast to this and stay indifferent to whether the producer is an unstructured mesh or a one-dimensional network.

Constructor & Destructor Documentation

◆ ~ILayering()

virtual HydroCouple::Spatial::ILayering::~ILayering ( )
virtualdefault

Member Function Documentation

◆ layerDimension()

virtual IDimension * HydroCouple::Spatial::ILayering::layerDimension ( ) const
nodiscardpure virtual

The IDimension of the layers (IDimension::DimensionRole::Layer).

Position in shape(): immediately after the entity dimension — so dimension 1 on a plain layered item, dimension 2 on a time-varying one (time, entity, layer) — and before any Component dimension. Layer 0 is at the top.

◆ verticalCoordinate()

virtual IVerticalCoordinate * HydroCouple::Spatial::ILayering::verticalCoordinate ( ) const
nodiscardpure virtual

Where those layers are.

Never null. A layered item without a vertical coordinate is an array whose meaning the consumer has to guess.


The documentation for this class was generated from the following file: