SimVascular / svZeroDSolver

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

Include names of internal variables in documentation #114

Closed menon-karthik closed 3 weeks ago

menon-karthik commented 2 months ago

Problem

The documentation does not list the internal variables for each block. This would be useful for postprocessing, so users know what variable names to reference in postprocessing codes, and also for specifying initial conditions, which users can specify using variable names.

Solution

Add a list of internal variables to the documentation for each block (similar to the list of parameters we already have). We should also mention that the other variable names (not the internal variables) are in the format <flow/pressure>:: for all blocks.

Additional context

No response

Code of Conduct