Skip to content

Improve WaterSSTP helper class documentation #646

@decaluwe

Description

@decaluwe

Cantera version

2.4.0

Operating System

All

Python/MATLAB version

All

Actual Behavior

At present, there are a number of classes in the thermo directory which provide supporting calculations to the WaterSSTP ThermoPhase class. These classes:

  • WaterProps
  • WaterPropsIAPWS
  • WaterPropsIAPWSphi

Are not instantiatable on their own, but provide low-level functionality necessary for property calculations in the aforementioned WaterSSTP class.

This aspect of these three files should be stated more explicitly, near the top of each of the relefvant .cpp and .h files, so that interested users can more easily locate the relevant thermoPhase class, and avoid wasting time trying to understand these helper classes, which are most likely not what they are interested in (directly) implementing.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions