SWMM5 Emoji- This code 🖥 calculates the flow of water that's captured by a customized inlet based on the approach flow, downstream node depth, and potential bypass. 🌊🌀 📂 Inputs:

 📌 Purpose of the Code:

This code 🖥 calculates the flow of water that's captured by a customized inlet based on the approach flow, downstream node depth, and potential bypass. 🌊🌀

📂 Inputs:

• inlet: 📍 A pointer to the inlet object.
• q: 🌧️ The approach flow in cfs (cubic feet per second).
• d: 📏 The downstream node depth.

📂 Output:

• Sends back 🚀 the captured flow in cfs.

🔍 Detailed Breakdown:

1️⃣ Initial Setup:

• Set local variables, such as the inlet position in the design array, the number of street sides (defaulting to one ☝️), and maximum flow capture limit.

2️⃣ Flow Limit Check:

• If the inlet has a flow limit 🚫🌊, update the maximum flow capture limit (qMax).

3️⃣ Street Sides Configuration:

• If the inlet is associated with a street 🛣️, determine if it has one or two sides and adjust the approach flow accordingly.

4️⃣ Flow Calculation Initialization:

• Set the initial captured flow to zero 🚫 and the bypassed flow equal to the approach flow.

5️⃣ Custom Curve Analysis:

• If the inlet has a custom curve associated with it 📈:
  • Diversion Curve Type: Computes the captured flow based on the bypassed flow. For every replicate inlet, it updates the captured flow and reduces the bypassed flow accordingly.
  • Rating Curve Type: Computes the captured flow based on the downstream node depth 📊.

6️⃣ Return Value:

• Adjust the captured flow if the street has two sides 🛣️🛣️ and then return the final captured flow value! 🌊🎉

📝 Summary: This function 🖥 is all about understanding how much water an inlet captures. Depending on the type of curve (either based on approach flow or node depth), it crunches the numbers 🧮, checks against any limits 🚫, and gives back the amount of water the inlet successfully captures. Whether it's a rainy day or water runoff, this inlet's got it covered! 🌧️🌀🎈

Hope this colorful summary with added emojis makes it engaging and fun! 🎉🌈🎈

SWMM5 Inlet Spread Code

 📌 Purpose of the Code:

This function determines how much the flow 🌊 spreads across a street's cross-section using equations from HEC-22 based on Izzard's form of the Manning equation.

📂 Inputs:

• Q: 🚰 Represents the flow rate in the conduit (measured in cfs, or cubic feet per second).

📂 Output:

• Returns 📤 the width of the flow spread across the street (measured in feet).

🔍 Detailed Breakdown:

1️⃣ Initial Setup:

• The function starts by setting f to Qfactor, which seems to be a constant derived from the Manning equation 📖 and the geometry of the conduit.

2️⃣ No Depressed Curb:

• If the value of a (seems to represent the depressed curb) is zero, the function calculates the spread of flow Ts1 using a formula from HEC-22 📝.

3️⃣ Depressed Curb Exists:

• If there's a depressed curb (i.e., a is non-zero):

  a. The function first checks if the spread is within the curb width W. It does this using another formula.

  b. If the spread Tw is less than or equal to W, then Ts1 is set to Tw.

  c. If the spread extends beyond the curb width, it goes into a loop ⭕ (for a maximum of 10 iterations) to refine the spread's estimate using another set of HEC-22 equations. The loop keeps refining the estimate until the difference between two successive estimates is very small (less than 0.01).

4️⃣ Final Result:

• The function returns 📤 the final estimated spread, but ensures it doesn't exceed Tcrown (probably the maximum spread possible).

📝 Summary: This function calculates how much water 🌊 flows across a street given the flow rate in a conduit. It uses specific formulas from HEC-22 and considers street geometry, especially the presence of a depressed curb. By determining the flow spread, it helps in understanding how water distributes across the street during events like rainfall 🌧️ or flooding 🌊.

Hope this emoji-laden explanation helps you grasp the essence of the code better! 🌟🥳📚

SWMM5 Inlet Code- 2️⃣ Checking for Street Cross Section

 Alright, let's dive into this code and sprinkle in some emojis for a clear and engaging explanation! 🚀🌈

📌 Purpose of the Code: This function gathers some essential properties about a conduit (or pipe) associated with an inlet and assigns them to shared variables. This helps other functions use these properties without having to fetch them again. 🔄🔍

📂 Inputs:

• inlet: 🕳️ Represents an inlet object that's placed in a conduit link.

🔍 Detailed Breakdown:

1️⃣ Initial Setup:

• The function starts by grabbing the index of the link where the inlet is placed and the subIndex of that link to identify the specific conduit. It then extracts the slope (SL) and the factor Beta from this conduit.

2️⃣ Checking for Street Cross Section:

• If the conduit has a Street cross section:

  a. Various properties like the street slope (Sx), gutter depression (a), gutter width (W), roughness (n), number of sides (Nsides), distance from curb to the crown (Tcrown), and a factor used in Izzard's equation (Qfactor) are assigned. 🛣️

  b. If there's a local depression at the inlet, it gets added to the continuous depression of the street. This is to account for any extra depression created by the inlet itself. ⛏️

  c. The slope of the depressed gutter section is calculated. If there's no depression, it defaults to the street slope.

3️⃣ Other Conduit Types:

• If the conduit doesn't have a Street cross section (like being rectangular or trapezoidal):

  a. Several properties are set to default values, like a and W becoming 0, and Nsides being 1 (indicating a one-sided street). 📏

  b. The slopes Sx and Sw are both set to a default value of 0.01.

📝 Summary: This function plays a crucial role in extracting and setting up geometric details 📐 of the conduit where an inlet is placed. Having this information readily available in shared variables ensures that other functions can swiftly access and utilize these details without redundant computations. Efficiency at its best! 🚀🎯

Hope this emoji-guided tour provides a brighter understanding of your code! 🎉🤖📘