Skip to content

Commit ff856e0

Browse files
committed
some cleaning up and rearranging
1 parent bab99f9 commit ff856e0

File tree

1 file changed

+11
-4
lines changed
  • documentation/rom_simulation/0d-solver/solver

1 file changed

+11
-4
lines changed

documentation/rom_simulation/0d-solver/solver/readme.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,14 @@ cmake --build .
6363
</details>
6464
<br/>
6565

66+
## Blocks
67+
68+
The modular architecture of svZeroDSolver relies on "blocks", such as blood vessels, junctions, valves, boundary conditions, etc. Users can assemble and connect these blocks together in a variety of ways to create extensive and customizable 0D circulation models.
69+
70+
An overview of all currently implemented blocks can be found [here](https://simvascular.github.io/svZeroDSolver/class_block.html). This collection of building blocks allows to model extensive and complex vascular networks. Many examples of vascular networks can be found [here](https://github.com/simvascular/svZeroDSolver/tree/master/tests/cases). The assembly of these blocks is specified in the `.json` configuration file. The user guide below provides details.
71+
72+
We are always interested in adding new blocks to expand the funcitonality of svZeroDSolver. For developers interested in contributing, please read the [Developer Guide](https://simvascular.github.io/svZeroDSolver/developer_guide.html).
73+
6674
## svZeroDSolver - Quick User Guide
6775

6876
svZeroDSolver can be used to run zero-dimensional (0D) cardiovascular
@@ -347,7 +355,6 @@ When the outputs are written in the variable-based and vessel-based forms, the u
347355

348356
The number of timesteps between each time the output is written is specified by `output_interval`. By default, output is written at every time step.
349357

350-
351358
## svZeroDCalibrator - Quick User Guide
352359

353360
svZeroDCalibrator can be used to calibrate cardiovascular 0D models (i.e. infer optimal
@@ -434,9 +441,9 @@ We solve the differential-algebraic system implicitly in time, using the general
434441
## Assembly
435442
Similar to a finite element solver, the 0D solver defines local element contributions to the (sparse) [global system](https://simvascular.github.io/svZeroDSolver/class_sparse_system.html#details). The solver automatically assembles the local contributions into the global arrays. The local elements are referred to as blocks.
436443

437-
## Blocks
438-
An overview of all currently implemented blocks can be found [here](https://simvascular.github.io/svZeroDSolver/class_block.html). This collection of building blocks allows to model extensive and complex vascular networks. Many examples of vascular networks can be found [here](https://github.com/simvascular/svZeroDSolver/tree/master/tests/cases).
439-
<!-- Todo: write and add link to Doxygen guide on adding new blocks here-->
444+
## Developer guide
445+
446+
If you are a developer and want to contribute to svZeroDSolver, you can find more helpful information in our [Developer Guide](https://simvascular.github.io/svZeroDSolver/developer_guide.html).
440447

441448
## References
442449
Relevant literature can be found [here](https://simvascular.github.io/svZeroDSolver/citelist.html).

0 commit comments

Comments
 (0)