STAdditionalOutput Class

Sediment outputs. This class has two purposes.

1) It is a helper class that helps creates quantities for result specification. This is done by setting a flag and calling one of the

Copy

GetOutputQuantities

methods.

2) It will enable calculators inside the engine. If the flag is not set, the quantity will not be available for output. This is the case for the quantities:

Inheritance Hierarchy

SystemObject
DHI.Mike1D.STDataAccessSTAdditionalOutput

Namespace: DHI.Mike1D.STDataAccess
Assembly: DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class STAdditionalOutput

Public Class STAdditionalOutput

public ref class STAdditionalOutput

The STAdditionalOutput type exposes the following members.

Constructors

	Name	Description
	STAdditionalOutput	Initializes a new instance of the STAdditionalOutput class

Top

Properties

	Name	Description
	ActiveLayerFraction	Active layer Fraction.
	ActiveLayerThicknessIOF	Active layer thickness - Integrated over fractions.
	BedLevel	Bed level.
	BedLevelChange	Bed level change, accumulated from initial timestep.
	BedLoadIOF	Bed load - Integrated over fractions.
	BedLoadRemovalIOFAccumulated	Mass transport for all fractions and accumulated over time.
	ConcentrationIOF	Concentration - Integrated over fractions.
	D50	D50.
	D90	D90.
	DimensionlessBedShearStress	DimensionlessBedShearStress.
	FractionalActiveLayerMass	Fractional activelayer mass.
	FractionalActiveLayerThickness	Fractional activelayer thickness.
	FractionalBedLoad	Fractional bed load.
	FractionalBedLoadRemovalAccumulated	fractional bed load removal accumulated over time.
	FractionalMassTransportAccumulated	fractional mass transport accumulated over time.
	FractionalPassiveLayerMass	Fractional passivelayer mass.
	FractionalPassiveLayerThickness	Fractional passivelayer thickness.
	FractionalSedimentConcentration	Fractional sediment concentration.
	FractionalSuspendedLoad	Fractional suspended load.
	FractionalTotalLayerMass	Fractional active+passivelayer mass.
	FractionalTotalLayerThickness	Fractional active+passivelayer thickness.
	FractionalTotalLoad	Fractional total load.
	FractionalTotalLoadAccumulated	Fractional total load accumulated over time.
	GeometricMeanDiameter	Geometric mean diameter.
	MassError	Mass error, NonCohesive components only.
	MassTransportIOFAccumulated	Mass transport for all fractions and accumulated over time.
	PassiveLayerFraction	Passive layer fraction.
	PassiveLayerThicknessIOF	Passive layer thickness - Integrated over fractions.
	SedimentVolumeChange	Sediment volume change pr. length.
	SkinShearStress	Skin shear stress.
	SuspendedLoadIOF	Suspended load - Integrated over fractions.
	TotalLayerThicknessIOF	Total layer thickness - Integrated over fractions.
	TotalLoadIOF	Total load - Integrated over fractions.
	TotalLoadIOFAccumulated	Total load for all fractions accumulated over time.
	TotalShearStress	Total shear stress.

Top

Methods

	Name	Description
	AddToQuantities	Add a set of quantities for one or more components To get quantites for all components for their active-layer-fraction: Copy AddToQuantities(quantities, stData, st => STComponentQuantities.ActiveLayerFraction(st)); To get total load quantites for all non-cohesive components: Copy AddToQuantities(quantities, stData, st => STComponentQuantities.TotalLoad(st), false);
	AddToQuantitiesConditional	Add a set of quantities for one or more components To get bed load quantites for all non cohesive components that has bed load enabled: Copy AddToQuantitiesConditional(quantities, stData, st => STComponentQuantities.BedLoad(st), st => st.HasBedLoad);
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetOutputQuantities(STData)	Set additional outputs enabled in AdditionalOutput.
	GetOutputQuantities(STData, STAdditionalOutput)	Set additional outputs enabled in addOut.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

DHI.Mike1D.STDataAccess Namespace