SimVascular / svZeroDSolver

A C++ lumped-parameter solver for blood flow and pressure in hemodynamic networks
Other
6 stars 18 forks source link

Add names of internal variables to the documentation #124

Closed menon-karthik closed 3 weeks ago

menon-karthik commented 4 weeks ago

Current situation

Closes #114

The documentation for each class includes variables and equations that help with the theory. But when the outputs of a simulation include internal variables, it might not be clear to a user what those are unless they are documented for each block.

Release Notes

Added the list of internal variables to the documentation for each class.

Documentation

This is the documentation.

Testing

Tests are passing.

Code of Conduct & Contributing Guidelines