Creation of CFD User Guide
@ktbolt is already working on this.
Since Jul 14, 2026.
Assessment
This issue has not been assessed yet.
Description
Problem
General SimVascular users are unfamiliar with basic concepts of CFD and have trouble using svSolver and svMultiPhysics. This leads to a large volume of user questions on the forums that could be more efficiently answered by a section of documentation.
Solution
Creation of a new section of the documentation that outlines basic concepts of CFD. Some topics include:
- Basics of the Navier-Stokes equations and how it is used to model blood flow
- Basics of finite element discretization (i.e. how meshing works and how it affects the solution)
- Boundary condition selection and specification (inflow, outflow, and wall conditions)
- Selection of time marching parameters and explanation of solution stability
- Basics of numerical linear solvers (i.e. selection of settings, interpreting residuals, etc.)
- Assessing simulation results for accuracy and reliability
- Basic CFD post-processing in Paraview (i.e. viewing solution contours, creating velocity glyphs/streamlines, model clipping, etc.)
- Basics of using HPC resources (i.e. parallel computing, selection of compute resources, using the gateway, etc.)
List of topics will be updated as content is created and new issues arise!
Additional context
Creation of short video lessons on the above topics to provide further explanation/demonstration also is planned for the future.
Code of Conduct
- I agree to follow this project's Code of Conduct and Contributing Guidelines
- Dominant language
- HTML
- Stars
- 3
- Forks
- 26
- Avg merge
- 13d 1h
- Merged PRs (30d)
- 1
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SimVascular/simvascular.github.io
-
Add WSL2 guidance for Windows usersMay be free again @ktbolt claimed this 53 days ago, and no pull request is open. Openenhancement
SimVascular/simvascular.github.io#103 · 6 comments · 2 assignees ·
-
Solver documentation needs a working tutorial, updates, and correctionsMay be free again @ryanspilker claimed this 180 days ago, and no pull request is open. Openbug
SimVascular/simvascular.github.io#91 · 11 comments · 1 assignee ·
-
Update svMultiPhysics documentation with Docker image link (simvascular/svmultiphysics)May be free again @ktbolt claimed this 184 days ago, and no pull request is open. Opendocumentation
SimVascular/simvascular.github.io#90 · 2 comments · 1 assignee ·
-
Update coronary documentationMay be free again @menon-karthik claimed this 199 days ago, and no pull request is open. Openenhancement
SimVascular/simvascular.github.io#85 · 5 comments · 3 assignees ·
-
svMultiPhysics: Add documentation describing the valid range of node and element IDs in text filesMay be free again @ktbolt claimed this 314 days ago, and no pull request is open. Openenhancement
SimVascular/simvascular.github.io#81 · 1 assignee ·