Class ReadOnlyFlowModelSettings
A read-only definition of flow model settings
Namespace: Scripting
Syntax
public class ReadOnlyFlowModelSettings
Constructors
ReadOnlyFlowModelSettings()
Creates an instance of the ReadOnlyFlowModelSettings class.
Declaration
public ReadOnlyFlowModelSettings()
Properties
AutoGenerateReferenceHeightsDuringAutoSetup
Gets whether the reference heights should be auto generated during auto setup or not
Declaration
public bool AutoGenerateReferenceHeightsDuringAutoSetup { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
FlowModelType
Gets the flow model type
Declaration
public FlowModelType FlowModelType { get; }
Property Value
Type | Description |
---|---|
FlowModelType |
IsSectorProbabilitiesDirectionShifted
Gets whether the sector probabilities have been direction shifted or not
Declaration
public bool IsSectorProbabilitiesDirectionShifted { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
SpeedupsModel
Gets the read-only shear model
Declaration
public SpeedupsModel SpeedupsModel { get; }
Property Value
Type | Description |
---|---|
SpeedupsModel |
TopographicSensitivity
Gets the topography sensitivity
Declaration
public double TopographicSensitivity { get; }
Property Value
Type | Description |
---|---|
System.Double |
WindAtlasFilePath
Gets the wind atlas file path
Declaration
public string WindAtlasFilePath { get; }
Property Value
Type | Description |
---|---|
System.String |
WindFlowCalibration
Gets the wind flow calibration
Declaration
public double WindFlowCalibration { get; }
Property Value
Type | Description |
---|---|
System.Double |
Methods
Equals(ReadOnlyFlowModelSettings)
Tests a ReadOnlyFlowModelSettings against this current ReadOnlyFlowModelSettings for equality.
Declaration
public bool Equals(ReadOnlyFlowModelSettings val)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlyFlowModelSettings | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current ReadOnlyFlowModelSettings for equality.
Declaration
public override bool Equals(object toCompare)
Parameters
Type | Name | Description |
---|---|---|
System.Object | toCompare |
Returns
Type | Description |
---|---|
System.Boolean | True if object is equal otherwise false is returned. |
Overrides
GetHashCode()
Gets the hash code for this object.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | The hash code for this object. |
Overrides
Operators
Equality(ReadOnlyFlowModelSettings, ReadOnlyFlowModelSettings)
Tests a ReadOnlyFlowModelSettings against this current ReadOnlyFlowModelSettings for equality.
Declaration
public static bool operator ==(ReadOnlyFlowModelSettings a, ReadOnlyFlowModelSettings b)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlyFlowModelSettings | a | |
ReadOnlyFlowModelSettings | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(ReadOnlyFlowModelSettings, ReadOnlyFlowModelSettings)
Tests a ReadOnlyFlowModelSettings against this current ReadOnlyFlowModelSettings for inequality.
Declaration
public static bool operator !=(ReadOnlyFlowModelSettings a, ReadOnlyFlowModelSettings b)
Parameters
Type | Name | Description |
---|---|---|
ReadOnlyFlowModelSettings | a | |
ReadOnlyFlowModelSettings | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |