Skip to content

Cvs_US and Cvs_UK in BasicControlValve and SpecificValveType #279

@RaphaelGebhart

Description

@RaphaelGebhart

Deprecation of Cvs_US and Cvs_UK in ThermofluidStream

Background

In ThermofluidStream.FlowControl.BasicControlValve and ThermofluidStream.FlowControl.SpecificValveType, the main flow coefficient parameter is Kvs (SI-compliant). There are also optional legacy parameters:

  • Cvs_US - US customary units (gpm at 1 psi)
  • Cvs_UK - UK imperial units (UK gallons per minute at 1 psi)

Issues

  1. Non-SI units: Both Cvs_US and Cvs_UK are not SI-compliant, which conflicts with the rest of the Modelica standard library.
  2. Conversion required:
    • Kv ≈ 0.865 · Cv_US
    • Kv ≈ 0.72 · C_uk
      This adds unnecessary complexity and potential for user error.
  3. Legacy usage: Cvs_UK is a historical unit rarely used today. Cvs_US is also less relevant for SI-based libraries and global applications.

Recommendation

  • Deprecate both Cvs_US and Cvs_UK for v1.3. The user can set them but this will create a warning, noting that they will be removed in v2.0, encouraging the users to switch to Kvs for SI-consistent modeling.

This approach simplifies the API, ensures consistency, and aligns with Modelica and IEC/EN standards.

Metadata

Metadata

Assignees

Labels

effort::lowLow effort expected to solve issue.enhancementNew feature or requestp::FlowControlConcerns package FlowControl or Undirected.FlowControlpriority::lowShould be treated with low priority

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions