STBaseComponent Class

Parameters for a ST component

Definition

Namespace: DHI.Mike1D.STDataAccess
Assembly: DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public abstract class STBaseComponent : IComponent
Inheritance
Object    STBaseComponent
Derived
Implements
IComponent

Constructors

STBaseComponentInitializes a new instance of the STBaseComponent class

Properties

HasBedLoad HasBedLoad helper function, Cohesive components can not, NonCohesive component might.
HasSuspLoad HasSuspLoad, Cohesive components has, NonCohesive component might.
Id Component ID
InitialActiveLayerFraction Fraction value in active layer
InitialPassiveLayerFraction Fraction value passive layer
Porosity Sediment Porosity
RelativeDensity Relative density
Scope Specifies where in the model the component belongs.

Only Water follows the flow.

Methods

CalculateRubeyFormulaFallVelocity Calculate fall velocity based on Rubey's formula.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

FallVelocity Sediment fall velocity or settling velocity
FallVelocityType Sediment fall velocity or settling velocity type

Extension Methods

CreateADComponent Create an AD component matching the ST component.

Check the HasSuspLoad to see if the ST component requires an AD component.


(Defined by STExtensions)

See Also