OpenChannel

Open Channel

The base class for all open channels.

class OpenChannel {

protected const

double GRAVITY_METRIC;

protected const

double discharge;

double bedSlope;

double waterDepth;

float manningRoughness;

double wettedPerimeter;

double wettedArea;

double hydraulicRadius;

double averageVelocity;

float froudeNumber;

Unknown unknown;

FlowType flowType;

double hydraulicDepth;

double dischargeIntensity;

double criticalDepth;

double criticalSlope;

Unknown[] availableUnknowns;

bool isCalculationSuccess;

string errorMessage;

double getDischarge();

double getAverageVelocity();

double getBedSlope();

double getWaterDepth();

double getWettedPerimeter();

double getWettedArea();

double getHydraulicRadius();

double getFroudeNumber();

double getManningRoughness();

FlowType getFlowType();

double getHydraulicDepth();

double getDischargeIntensity();

double getCriticalDepth();

double getCriticalSlope();

bool isCalculationSuccessful();

string getErrMessage();

void setBedSlope(double pBedSlope);

void setDischarge(double pDischarge);

void setWaterDepth(double pWaterDepth);

void setManningRoughness(double pManningRoughness);

void setUnknown(Unknown u);

void calculateFlowType();

bool isValidManning();

bool isValidBedSlope(Unknown u);

bool isValidWaterDepth(Unknown u);

bool isValidDischarge(Unknown u);

bool isValidInputs(A a);

}

Members

Enums

FlowType enum FlowType: Flow types. These are the categories in which the calculated froude number is compared to.
Unknown enum Unknown: General available unknowns for open channel.

Functions

calculateFlowType void calculateFlowType(): Methods +
getAverageVelocity double getAverageVelocity(): Returns the average velocity in the channel.
getBedSlope double getBedSlope(): Undocumented in source. Be warned that the author may not have intended to support it.
getCriticalDepth double getCriticalDepth(): Undocumented in source. Be warned that the author may not have intended to support it.
getCriticalSlope double getCriticalSlope(): Undocumented in source. Be warned that the author may not have intended to support it.
getDischarge double getDischarge(): Returns the rate of flow.
getDischargeIntensity double getDischargeIntensity(): Undocumented in source. Be warned that the author may not have intended to support it.
getErrMessage string getErrMessage(): Gets the error message. @return errMessage
getFlowType FlowType getFlowType(): Undocumented in source. Be warned that the author may not have intended to support it.
getFroudeNumber double getFroudeNumber(): Undocumented in source. Be warned that the author may not have intended to support it.
getHydraulicDepth double getHydraulicDepth(): Undocumented in source. Be warned that the author may not have intended to support it.
getHydraulicRadius double getHydraulicRadius(): Undocumented in source. Be warned that the author may not have intended to support it.
getManningRoughness double getManningRoughness(): Undocumented in source. Be warned that the author may not have intended to support it.
getWaterDepth double getWaterDepth(): Undocumented in source. Be warned that the author may not have intended to support it.
getWettedArea double getWettedArea(): Undocumented in source. Be warned that the author may not have intended to support it.
getWettedPerimeter double getWettedPerimeter(): Undocumented in source. Be warned that the author may not have intended to support it.
isCalculationSuccessful bool isCalculationSuccessful(): Check if an error has occurred. @return isError
isValidBedSlope bool isValidBedSlope(Unknown u): Bed slope error checking
isValidDischarge bool isValidDischarge(Unknown u): Undocumented in source. Be warned that the author may not have intended to support it.
isValidInputs bool isValidInputs(A a): Check if all conditions are true
isValidManning bool isValidManning(): Manning's roughness error checking
isValidWaterDepth bool isValidWaterDepth(Unknown u): Water depth error checking
setBedSlope void setBedSlope(double pBedSlope): Setters +
setDischarge void setDischarge(double pDischarge): Undocumented in source. Be warned that the author may not have intended to support it.
setManningRoughness void setManningRoughness(double pManningRoughness): Undocumented in source. Be warned that the author may not have intended to support it.
setUnknown void setUnknown(Unknown u): Undocumented in source. Be warned that the author may not have intended to support it.
setWaterDepth void setWaterDepth(double pWaterDepth): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

ERROR auto ERROR;: Undocumented in source.
GRAVITY_METRIC double GRAVITY_METRIC;: **************************************** Constants
availableUnknowns Unknown[] availableUnknowns;: Undocumented in source.
averageVelocity double averageVelocity;: Average velocity over the whole cross section of the channel.
bedSlope double bedSlope;: Rise over run of the channel.
criticalDepth double criticalDepth;: Undocumented in source.
criticalSlope double criticalSlope;: Undocumented in source.
discharge double discharge;: Discharge / Flow Rate
dischargeIntensity double dischargeIntensity;: Undocumented in source.
errorMessage string errorMessage;: Undocumented in source.
flowType FlowType flowType;: Undocumented in source.
froudeNumber float froudeNumber;: Froude number.
hydraulicDepth double hydraulicDepth;: Undocumented in source.
hydraulicRadius double hydraulicRadius;: wettedArea / wettedPerimeter
isCalculationSuccess bool isCalculationSuccess;: Undocumented in source.
manningRoughness float manningRoughness;: Manning's roughness coefficient.
unknown Unknown unknown;: Enum type. (e.g. DISCHARGE, WATER_DEPTH, etc.)
waterDepth double waterDepth;: Depth of water measured from the deepest point of the channel.
wettedArea double wettedArea;: Total area of the channel section covered with water.
wettedPerimeter double wettedPerimeter;: Total length of the channel section covered with water.

Meta

Source

See Implementation

libs openchannel classes