FlowResistanceConvertToStandardResistances Method |
Convert from the current formulation to the new/standard formulation.
To make inplace conversion, give the resistance array
to both of the currentResistances and newResistances arguments.
Not all type of conversions are supported. Currently only :
- Mannings n is converted to Mannings M
Namespace:
DHI.Mike1D.CrossSectionModule
Assembly:
DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax public static bool ConvertToStandardResistances(
ResistanceFormulation currentFormulation,
out ResistanceFormulation newFormulation,
double[] currentResistances,
ref double[] newResistances,
double[] hydraulicRadii
)
Public Shared Function ConvertToStandardResistances (
currentFormulation As ResistanceFormulation,
<OutAttribute> ByRef newFormulation As ResistanceFormulation,
currentResistances As Double(),
ByRef newResistances As Double(),
hydraulicRadii As Double()
) As Boolean
public:
static bool ConvertToStandardResistances(
ResistanceFormulation currentFormulation,
[OutAttribute] ResistanceFormulation% newFormulation,
array<double>^ currentResistances,
array<double>^% newResistances,
array<double>^ hydraulicRadii
)
Parameters
- currentFormulation
- Type: DHI.Mike1D.GenericResistanceFormulation
Formulation to convert from - newFormulation
- Type: DHI.Mike1D.GenericResistanceFormulation
Outputs the new/standard formulation - currentResistances
- Type: SystemDouble
Current resistance values - newResistances
- Type: SystemDouble
New resistance values. If no conversion takes place, newResistances will point to currentResistances. If null, then it will be created automatically - hydraulicRadii
- Type: SystemDouble
Hydraulic radii, to be used for some of the conversions.
Return Value
Type:
BooleanTrue if a conversion has taken place. False if no conversion has taken place.
See Also