Use Case

With such a feature, we would be able to use head loss calculations for pipes to:

1. Validate correctness of designs on the fly
2. Use head loss calculations for further design calculations in the Part Studio
3. Maybe something else?

Solution

This would reasonably be implemented with a feature that takes as input a reference to geometry that was drawn by a Pipeline feature, though it may be difficult to do so based off of just the geometry. We could get around this by having the Pipeline output some variables describing the pipes, though this may clog up the context.

@ethan92429 Is there some simple way to do the geometry-based approach that I'm missing?

Alternatives

Our current paradigm is to run HL calculations in the HDF, though this requires duplication of logic (pipes must be specified in both the DPS and the HDF).

• I have reviewed the test coverage in FeatureScript

Describe the Missing Coverage

Many functions check the range of acceptable values before calculating anything, and throw errors as a result. For example, widthWeirRect(0.0025 * meter^3 / second, 0.0 * meter) should return throw Value of Height is 0 which is not within range of GZ. Currently there is no way to test that the correct error occurs.

Expected Behavior

When an error such as throw Value of Height is 0 which is not within range of GZ occurs the Tester feature should be able to parse the error message and check that it matches the expected error.

Recommended Fix

I believe this could be accomplished by catching all errors thrown during testing and converting the error message to a string. Then that string would be compared to an expected error string.

The pipe diameter function has an error. Check it against the original python code.

Physical Chemistry is a core AguaClara file that is necessary to compute many plant calculations. On GitHub, the python file is named physchem.py.

• calculate size of pipe to use for obstacle

• calculate if obstacles on both sides of baffle needed

@oliver-leung

The three levels involve:

1. A "build function" that references the Part Studio to be instantiated
2. The PS that contains the component to be built, as well as the HDF as a feature instantiated in the PS
3. A "hydraulic design function" that runs calculations based off of hydraulic inputs and configures the PS's variables

This involves:

• Creating a graphic demonstrating each of the three levels
• Well-commented code for the LFOM
• Intuitive names and definitions for each of the components of this paradigm
• Validating and testing

Pipe Database is a core AguaClara file that contains many essential functions to calculate pipe dimensions. This is necessary to implement the Sed tank and possibly other plant components. In python, the file is named pipes.py.

Move all the functions from to
QA: @oliver-leung and @ethan92429

Use Case

Ensure HDFs use Core FS as much as possible (and add functionality which is common between HDFs to Core FS).

Solution

Since we now have fully tested Core FS functions it's best to use them as often as possible. If there's functionality that's commonly used that's not in Core FS we should add it (with tests!) to Core FS.

Alternatives

Have separately maintained versions of functions in different HDFs, but that will likely lead to errors.

We have two enums, one which defines the available ND and their associated OD and one which defines which of the diameters are actually available (called ND_ENUM_IS_USED). Since different pipes are available in different locations, ND_ENUM_IS_USED should be defined by the user instead of hardcoded. To accomplish this, a predicate which has a checkbox for each possible pipe in the database should be used, then those boolean values can be assigned to each member of ND_ENUM_IS_USED

Use Case

This would be very useful to supplement a BOM, in determining the minimum length of pipe that is required for to construct a set of cut pipes.

Solution

Similarly to #40, this feature could take in a reference to Pipeline geometry and return a list of available pipes that can be cut down to match the Pipeline design.

Alternatives

Eyeballing it? I'm not too sure what is the existing process for this...

The kinematic viscosity of 20 degC water should be 1.004e-06 meter ** 2 / second and yet the value calculated in featurescript is about 3 times that value.

Create an ET HDF

Use Case

Monroe attempted to add the molar gas constant to units.

Solution

Figure out how to define Moles in FeatureScript and implement the density gas equation with the Molar constant, R.

Alternatives

We currently don't use gas equations anywhere in AIDE, so this is definitely more of an educational tool instead of a vital feature.

Use Case

Components which have already been completed used an old pipeline feature or hand drawn pipelines. These should be replaced with the improved pipeline feature for easier maintainability.

Solution

Change the references to the old Pipeline feature in components like the sedimentor and flocculator and replace them with references to Ethan's new Pipeline feature.

Alternatives

If the components are working, they could be left as is. However, as more features get added to the new Pipeline feature these components would become more difficult to maintain, so it's better to update them all in advance.

I believe this filter will be contained in a single pipe. Before work starts Monroe and other experts need to solidify design logic which can be implemented in FeatureScript

For the flocculator, create the connection between HDF and Onshape Drawing and verify that it produces designs similar to the Mathcad/AutoCAD designs for 20 and 60 L/s.

• given head loss, K, temp, Q, L, roughness
• this is needed for drain pipe in flocculator
• This should be in pc

such as minimum space between a wall and a pipe

This should be closed

Some of the fittings generated by pipeline (when checking "Custom Parts" and selecting the "Fitting" part studio for fittings and the "Pipe" part studio for piping) will have sockets that intersect each other, e.g. in size 1/2 tees and elbows, creating partial sockets.

Use Case

Test Helpers has a bunch of useful helper functions. We might be able to get support from the Onshape community if we made it open source.

Solution

We could easily move Test Helpers into its own Document and create an open-source feature. Then we could advertise on the Onshape Forums that we made this feature and would appreciate contributions and feedback.

Alternatives

Continue to maintain Test Helpers privately within AguaClara Core FS.

Use Case

Right now the Expert Inputs parts studio is only used in unpacking of overrides string.

Solution

If we moved that functionality to the Inputs feature the EI parts studio can be removed entirely (and Import EI feature in the DPS replaced w/ Inputs).

Alternatives

The current implementation could be maintained as it works, but it's inefficient and harder to debug.

Use Case

Improve the functionality of the Tester feature by testing the test functions

Solution

*1. Create a Part studio and instantiate different cases of the Tester feature
2. Perform simple value checks.
3. Perform unit checks-For eg. checking that 5m not equal to 5 cm.
*

Alternatives

This is a part of #35

I tried to add flow units to a map and create a custom parsing function here, but when I tested it here it doesn't seem to work

The flow meter zero point is the bottom of the bottom row of orifices. Create code that takes the design flow rate and turns it into a nice ruler with ticks.

Consider making a dual ruler with flow rate on one side and percent of full flow on the other side.

Move the HDF FS from AguaClara to AC

Create a CDC HDF. Add the functions that calculate the diameter, length, and number of dosing tubes to the CDC HDF.