CircularOpenChannel

Undocumented in source.

class CircularOpenChannel : OpenChannel {

double diameter;

this();

this(Unknown u);

void setDiameter(double d);

double getDiameter();

bool isAlmostFull();

bool solve();

}

Constructors

this this(): Constructors + Empty Constructor
this this(Unknown u): Initialize the RectangularOpenChannel with the unknown as given

Members

Functions

getDiameter double getDiameter(): Returns the diameter of the pipe.
isAlmostFull bool isAlmostFull(): Shows if the pipe is more than half full.
setDiameter void setDiameter(double d): Sets the pipe diameter.
solve bool solve(): Methods + Solution summary. To be called in the application API

Variables

diameter double diameter;: Properties + Diameter

Inherited Members

From OpenChannel

GRAVITY_METRIC double GRAVITY_METRIC;: **************************************** Constants
ERROR auto ERROR;: Undocumented in source.
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.
discharge double discharge;: Discharge / Flow Rate
bedSlope double bedSlope;: Rise over run of the channel.
waterDepth double waterDepth;: Depth of water measured from the deepest point of the channel.
manningRoughness float manningRoughness;: Manning's roughness coefficient.
wettedPerimeter double wettedPerimeter;: Total length of the channel section covered with water.
wettedArea double wettedArea;: Total area of the channel section covered with water.
hydraulicRadius double hydraulicRadius;: wettedArea / wettedPerimeter
averageVelocity double averageVelocity;: Average velocity over the whole cross section of the channel.
froudeNumber float froudeNumber;: Froude number.
unknown Unknown unknown;: Enum type. (e.g. DISCHARGE, WATER_DEPTH, etc.)
flowType FlowType flowType;: Undocumented in source.
hydraulicDepth double hydraulicDepth;: Undocumented in source.
dischargeIntensity double dischargeIntensity;: Undocumented in source.
criticalDepth double criticalDepth;: Undocumented in source.
criticalSlope double criticalSlope;: Undocumented in source.
availableUnknowns Unknown[] availableUnknowns;: Undocumented in source.
isCalculationSuccess bool isCalculationSuccess;: Undocumented in source.
errorMessage string errorMessage;: Undocumented in source.
getDischarge double getDischarge(): Returns the rate of flow.
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.
getWaterDepth double getWaterDepth(): 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.
getWettedArea double getWettedArea(): 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.
getFroudeNumber double getFroudeNumber(): 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.
getFlowType FlowType getFlowType(): 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.
getDischargeIntensity double getDischargeIntensity(): 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.
isCalculationSuccessful bool isCalculationSuccessful(): Check if an error has occurred. @return isError
getErrMessage string getErrMessage(): Gets the error message. @return errMessage
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.
setWaterDepth void setWaterDepth(double pWaterDepth): 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.
calculateFlowType void calculateFlowType(): Methods +
isValidManning bool isValidManning(): Manning's roughness error checking
isValidBedSlope bool isValidBedSlope(Unknown u): Bed slope error checking
isValidWaterDepth bool isValidWaterDepth(Unknown u): Water depth 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

CircularOpenChannel

Constructors

Members

Functions

Variables

Inherited Members

From OpenChannel

Meta

Source