Skip to content

Unify flowrate / velocity interface#381

Open
jbreue16 wants to merge 2 commits intomasterfrom
doc/flow_rate
Open

Unify flowrate / velocity interface#381
jbreue16 wants to merge 2 commits intomasterfrom
doc/flow_rate

Conversation

@jbreue16
Copy link
Contributor

@jbreue16 jbreue16 commented Mar 28, 2025

Our interface and internal computation of the entangled parameters velocity, cross_section_area and the flow rates specified in the connections matrix might seem a little ambiguous to some users who have not read deeply into our documentation.
This PR

  • removes velocity from the interface, which is then solely computed from the cross section area and flow rate. Note that this is how its done in CADET-Process anyways.
  • introduces an optional flow_direction field
  • updates documentation accordingly
  • adds backwards compatibility and deprecation warning

@jbreue16 jbreue16 changed the title Update documentation of flow rate, velocity Unify floware / velocity interface Mar 28, 2025
@jbreue16 jbreue16 changed the title Unify floware / velocity interface Unify flowrate / velocity interface Mar 28, 2025
@jbreue16 jbreue16 self-assigned this Mar 28, 2025
@jbreue16 jbreue16 mentioned this pull request Apr 25, 2025
@jbreue16 jbreue16 added this to the v6.0.0 milestone Dec 9, 2025
@jbreue16 jbreue16 mentioned this pull request Feb 19, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants