Skip to content

Commit 41bb49a

Browse files
committed
fix markdown bold formatting
1 parent c3c6e66 commit 41bb49a

File tree

14 files changed

+71
-69
lines changed

14 files changed

+71
-69
lines changed

documentation/flowsolver/creating_data/readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ In addition to the five standard files (geombc.dat.1, restart.0.1, numstart.dat,
3333
This will required an executable that implements a lumped parameter network model for the patient circulation. This will be covered in a later version of this tutorial. Stay tuned!
3434

3535
<br>
36+
3637
**HINT**: In both files geombc.data.1 and restart.0.1, the number “.1” refers to the **partition number** of the file. Remember **svSolver** has the ability of running a problem _in parallel_ (i.e., using multiple processors or computing cores), using MPI (message-passing interface). When we run a job using multiple processors, the first thing that happens is the “splitting” of these two files into as many processors we are going to use in our analysis, so the calculations can be performed faster. For example, if we use $4$ processors later in svSolver, these files will be split as follows:
3738

3839
```

documentation/genbc/intro/readme.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,39 @@ This tutorial demonstrates how to use the General Boundary Conditions (GenBC) fr
44

55
## What is GenBC?
66

7-
GenBC provides a framework to programmatically define custom inflow and outflow boundary conditions for a CFD simulation. The framework
8-
allows users to create an arbitrary lumped parameter network (LPN) layout suitable for their application. Some common examples include a
9-
lumped parameter heart model that models contraction of the heart chambers to use as an inlet boundary condition, sophisticated models of
10-
the downstream circulation for various areas of the body such as the legs and upper body, or a closed-loop formulation where all outflow
7+
GenBC provides a framework to programmatically define custom inflow and outflow boundary conditions for a CFD simulation. The framework
8+
allows users to create an arbitrary lumped parameter network (LPN) layout suitable for their application. Some common examples include a
9+
lumped parameter heart model that models contraction of the heart chambers to use as an inlet boundary condition, sophisticated models of
10+
the downstream circulation for various areas of the body such as the legs and upper body, or a closed-loop formulation where all outflow
1111
of the SimVascular model returns back to the inflow after passing through the veins, heart, and pulmonary arteries.
1212

13-
The GenBC framework is implemented as a Fortran program called by the SimVascular flow solver svSolver. Users must derive the governing
14-
ordinary differential equations for the lumped parameter layout and implement them in Fortran inside the GenBC program. The Fortan program
15-
is then compiled to produce a GenBC executable program. This executable is called by svSolver during execution to provide values for
13+
The GenBC framework is implemented as a Fortran program called by the SimVascular flow solver svSolver. Users must derive the governing
14+
ordinary differential equations for the lumped parameter layout and implement them in Fortran inside the GenBC program. The Fortan program
15+
is then compiled to produce a GenBC executable program. This executable is called by svSolver during execution to provide values for
1616
custom boundary conditions.
1717

1818
SimVascular does not currently provide functionality to define GenBC boundary conditions using the GUI. The GUI is used
1919
to generate simulation files for built-in boundary conditions. These files are then manually edited to incorporate the commands
20-
needed to define data for the boundary conditions and to tell svSolver to use the GenBC framework.
21-
20+
needed to define data for the boundary conditions and to tell svSolver to use the GenBC framework.
2221

2322
## Cylinder RCR example
2423

25-
This tutorial demonstrates how to use GenBC to define inflow and RCR boundary conditions for flow in a cylinder. Although these
26-
boundary conditions can be defined using the built-in features in SimVascular they are used here as a simple example of all the
27-
steps needed to implement GenBC boundary conditions. A graphical representation of the boundary conditions for the cylinder example
28-
is shown in the figure below.
24+
This tutorial demonstrates how to use GenBC to define inflow and RCR boundary conditions for flow in a cylinder. Although these
25+
boundary conditions can be defined using the built-in features in SimVascular they are used here as a simple example of all the
26+
steps needed to implement GenBC boundary conditions. A graphical representation of the boundary conditions for the cylinder example
27+
is shown in the figure below.
2928

3029
<figure>
3130
<img class="svImg svImgMd" src="/documentation/genbc/imgs/rcr_cylinder.jpeg">
3231
<figcaption class="svCaption" >Cylinder with sinusoidal inflow and RCR outflow.</figcaption>
3332
</figure>
3433

35-
The SimVascular project for the cylinder example can be downloaded using the **Cylinder Example Project** link in the menu on the
36-
left-hand side of this page. The project contains all of the data (image, model, and mesh) needed for the tutorial. You will need
34+
The SimVascular project for the cylinder example can be downloaded using the **Cylinder Example Project** link in the menu on the
35+
left-hand side of this page. The project contains all of the data (image, model, and mesh) needed for the tutorial. You will need
3736
to manually load the mesh by selecting **Meshes->cylinder_mesh->Load/Unload Mesh** from the **SV Data Manager** menu. The project
3837
has two additional folders
3938

40-
1) GenBC-program - Contains the Fortran code implementing the GenBC framework
41-
2) flow-file - Contains the **inlet.flow** file used to to define the flow rate for Direchlet boundary conditions.
42-
43-
39+
```
40+
1. GenBC-program - Contains the Fortran code implementing the GenBC framework
41+
2. flow-file - Contains the **inlet.flow** file used to to define the flow rate for Direchlet boundary conditions.
42+
```

documentation/modeling/3D_seg/readme.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ Close the panel before creating or opening a SimVascular project.
8484
</div>
8585

8686
<br>
87-
The **3D Level Set Tool** creates a **level-set** node under the SV Data Manager <i>Images</i> node. The **level-set** node
88-
itself has four sub-nodes used to store and display geometry created by each of the panels
87+
88+
The **3D Level Set Tool** creates a **level-set** node under the SV Data Manager <i>Images</i> node. The **level-set** node itself has four sub-nodes used to store and display geometry created by each of the panels
8989

9090
<ul style="list-style-type:none;">
9191
<li> <b>seed-points</b> - Seed points, displayed as green or red spheres. </li>
@@ -261,8 +261,7 @@ Create a SimVascular project and read in the demo-image.vti image data file from
261261
<br>
262262
<b>Step 2 - Open the 3D Level Set Tool</b> <br>
263263
Select the
264-
<img src="/documentation/modeling/imgs/3d-level-set/level-set-icon.png" width="20" height="20"> icon located at the top of the
265-
SimVascular toolbar to open the **3D Level Set Tool** panel. Select the <i>Seeds</i> sub-panel.
264+
<img src="/documentation/modeling/imgs/3d-level-set/level-set-icon.png" width="20" height="20"> icon located at the top of the SimVascular toolbar to open the <strong>3D Level Set Tool</strong> panel. Select the <i>Seeds</i> sub-panel.
266265
<figure>
267266
<img class="svImg svImgXl" src="/documentation/modeling/imgs/3d-level-set/example-1/fig-2.png">
268267
</figure>

documentation/modeling/level_set/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Now a new contour is created and added to the group.
6565

6666
In general, you should go with the normal approach above: making more segmentations than you will need and then selecting a subset to define the vessel. However, in the following exercise, we will try to gain some intuition that makes batch level set segmentation possible and efficient.
6767

68-
<font color="red">**HELPFUL HINT:**</font> Finding suitable level set parameters based on a few cross sections and then doing batch segmentation can dramatically speed up model building. Make sure the seed fits within the lumen of the vessel for all the positions we’d like to segment in the batch.
68+
<font color="red"><strong>HELPFUL HINT:</strong></font> Finding suitable level set parameters based on a few cross sections and then doing batch segmentation can dramatically speed up model building. Make sure the seed fits within the lumen of the vessel for all the positions we’d like to segment in the batch.
6969

7070
Now let's try to create contours in batch model using levelset.
7171

@@ -106,4 +106,4 @@ Secondly, you want to check to make sure that the segmentation does not include
106106
<figcaption class="svCaption" ></figcaption>
107107
</figure>
108108

109-
<font color="red">**HELPFUL HINT:** </font> You want the spacing between locations to be sufficient to capture the curvature and other changes in the vessel. If the vessel is relatively straight, as is the case in this the abdominal aorta for this dataset, you can space the segmentations relatively far apart.
109+
<font color="red"><strong>HELPFUL HINT:</strong></font> You want the spacing between locations to be sufficient to capture the curvature and other changes in the vessel. If the vessel is relatively straight, as is the case in this the abdominal aorta for this dataset, you can space the segmentations relatively far apart.

documentation/python_interface/intro/python_shell/readme.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ where <em>DATE</em> is the SimVascular install date (e.g. 2020-04-06). In the fo
1616
the SimVascular launch script.
1717

1818
<br>
19+
1920
The SimVascular Python interpreter, the application that executes Python programs, is invoked in interactive mode using the **---python** flag.
2021
That means you can enter Python statements or expressions interactively and have them executed or evaluated while you wait.
2122
The **Python Shell** behaves like the standard Python interpreter and therefore supports automatic indentation to mark blocks of code.
@@ -38,6 +39,7 @@ Hello
3839
</pre>
3940

4041
<br>
42+
4143
The **Python Shell** is terminated using
4244

4345
<pre>
@@ -47,7 +49,8 @@ Windows: exit() or hold the Ctrl key down while you enter a Z, then hit the “E
4749
</pre>
4850

4951
<br>
50-
Python scripts are read in and executed using a double-dash **---** before the script name. The **Python Shell** passes the script to the
52+
53+
Python scripts are read in and executed using a double-dash **---** before the script name. The **Python Shell** passes the script to the
5154
Python interpreter for execution and then exits.
5255

5356
<pre>

documentation/python_interface/modules/function_arguments/readme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ the meaning of the data passed to the **Circle** class constructor
1010
</pre>
1111

1212
<br>
13+
1314
All data passed to a function is checked against the type expected by the function. A type mismatch generates an error.
14-
General type errors are detected by Python. For example, using a string for the <i>radius</i> argument which expects a
15+
General type errors are detected by Python. For example, using a string for the <i>radius</i> argument which expects a
1516
float generates a Python **TypeError**
1617

1718
<pre>
@@ -20,9 +21,10 @@ TypeError: CircleSegmentation() argument 1 must be float, not str
2021
</pre>
2122

2223
<br>
24+
2325
Errors associated with data needed by the C++ functions called from the SimVascular API are detected within the API C++
24-
implementation. For example, passing in a list of two instead of three floats for the **Circle** class constructor
25-
<i>normal</i> argument generates a **segmentation** module error
26+
implementation. For example, passing in a list of two instead of three floats for the **Circle** class constructor
27+
<i>normal</i> argument generates a <b>segmentation</b> module error
2628

2729
<pre>
2830
>>> seg = sv.segmentation.Circle(radius=1.0, center=[1.0,0.0,0.0], normal=[1.0])

documentation/python_interface/modules/help/readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Typing <b>help(sv)</b> prints information about the **sv** package.
88
</div>
99

1010
<br>
11+
1112
Typing <b>help(sv.MODLENAME)</b> prints information about the **MODULENAME** module
1213

1314
<ul>

documentation/python_interface/modules/sv_module/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ The **sv** package defines the following modules
1717

1818
<br>
1919
Modules are accessed using <b>sv.<i>MODULENAME</i></b>. The <b>sv</b> package can also be imported into Python using the
20-
<b>from sv import \*</b> statement. This makes all of the module names accessible without the **sv** prefix. A single <b>sv</b>
20+
<b>from sv import \*</b> statement. This makes all of the module names accessible without the <b>sv</b> prefix. A single <b>sv</b>
2121
module can be imported using <b>from sv import <i>MODULENAME</i></b>. The difference between the these statements is seen using
22-
the **dir()** function which shows imported modules
22+
the <b>dir()</b> function which shows imported modules
2323

2424
<pre>
2525
<div style="font-size:10px; height: auto; overflow: visible;">

documentation/rom_simulation/1d-solver/input_file/readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ Output formats
385385
VTK export options
386386

387387
<ul style="list-style-type:none;">
388-
<li>0 - Output multiple files (default). A separate file is written for each saved increment. A **pvd** file is also provided which contains the time information of the sequence. This is the best option to create animations. </li><br>
388+
<li>0 - Output multiple files (default). A separate file is written for each saved increment. A <b>pvd</b> file is also provided which contains the time information of the sequence. This is the best option to create animations. </li><br>
389389
<li>1 - The results for all time steps are plotted to a single XML VTK file. </li><br>
390390
</ul>
391391

@@ -433,8 +433,8 @@ Arguments
433433
<li><i>id</i> (integer) - Segment ID. </li><br>
434434
<li><i>length</i> (double - Segment length. </li><br>
435435
<li><i>nelems</i> (integer) - Total finite elements in segment. </li><br>
436-
<li><i>inode</i> (integer) - Segment inlet **Node**. </li><br>
437-
<li><i>onode</i> (integer) - Segment outlet **Node**. </li><br>
436+
<li><i>inode</i> (integer) - Segment inlet <b>Node</b>. </li><br>
437+
<li><i>onode</i> (integer) - Segment outlet <b>Node</b>. </li><br>
438438
<li><i>iarea</i> (double - Segment inlet area. </li><br>
439439
<li><i>oarea</i> (double - Segment outlet area. </li><br>
440440
<li><i>iflow</i> (double - Segment initial flow. </li><br>

documentation/rom_simulation/1d-solver/theory/readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,9 @@ where the initial condition is given by $\mathbf{U}^0(z) = \left[S^0(z),Q^0(z)\r
9999
The boundary conditions are not specified at this point.
100100

101101
<h2> Disjoint Decomposition </h2>
102-
We adopt the disjoint decomposition approach described in 2.3 to derive appropriate outflow boundary conditions.
103-
First, we divide our spatial domain $\Omega=[0,L]$ into an upstream **numerical** domain $\Omega^{n}: z\in(0,B)$,
102+
103+
We adopt the disjoint decomposition approach described in 2.3 to derive appropriate outflow boundary conditions.
104+
First, we divide our spatial domain $\Omega=[0,L]$ into an upstream **numerical** domain $\Omega^{n}: z\in(0,B)$,
104105
and a downstream **analytic** domain $\Omega^{a}: z\in(B,L)$.
105106

106107
The boundary that separates these domains is defined as $\Gamma\_{B} : z = B$. We define a disjoint decomposition of

0 commit comments

Comments
 (0)