Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Include Gate Valve function #160

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

johanlrdahl
Copy link
Contributor

The flow rate for the gate valve formula should be implemented and made available in Charts.
The current volumetric rate is valid for choke valves and it requires a Cv curve. For gate valves, this does not require a Cv curve (much simpler) and can be easily implemented.

Description

Added function for flow through gate valves

Motivation and Context

See Jira AH-1888

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Contributor Checklist:

  • My code follows the code style of this project.
  • I have added an example of my new feature and included it in the documentation.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My Pull Request name follows the naming convention fix: <description>, feat: <description>, etc.

Reviewer Checklist for Charts compliant functions:

  • The docstrings of the new function follow the contributing guidelines.
  • The new function is professionally documented
  • The new function and associated scripts are covered by one or more unit tests and code coverage did not decrease.
  • The new function is accompanied by an example and it is included in the Gallery of Charts.
  • The new function is reviewed in Chromatic. Access the storybook build results url and comment, approve or deny.
  • All function inputs, arguments, and outputs have a supported data type and have human readable names.
  • No code language is included in the description of the function or parameters (e.g use "polynomial order" instead of "poly_order")

Copy link

github-actions bot commented Mar 15, 2024

Unit Test Results

0 tests  ±0   0 ✅ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
0 files   ±0   0 ❌ ±0 

Results for commit e94d286. ± Comparison against base commit edc7afc.

♻️ This comment has been updated with latest results.

@johanlrdahl
Copy link
Contributor Author

@simone, @skepticalcat , I expect this to need a few iterations. Mainly:

  1. Make sure we have defined the correct input parameters to the function
  2. Then verify the calculations are correct
  3. Add test cases.

@johanlrdahl johanlrdahl changed the title Gate Valve first iteration feat: Include Gate Valve function Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant