Click or drag to resize

STBaseComponent Class

Parameters for a ST component
Inheritance Hierarchy

Namespace:  DHI.Mike1D.STDataAccess
Assembly:  DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public abstract class STBaseComponent : IComponent

The STBaseComponent type exposes the following members.

Constructors
  NameDescription
Public methodSTBaseComponent
Initializes a new instance of the STBaseComponent class
Top
Properties
  NameDescription
Public propertyHasBedLoad
HasBedLoad helper function, Cohesive components can not, NonCohesive component might.
Public propertyHasSuspLoad
HasSuspLoad, Cohesive components has, NonCohesive component might.
Public propertyId
Component ID
Public propertyInitialActiveLayerFraction
Fraction value in active layer
Public propertyInitialPassiveLayerFraction
Fraction value passive layer
Public propertyPorosity
Sediment Porosity
Public propertyRelativeDensity
Relative density
Public propertyScope
Specifies where in the model the component belongs.

Only Water follows the flow.

Top
Methods
  NameDescription
Public methodStatic memberCalculateRubeyFormulaFallVelocity
Calculate fall velocity based on Rubey's formula.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldFallVelocity
Sediment fall velocity or settling velocity
Public fieldFallVelocityType
Sediment fall velocity or settling velocity type
Top
Extension Methods
  NameDescription
Public Extension MethodCreateADComponent
Create an AD component matching the ST component.

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

(Defined by STExtensions.)
Top
See Also