Skip to content

Commit 9b5ff13

Browse files
committed
Add missing domain parameter definitions.
1 parent 07b4931 commit 9b5ff13

File tree

1 file changed

+31
-29
lines changed
  • documentation/multi_physics/solver-input-file/domain_parameters

1 file changed

+31
-29
lines changed

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

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The <i>Domain Subsection</i> is organized as follows
1818
&lt;<strong>Viscosity</strong>&gt;
1919
<br><br>
2020
&lt;<strong>Stimulus</strong> type=<i>stimulus_type</i>&gt;<br>
21-
[<a href="#stimulus_subsection"> Stimulus Subsection </a> ]
21+
[<a href="#domain_Stimulus_subsection"> Stimulus Subsection </a> ]
2222
<br>
2323
&lt;<strong>Stimulus</strong>&gt;
2424
<br><br>
@@ -56,7 +56,7 @@ The following sections list the parameters associated with a domain for a specif
5656
<a href="#domain_Electrophysiology_model"> Electrophysiology_model <a>
5757
<a href="#domain_Myocardial_zone"> Myocardial_zone <a>
5858
<a href="#domain_ODE_solver"> ODE_solver <a>
59-
<a href="#domain_Stimulus"> Stimulus <a>
59+
<a href="#domain_Stimulus_subsection"> Stimulus <a>
6060
<a href="#domain_Time_step_for_integration"> Time_step_for_integration <a>
6161
</pre>
6262

