Click or drag to resize

STComponentQuantities Methods

The STComponentQuantities type exposes the following members.

Methods
  NameDescription
Public methodStatic memberActiveLayerFraction(IQuantity, String)
Returns active layer fraction quantity for a given ST component quantity.
Public methodStatic memberActiveLayerFraction(STBaseComponent, String)
Returns active layer fraction quantity for a given sand component.
Public methodStatic memberActiveLayerThickness
Returns active layer thickness
Public methodStatic memberActiveLayerThicknessIOF
Returns active layer thickness Integrated over fractions
Public methodStatic memberBedLevelChange
Returns bed level change since simulation start.
Public methodStatic memberBedLoad(IQuantity, String)
Returns bed load transport quantity for a given ST component quantity, in [m3/s]
Public methodStatic memberBedLoad(STBaseComponent, String)
Returns bed load transport quantity for a given ST component quantity, in [m3/s]
Public methodStatic memberBedLoadIOF
Returns face transport quantity integrated over components.
Public methodStatic memberBedLoadRemoval(IQuantity, String)
Returns bed load transport quantity for a given ST component quantity, in [m3/s]
Public methodStatic memberBedLoadRemoval(STBaseComponent, String)
Returns bed load removal for a given ST component quantity.
Public methodStatic memberBedLoadRemovalAccumulated
Returns accumulated transport quantity.
Public methodStatic memberBedLoadRemovalAccumulatedIOF
Bed load removal accumulated over time and integrated over all components
Public methodStatic memberBedLoadRemovalIOF
Bed load removal integrated over all components
Public methodStatic memberConcentrationEumQuantity
eumQuantity for suspended concentration of ST components, in [g/m3]
Public methodStatic memberConcentrationIOF
Returns concentration integrated over components.
Public methodStatic memberCreate(STBaseComponent, PredefinedQuantityST)
Returns a ST quantity from predefined quantity for a given component.
Public methodStatic memberCreate(STBaseComponent, PredefinedQuantityST, ComponentResultType)
Returns a ST quantity from predefined quantity for a given component.
Public methodStatic memberd50
Returns d50 grain size
Public methodStatic memberd90
Returns d90 grain size
Public methodStatic memberDimensionlessBedShearStress
Returns quantity Dimensionless bed shear stress
Public methodStatic memberFractionalActiveLayerMass
Returns active layer mass per NonCohesive fractions
Public methodStatic memberFractionalActiveLayerThickness
Returns active layer thickness per NonCohesive fractions
Public methodStatic memberFractionalConcentration
Returns suspended concentration quantity for fraction, in unit [g/m3]
Public methodStatic memberFractionalConcentrationQuantity
Quantity for suspended concentration for all ST components, in [g/m3]
Public methodStatic memberFractionalPassiveLayerMass
Returns passive layer mass per NonCohesive fractions
Public methodStatic memberFractionalPassiveLayerThickness
Returns passive layer thickness per NonCohesive fractions
Public methodStatic memberFractionalSurfaceDistribution
Returns surface distribution per NonCohesive fractions
Public methodStatic memberFractionalTotalLayerMass
Returns total layer mass per NonCohesive fractions
Public methodStatic memberFractionalTotalLayerThickness
Returns total layer thickness per NonCohesive fractions
Public methodStatic memberGeometricMeanDiameter
Returns geometric mean diameter.
Public methodStatic memberLoadMassEumQuantity
eumQuantity for mass load of ST component, in [g/s]
Public methodStatic memberLoadVolumeEumQuantity
eumQuantity for volume load of ST component, in [m3/s]
Public methodStatic memberMassError(IQuantity, String)
Returns mass error quantity for a given ST component quantity.
Public methodStatic memberMassError(STBaseComponent, String)
Returns mass error quantity for a given component.
Public methodStatic memberMassOnCatchment
Returns mass of sediment fraction on catchment (per fraction)
Public methodStatic memberMassTransport
Returns total sediment mass transport (per fraction)
Public methodStatic memberMassTransportAccumulated
Returns total routed mass of sediment fraction in SWQ simulation (per fraction)
Public methodStatic memberPassiveLayerFraction(IQuantity, String)
Returns passive layer fraction quantity for a given ST component quantity.
Public methodStatic memberPassiveLayerFraction(STBaseComponent, String)
Returns passive layer fraction quantity for a given sand component.
Public methodStatic memberPassiveLayerThicknessIOF
Returns passive layer thickness Integrated over fractions
Public methodStatic memberSedimentVolumeChange
Returns total sediment volume change
Public methodStatic memberSkinFriction
Returns quantity skin friction
Public methodStatic memberSuspLoad(IQuantity, String)
Returns suspended face transport quantity for a given component in [m3/s].
Public methodStatic memberSuspLoad(STBaseComponent, String)
Returns suspended face transport quantity for a given component in [m3/s].
Public methodStatic memberSuspLoadIOF
Returns face transport quantity integrated over components.
Public methodStatic memberTotalLayerThicknessIOF
Returns total layer thickness Integrated over fractions
Public methodStatic memberTotalLoad(IQuantity, String)
Returns face transport quantity for a given ST component quantity.
Public methodStatic memberTotalLoad(STBaseComponent, String)
Returns face transport quantity for a given component.
Public methodStatic memberTotalLoadAccumulated
Returns accumulated transport quantity.
Public methodStatic memberTotalLoadIOF
Returns face transport quantity integrated over components.
Top
See Also