The tests/cases JSON description of test case is useless

[ktbolt]

Problem

There are no examples showing how to create a svZeroDSolver JSON file for a particular application so the user must look at the files in the Test/Cases directory.

There is no README in this directory but each JSON file does have a "description" section with a "description of test case" key that could be used to describe the problem being solved.

However, the text in "description of test case" keys does not provide any useful information. For example

• steadyFlow_confluenceR_R.json - "description of test case": "steady flow -> confluence (with R's) -> R"
• pulsatileFlow_CStenosis_steadyPressure.json - "description of test case": "sine flow -> C + stenosis -> constant pressure"
• pulsatileFlow_R_coronary.json - "description of test case": "pulsatile flow -> R -> coronary"

I can only wonder what the -> means.

Solution

Create a useful description in "description of test case" or even better add a README describing several of the more interesting cases.

Some examples should also be added to the web documentation.

Additional context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct and Contributing Guidelines