@@ -182,23 +182,24 @@ Convergence is deemed to occur when the size of the residual becomes sufficientl
182182
<strong>&lt;Anisotropic_conductivity&gt;</strong> <i>vector</i> <nobr>
183183
<strong>&lt;/Anisotropic_conductivity&gt;</strong>
184184
</nobr><br>
185-
Sets the anisotropic conductivity constant.
185+
The anisotropic conductivity constant used to model the directional dependence of conduction velocity in cardiac tissue.
186186
<br>
187187
<section id="domain_Backflow_stabilization_coefficient">
188188
<strong>&lt;Backflow_stabilization_coefficient&gt;</strong> <i>real</i> [0.2] <nobr>
189189
<strong>&lt;/Backflow_stabilization_coefficient&gt;</strong>
190190
</nobr><br>
191191
A parameter used to control flow reversal at outlet boundaries.
192192
<br>
193+
<section id="domain_Conductivity">
193194
<strong>&lt;Conductivity&gt;</strong> <i>real</i> [0.0] <nobr>
194195
<strong>&lt;/Conductivity&gt;</strong>
195196
</nobr><br>
196-
?
197+
The thermal or diffusive conductivity within a domain.
197198
<br>
198199
<strong>&lt;Continuity_stabilization_coefficient&gt;</strong> <i>real</i> [0.0] <nobr>
199200
<strong>&lt;/Continuity_stabilization_coefficient&gt;</strong>
200201
</nobr><br>
201-
?
202+
The stabilizing coefficient associated to the continuity equation in the Variational Multiscale Method.
202203
<br>
203204
<section id="domain_density">
204205
<strong>&lt;Density&gt;</strong> <i>real</i> [0.5] <nobr>
@@ -239,7 +240,7 @@ Permissible values are
239240
<strong>&lt;Feedback_parameter_for_stretch_activated_currents&gt;</strong> <i>real</i> [0.5] <nobr>
240241
<strong>&lt;/Feedback_parameter_for_stretch_activated_currents&gt;</strong>
241242
</nobr><br>
242-
?
243+
The constant for stretch-activated currents (SACs) used in cardiac electrophysiology simulations.
243244
<br>
244245
<section id="domain_Fluid_density">
245246
<strong>&lt;Fluid_density&gt;</strong> <i>real</i> [0.5] <nobr>
@@ -251,44 +252,44 @@ The density property for a fluid.
251252
<strong>&lt;Force_x&gt;</strong> <i>real</i> [0.0] <nobr>
252253
<strong>&lt;/Force_x&gt;</strong>
253254
</nobr><br>
254-
?
255+
The x-component of a body force applied to a domain.
255256
<br>
256257
<section id="domain_Force_y">
257258
<strong>&lt;Force_y&gt;</strong> <i>real</i> [0.0] <nobr>
258259
<strong>&lt;/Force_y&gt;</strong>
259260
</nobr><br>
260-
?
261+
The y-component of a body force applied to a domain.
261262
<br>
262263
<section id="domain_Force_z">
263264
<strong>&lt;Force_z&gt;</strong> <i>real</i> [0.0] <nobr>
264265
<strong>&lt;/Force_z&gt;</strong>
265266
</nobr><br>
266-
?
267+
The z-component of a body force applied to a domain.
267268
<br>
268269
<strong>&lt;G_Na&gt;</strong> <i>real</i> [14.838] <nobr>
269270
<strong>&lt;/G_Na&gt;</strong>
270271
</nobr><br>
271-
?
272+
The maximal sodium conductance used in the TenTusscher-Panfilov Ventricular Myocyte Model.
272273
<br>
273274
<strong>&lt;G_CaL&gt;</strong> <i>real</i> [3.98E-5] <nobr>
274275
<strong>&lt;/G_CaL&gt;</strong>
275276
</nobr><br>
276-
?
277+
The maximal calcium conductance used in the TenTusscher-Panfilov Ventricular Myocyte Model.
277278
<br>
278279
<strong>&lt;G_Kr&gt;</strong> <i>real</i> [0.153] <nobr>
279280
<strong>&lt;/G_Kr&gt;</strong>
280281
</nobr><br>
281-
?
282+
The maximal rapid delayed rectifier potassium current used in the TenTusscher-Panfilov Ventricular Myocyte Model.
282283
<br>
283284
<strong>&lt;G_Ks&gt;</strong> <i>real</i> [0.392] <nobr>
284285
<strong>&lt;/G_Ks&gt;</strong>
285286
</nobr><br>
286-
?
287+
The maximal rapid delayed rectifier sodium current used in the TenTusscher-Panfilov Ventricular Myocyte Model.
287288
<br>
288289
<strong>&lt;G_to&gt;</strong> <i>real</i> [0.294] <nobr>
289290
<strong>&lt;/G_to&gt;</strong>
290291
</nobr><br>
291-
?
292+
The maximal transient outward current conductance used in the TenTusscher-Panfilov Ventricular Myocyte Model.
292293
<br>
293294
<strong>&lt;Isotropic_conductivity&gt;</strong> <i>real</i> [0.0] <nobr>
294295
<strong>&lt;/Isotropic_conductivity&gt;</strong>
@@ -298,13 +299,13 @@ Sets the isotropic conductivity constant.
298299
<strong>&lt;Mass_damping&gt;</strong> <i>real</i> [0.0] <nobr>
299300
<strong>&lt;/Mass_damping&gt;</strong>
300301
</nobr><br>
301-
?
302+
The mass damping coefficient used to dissipate energy.
302303
<br>
303304
<section id="domain_Momentum_stabilization_coefficient">
304305
<strong>&lt;Momentum_stabilization_coefficient&gt;</strong> <i>real</i> [0.0] <nobr>
305306
<strong>&lt;/Momentum_stabilization_coefficient&gt;</strong>
306307
</nobr><br>
307-
?
308+
The stabilizing coefficient associated to the momentum equation in the Variational Multiscale Method.
308309
<br>
309310
<section id="domain_Myocardial_zone">
310311
<strong>&lt;Myocardial_zone&gt;</strong> <i>string [none] </i> <nobr>
@@ -324,9 +325,9 @@ Permissible values are
324325
</nobr><br>
325326
The time integration method to solve the ODEs used to integrate activation models.
326327
<ul style="list-style-type:disc;">
327-
<li> euler </li>
328-
<li> implicit - </li>
329-
<li> runge - </li>
328+
<li> euler - first-order Euler method</li>
329+
<li> implicit - second-order Crank–Nicolson method </li>
330+
<li> runge - fourth-order Runge-Kutte method</li>
330331
</ul>
331332
<br>
332333
<strong>&lt;Penalty_parameter&gt;</strong> <i>real </i> [0.0] <nobr>
@@ -351,28 +352,29 @@ with the first error estimate calculated.
351352
<strong>&lt;Shell_thickness&gt;</strong> <i>real</i> [0.0] <nobr>
352353
<strong>&lt;/Shell_thickness&gt;</strong>
353354
</nobr><br>
354-
?
355+
The thickness of the shell elements in a domain.
355356
<br>
356357
<section id="domain_Solid_density">
357358
<strong>&lt;Solid_density&gt;</strong> <i>real</i> [0.5] <nobr>
358359
<strong>&lt;/Solid_density&gt;</strong>
359360
</nobr><br>
360361
The density property for a solid.
361362
<br>
363+
<section id="domain_Source_term">
362364
<strong>&lt;Source_term&gt;</strong> <i>real</i> [0.0] <nobr>
363365
<strong>&lt;/Source_term&gt;</strong>
364366
</nobr><br>
365-
?
367+
The volumetric source term (e.g. heat or dye) within a domain.
366368
<br>
367369
<strong>&lt;tau_fi&gt;</strong> <i>real</i> [0.110] <nobr>
368370
<strong>&lt;/tau_fi&gt;</strong>
369371
</nobr><br>
370-
?
372+
The fast inward current time scale used in the Bueno-Orovio cell activation model.
371373
<br>
372374
<strong>&lt;tau_si&gt;</strong> <i>real</i> [1.88750] <nobr>
373375
<strong>&lt;/tau_si&gt;</strong>
374376
</nobr><br>
375-
?
377+
The slow inward current time scale used in the Bueno-Orovio cell activation model.
376378
<br>
377379
<section id="domain_Time_step_for_integration">
378380
<strong>&lt;Time_step_for_integration&gt;</strong> <i>real</i> [0.0] <nobr>
@@ -386,7 +388,7 @@ The time step size used to integrate activation models if different from simulat
386388
<!-- ---------- Stimulus Subsection ----------- -->
387389
<!-- ------------------------------------------ -->
388390

