SimVascular / SimVascular/svZeroDSolver

Documentation for external_solver_coupling blocks

Open
#104 0 comments 0 reactions 1 assignee View on GitHub

@menon-karthik is already working on this.

Since Feb 20, 2024.

documentation enhancement
Dominant language
C++
Stars
22
Forks
44
PR merge metrics
No merged PRs in 30d

Description

Problem

The external_solver_coupling blocks are not documented anywhere. This is because they are not stand-alone classes, and are actually special use cases for the flow and pressure blocks.

Solution

We should have documentation to make it easy for users to interface between svZeroDSolver and other codes. The only current "documentation" are the examples in the tests/test_interface test cases.

Additional context

No response

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.