Skip to content

Commit 07b4931

Browse files
committed
Update mesh paramters and add a bit more detail to data file formats.
1 parent f1dfd6e commit 07b4931

File tree

4 files changed

+21
-15
lines changed
  • documentation/multi_physics

4 files changed

+21
-15
lines changed

documentation/multi_physics/data-file-formats/data_file_formats_fiber_direction/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
A fiber and sheet direction data file is used to define a local orthonormal coordinate system
44
for each element in a finite element volume mesh representing cardiac muscle.
55
The data file is a <a href="#appendix_vtk_file_format"> VTK VTU </a> format file containing a CellData
6-
array named </strong>FIB_DIR</strong>.
6+
array of three-component vecors named <strong>FIB_DIR</strong>.
77

88
The data file is set using the solver input file
99
<a href="#mesh_params_Fiber_direction_file_path"> Fiber_direction_file_path </a> keyword.

documentation/multi_physics/data-file-formats/data_file_formats_initial_condition/readme.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11

22
<h2 id="data_file_formats_initial_condition"> Initial Condition Data</h2>
3-
The data file is used to initialize values on a finite element volume mesh. It is a
3+
Initial condition data for a finite element volume mesh can be initialized from values contained in a
44
<a href="#appendix_vtk_file_format"> VTK VTU </a> format file containing PointData arrays.
55

6-
<h3> Velocity and Pressue Data</h3>
7-
Velocity and pressure data is initialized using <a href="#appendix_vtk_file_format"> VTK VTU </a>
8-
format file containing PointData arrays named <strong>Velocity</strong> and <strong>Pressure</strong>.
6+
<h3> Displacement, Pressure, Stress, and Velocity Data</h3>
7+
Displacement, pressure, stress, and velocity data can be initialized using <a href="#appendix_vtk_file_format"> VTK VTU </a>
8+
format file containing PointData arrays named <strong>Displacement</strong>, <strong>Pressure</strong>, <strong>Stress</strong>, and <strong>Velocity</strong>.
99

1010
The data files are set using the solver input file
11-
<a href="#bc_mesh_params_Initial_pressures_file_path"> Initial_pressures_file_path</a> and
11+
<a href="#mesh_params_Initial_displacements_file_path"> Initial_displacements_file_path</a>,
12+
<a href="#mesh_params_Initial_pressures_file_path"> Initial_pressures_file_path</a> and
13+
<a href="#mesh_params_Prestress_file_path"> Prestress_file_path </a> and
1214
<a href="#mesh_params_Initial_velocities_file_path"> Initial_velocities_file_path</a> keywords.
1315

1416
<h3> State Variables </h3>

documentation/multi_physics/solver-input-file/mesh_parameters/readme.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ A <i>Mesh Section</i> is organized as follows
2828
&lt;<strong>Add_face</strong>&gt;
2929
<br>
3030

31-
[Mesh Parameters]
31+
<a href="#mesh_parameters">
32+
33+
[<a href="#mesh_parameters"> Mesh Parameters </a> ]
3234

3335
&lt;<strong>/Add_mesh</strong> &gt;
3436
</div>
@@ -73,40 +75,42 @@ The value used to scale mesh nodal coordinates.
7375
<strong>&lt;Initial_pressures_file_path&gt;</strong> <i>string [none] </i> <nobr>
7476
<strong>&lt;/Initial_pressures_file_path&gt;</strong>
7577
</nobr><br>
76-
The name of the file used to
78+
The name of the VTK VTU file used to initialize simulation pressure values on a fluid domain. See <a href="#data_file_formats_initial_condition"> Initial Condition Data</a>.
7779
<br>
7880
<section id="mesh_params_Initial_velocities_file_path">
7981
<strong>&lt;Initial_velocities_file_path&gt;</strong> <i>string [none] </i> <nobr>
8082
<strong>&lt;/Initial_velocities_file_path&gt;</strong>
8183
</nobr><br>
82-
The name of the file used to
84+
The name of the VTK VTU file used to initialize simulation velocity values on a fluid domain. See <a href="#data_file_formats_initial_condition"> Initial Condition Data</a>.
8385
<br>
8486
<section id="mesh_params_Initial_displacements_file_path">
8587
<strong>&lt;Initial_displacements_file_path&gt;</strong> <i>string [none] </i> <nobr>
8688
<strong>&lt;/Initial_displacements_file_path&gt;</strong>
8789
</nobr><br>
88-
The name of the file used to
90+
The name of the VTK VTU file used to initialize simulation displacement values on a solid domain. See <a href="#data_file_formats_initial_condition"> Initial Condition Data</a>.
8991
<br>
92+
<section id="mesh_params_Prestress_file_path">
9093
<strong>&lt;Prestress_file_path&gt;</strong> <i>string [none] </i> <nobr>
9194
<strong>&lt;/Prestress_file_path&gt;</strong>
9295
</nobr><br>
93-
The name of the file used to
96+
The name of the VTK VTU file used to initialize simulation stress values on a solid domain. See <a href="#data_file_formats_initial_condition"> Initial Condition Data</a>.
9497
<br>
9598
<section id="mesh_params_Fiber_direction_file_path">
9699
<strong>&lt;Fiber_direction_file_path&gt;</strong> <i>string [none] </i> <nobr>
97100
<strong>&lt;/Fiber_direction_file_path&gt;</strong>
98101
</nobr><br>
99-
The name of the file used to
102+
The name of the VTK VTU file used to define the fiber directions for a solid domain. See <a href="#data_file_formats_fiber_direction"> Fiber and Sheet Direction Data</a>.
100103
<br>
101104
<strong>&lt;Set_mesh_as_fibers&gt;</strong> <i>boolean [false] </i> <nobr>
102105
<strong>&lt;/Set_mesh_as_fibers&gt;</strong>
103106
</nobr><br>
104-
The name of the file used to
107+
If <i>true</i> then the mesh given in the <strong>Mesh_file_path</strong> keywork is treated as a mesh of one-dimensional elements in 3D.
108+
The mesh typically defines a network of Purkinje fibers used in cardiac electrophysiology simulations.
105109
<br>
106110
<strong>&lt;Set_mesh_as_shell&gt;</strong> <i>boolean [false] </i> <nobr>
107111
<strong>&lt;/Set_mesh_as_shell&gt;</strong>
108112
</nobr><br>
109-
The name of the file used to
113+
If <i>true</i> then the mesh given in the <strong>Mesh_file_path</strong> keywork is treated as a mesh of shell elements. The mesh can then be used for solving the <strong>shell</strong> equation type. A shell mesh is also needed for initializing a <strong>CMM</strong> equation using a prestress or displacements.
110114
<br>
111115
</div>
112116

documentation/multi_physics/solver-input-file/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ There are two types of tag
2020
An XML element is everything from (including) the element's start tag to (including) the element's end tag.
2121

2222
<pre>
23-
&lt;Tolerance> 0.001 &lt;/Tolerance>;
23+
&lt;Tolerance> 0.001 &lt;/Tolerance>
2424
</pre>
2525

2626
There are three types of elements

0 commit comments

Comments
 (0)