389-
<h4 id="stimulus_subsection"> Stimulus Subsection </h4>
391+
<h4 id="domain_Stimulus_subsection"> Stimulus Subsection </h4>
390392
The <i>Stimulus Subsection</i> of the <i>Domain Subsection</i> defines the stimulus
391393
settings for pacemaker cells for a cardiac electrophysiology simulation.
392394

@@ -403,29 +405,29 @@ The <strong>Stimulus</strong> keyword adds stimulus settings to the enclosing do
403405
<i>stimulus_type</i> attribute can be
404406

405407
<ul style="list-style-type:disc;">
406-
<li> "Istim" - </li>
408+
<li> "Istim" - the applied stimulus is a source current and not a voltage source </li>
407409
</ul>
408410

409411
<h5 id="stimulus_parameters"> Parameters </h5>
410412
<div class="bc_param_div">
411413
<strong>&lt;Amplitude&gt;</strong> <i>real</i> [0.0] <nobr>
412414
<strong>&lt;/Amplitude&gt;</strong>
413415
</nobr><br>
414-
?
416+
The stimulus amplitude.
415417
<br>
416418
<strong>&lt;Cycle_length&gt;</strong> <i>real</i> [0.0] <nobr>
417419
<strong>&lt;/Cycle_length&gt;</strong>
418420
</nobr><br>
419-
?
421+
The stimulus cycle length.
420422
<br>
421423
<strong>&lt;Duration&gt;</strong> <i>real</i> [0.0] <nobr>
422424
<strong>&lt;/Duration&gt;</strong>
423425
</nobr><br>
424-
?
426+
The stimulus duration.
425427
<br>
426428
<strong>&lt;Start_time&gt;</strong> <i>real</i> [0.0] <nobr>
427429
<strong>&lt;/Start_time&gt;</strong>
428430
</nobr><br>
429-
?
431+
The stimulus start time.
430432
<br>
431433
</div>

0 commit comments

Comments
 (0)