Skip to content

Commit ab02959

Browse files
author
MFC Action
committed
Docs @ 4c52155
1 parent 44a1497 commit ab02959

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+3567
-3178
lines changed

documentation/case.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,14 @@ <h3 class="doxsection"><a class="anchor" id="sec-fluid-materials"></a>
475475
<li><span class="tt">fluid_pp(i)%cv</span>, <span class="tt">fluid_pp(i)%qv</span>, and <span class="tt">fluid_pp(i)%qvp</span> define $c_v$, $q$, and $q'$ as parameters of $i$-th fluid that are used in stiffened gas equation of state.</li>
476476
<li><span class="tt">fluid_pp(i)%G</span> is required for <span class="tt">hypoelasticity</span>.</li>
477477
</ul>
478+
<blockquote class="doxtable">
479+
<p><b>Stored-form parameters:</b> The values <span class="tt">gamma</span>, <span class="tt">pi_inf</span>, and <span class="tt">Re(1)</span>/<span class="tt">Re(2)</span> are <b>not</b> the raw physical quantities. MFC expects transformed stored forms:</p><ul>
480+
<li><span class="tt">gamma</span> = \(1/(\gamma-1)\), not \(\gamma\) itself</li>
481+
<li><span class="tt">pi_inf</span> = \(\gamma\,\pi_\infty / (\gamma - 1)\), not \(\pi_\infty\) itself</li>
482+
<li><span class="tt">Re(1)</span> = \(1/\mu\) (inverse viscosity), not \(\mu\) itself</li>
483+
</ul>
484+
<p>Setting <span class="tt">gamma = 1.4</span> for air is a common mistake; the correct value is <span class="tt">1.0 / (1.4 - 1.0) = 2.5</span>. See <a class="el" href="equations.html#sec-stored-forms" title="Stored Parameter Conventions">Stored Parameter Conventions</a> and <a class="el" href="equations.html#sec-material-values" title="Common Material Values">Common Material Values</a> in the Equations reference for the full table. </p>
485+
</blockquote>
478486
<h3 class="doxsection"><a class="anchor" id="sec-simulation-algorithm"></a>
479487
6. Simulation Algorithm</h3>
480488
<p>See <a class="el" href="equations.html" title="Equations">Equations</a> for the mathematical models these parameters control.</p>

documentation/doxygen_crawl.html

Lines changed: 77 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -169,16 +169,15 @@
169169
<a href="equations.html"/>
170170
<a href="equations.html#autotoc_md121"/>
171171
<a href="equations.html#autotoc_md123"/>
172-
<a href="equations.html#autotoc_md125"/>
173172
<a href="equations.html#autotoc_md126"/>
174173
<a href="equations.html#autotoc_md127"/>
175174
<a href="equations.html#autotoc_md128"/>
176-
<a href="equations.html#autotoc_md130"/>
175+
<a href="equations.html#autotoc_md129"/>
177176
<a href="equations.html#autotoc_md131"/>
178177
<a href="equations.html#autotoc_md132"/>
179-
<a href="equations.html#autotoc_md134"/>
180-
<a href="equations.html#autotoc_md136"/>
181-
<a href="equations.html#autotoc_md138"/>
178+
<a href="equations.html#autotoc_md133"/>
179+
<a href="equations.html#autotoc_md135"/>
180+
<a href="equations.html#autotoc_md137"/>
182181
<a href="equations.html#autotoc_md139"/>
183182
<a href="equations.html#autotoc_md140"/>
184183
<a href="equations.html#autotoc_md141"/>
@@ -187,21 +186,21 @@
187186
<a href="equations.html#autotoc_md144"/>
188187
<a href="equations.html#autotoc_md145"/>
189188
<a href="equations.html#autotoc_md146"/>
190-
<a href="equations.html#autotoc_md148"/>
189+
<a href="equations.html#autotoc_md147"/>
191190
<a href="equations.html#autotoc_md149"/>
192191
<a href="equations.html#autotoc_md150"/>
193-
<a href="equations.html#autotoc_md152"/>
192+
<a href="equations.html#autotoc_md151"/>
194193
<a href="equations.html#autotoc_md153"/>
195194
<a href="equations.html#autotoc_md154"/>
196-
<a href="equations.html#autotoc_md156"/>
197-
<a href="equations.html#autotoc_md158"/>
198-
<a href="equations.html#autotoc_md160"/>
195+
<a href="equations.html#autotoc_md155"/>
196+
<a href="equations.html#autotoc_md157"/>
197+
<a href="equations.html#autotoc_md159"/>
199198
<a href="equations.html#autotoc_md161"/>
200199
<a href="equations.html#autotoc_md162"/>
201-
<a href="equations.html#autotoc_md164"/>
202-
<a href="equations.html#autotoc_md166"/>
203-
<a href="equations.html#autotoc_md168"/>
204-
<a href="equations.html#autotoc_md170"/>
200+
<a href="equations.html#autotoc_md163"/>
201+
<a href="equations.html#autotoc_md165"/>
202+
<a href="equations.html#autotoc_md167"/>
203+
<a href="equations.html#autotoc_md169"/>
205204
<a href="equations.html#autotoc_md171"/>
206205
<a href="equations.html#autotoc_md172"/>
207206
<a href="equations.html#autotoc_md173"/>
@@ -217,14 +216,28 @@
217216
<a href="equations.html#autotoc_md183"/>
218217
<a href="equations.html#autotoc_md184"/>
219218
<a href="equations.html#autotoc_md185"/>
220-
<a href="equations.html#autotoc_md187"/>
219+
<a href="equations.html#autotoc_md186"/>
221220
<a href="equations.html#autotoc_md188"/>
222221
<a href="equations.html#autotoc_md189"/>
223222
<a href="equations.html#autotoc_md190"/>
224-
<a href="equations.html#autotoc_md192"/>
225-
<a href="equations.html#autotoc_md194"/>
223+
<a href="equations.html#autotoc_md191"/>
224+
<a href="equations.html#autotoc_md193"/>
225+
<a href="equations.html#autotoc_md195"/>
226+
<a href="equations.html#sec-bubble-example"/>
227+
<a href="equations.html#sec-bubble-nondim"/>
228+
<a href="equations.html#sec-dimensional-handling"/>
229+
<a href="equations.html#sec-dimensions-in-out"/>
230+
<a href="equations.html#sec-flow-params-bubbles"/>
231+
<a href="equations.html#sec-material-values"/>
232+
<a href="equations.html#sec-nondim-bubble-dynamics"/>
233+
<a href="equations.html#sec-nondim-example"/>
234+
<a href="equations.html#sec-nondim-inputs"/>
235+
<a href="equations.html#sec-reference-scales"/>
236+
<a href="equations.html#sec-stored-forms"/>
237+
<a href="equations.html#sec-two-viscosities"/>
238+
<a href="equations.html#sec-unit-consistency"/>
239+
<a href="equations.html#sec-units-dimensions"/>
226240
<a href="examples.html"/>
227-
<a href="examples.html#autotoc_md195"/>
228241
<a href="examples.html#autotoc_md196"/>
229242
<a href="examples.html#autotoc_md197"/>
230243
<a href="examples.html#autotoc_md198"/>
@@ -287,15 +300,15 @@
287300
<a href="examples.html#autotoc_md255"/>
288301
<a href="examples.html#autotoc_md256"/>
289302
<a href="examples.html#autotoc_md257"/>
303+
<a href="examples.html#autotoc_md258"/>
290304
<a href="expectedPerformance.html"/>
291-
<a href="expectedPerformance.html#autotoc_md258"/>
292-
<a href="expectedPerformance.html#autotoc_md260"/>
305+
<a href="expectedPerformance.html#autotoc_md259"/>
293306
<a href="expectedPerformance.html#autotoc_md261"/>
294307
<a href="expectedPerformance.html#autotoc_md262"/>
295308
<a href="expectedPerformance.html#autotoc_md263"/>
296309
<a href="expectedPerformance.html#autotoc_md264"/>
297310
<a href="expectedPerformance.html#autotoc_md265"/>
298-
<a href="expectedPerformance.html#autotoc_md267"/>
311+
<a href="expectedPerformance.html#autotoc_md266"/>
299312
<a href="expectedPerformance.html#autotoc_md268"/>
300313
<a href="expectedPerformance.html#autotoc_md269"/>
301314
<a href="expectedPerformance.html#autotoc_md270"/>
@@ -306,8 +319,8 @@
306319
<a href="expectedPerformance.html#autotoc_md275"/>
307320
<a href="expectedPerformance.html#autotoc_md276"/>
308321
<a href="expectedPerformance.html#autotoc_md277"/>
322+
<a href="expectedPerformance.html#autotoc_md278"/>
309323
<a href="getting-started.html"/>
310-
<a href="getting-started.html#autotoc_md278"/>
311324
<a href="getting-started.html#autotoc_md279"/>
312325
<a href="getting-started.html#autotoc_md280"/>
313326
<a href="getting-started.html#autotoc_md281"/>
@@ -319,17 +332,17 @@
319332
<a href="getting-started.html#autotoc_md287"/>
320333
<a href="getting-started.html#autotoc_md288"/>
321334
<a href="getting-started.html#autotoc_md289"/>
335+
<a href="getting-started.html#autotoc_md290"/>
336+
<a href="getting-started.html#autotoc_md291"/>
322337
<a href="gpuParallelization.html"/>
323-
<a href="gpuParallelization.html#autotoc_md290"/>
324338
<a href="gpuParallelization.html#autotoc_md292"/>
325-
<a href="gpuParallelization.html#autotoc_md293"/>
326339
<a href="gpuParallelization.html#autotoc_md294"/>
340+
<a href="gpuParallelization.html#autotoc_md295"/>
327341
<a href="gpuParallelization.html#autotoc_md296"/>
328342
<a href="gpuParallelization.html#autotoc_md298"/>
329343
<a href="gpuParallelization.html#autotoc_md300"/>
330344
<a href="gpuParallelization.html#autotoc_md302"/>
331345
<a href="gpuParallelization.html#autotoc_md304"/>
332-
<a href="gpuParallelization.html#autotoc_md305"/>
333346
<a href="gpuParallelization.html#autotoc_md306"/>
334347
<a href="gpuParallelization.html#autotoc_md307"/>
335348
<a href="gpuParallelization.html#autotoc_md308"/>
@@ -339,25 +352,26 @@
339352
<a href="gpuParallelization.html#autotoc_md312"/>
340353
<a href="gpuParallelization.html#autotoc_md313"/>
341354
<a href="gpuParallelization.html#autotoc_md314"/>
355+
<a href="gpuParallelization.html#autotoc_md315"/>
356+
<a href="gpuParallelization.html#autotoc_md316"/>
342357
<a href="graph_legend.html"/>
343358
<a href="index.html"/>
344-
<a href="index.html#autotoc_md425"/>
345-
<a href="index.html#autotoc_md426"/>
346359
<a href="index.html#autotoc_md427"/>
347360
<a href="index.html#autotoc_md428"/>
348361
<a href="index.html#autotoc_md429"/>
349362
<a href="index.html#autotoc_md430"/>
363+
<a href="index.html#autotoc_md431"/>
364+
<a href="index.html#autotoc_md432"/>
350365
<a href="pages.html"/>
351366
<a href="papers.html"/>
352-
<a href="papers.html#autotoc_md315"/>
367+
<a href="papers.html#autotoc_md317"/>
353368
<a href="parameters.html"/>
354369
<a href="parameters.html#acoustic"/>
355370
<a href="parameters.html#alpha_rho_e_wrt"/>
356371
<a href="parameters.html#alpha_rho_wrt"/>
357372
<a href="parameters.html#alpha_wrt"/>
358-
<a href="parameters.html#autotoc_md316"/>
359-
<a href="parameters.html#autotoc_md317"/>
360373
<a href="parameters.html#autotoc_md318"/>
374+
<a href="parameters.html#autotoc_md319"/>
361375
<a href="parameters.html#autotoc_md320"/>
362376
<a href="parameters.html#autotoc_md322"/>
363377
<a href="parameters.html#autotoc_md324"/>
@@ -370,17 +384,18 @@
370384
<a href="parameters.html#autotoc_md338"/>
371385
<a href="parameters.html#autotoc_md340"/>
372386
<a href="parameters.html#autotoc_md342"/>
373-
<a href="parameters.html#autotoc_md346"/>
387+
<a href="parameters.html#autotoc_md344"/>
374388
<a href="parameters.html#autotoc_md348"/>
375389
<a href="parameters.html#autotoc_md350"/>
376390
<a href="parameters.html#autotoc_md352"/>
377391
<a href="parameters.html#autotoc_md354"/>
378392
<a href="parameters.html#autotoc_md356"/>
379-
<a href="parameters.html#autotoc_md359"/>
393+
<a href="parameters.html#autotoc_md358"/>
380394
<a href="parameters.html#autotoc_md361"/>
381395
<a href="parameters.html#autotoc_md363"/>
382396
<a href="parameters.html#autotoc_md365"/>
383-
<a href="parameters.html#autotoc_md374"/>
397+
<a href="parameters.html#autotoc_md367"/>
398+
<a href="parameters.html#autotoc_md376"/>
384399
<a href="parameters.html#bc_x"/>
385400
<a href="parameters.html#bc_y"/>
386401
<a href="parameters.html#bc_z"/>
@@ -410,122 +425,122 @@
410425
<a href="parameters.html#z_domain"/>
411426
<a href="parameters.html#z_output"/>
412427
<a href="physics_constraints.html"/>
413-
<a href="physics_constraints.html#autotoc_md375"/>
414428
<a href="physics_constraints.html#autotoc_md377"/>
415-
<a href="physics_constraints.html#autotoc_md378"/>
416429
<a href="physics_constraints.html#autotoc_md379"/>
417430
<a href="physics_constraints.html#autotoc_md380"/>
431+
<a href="physics_constraints.html#autotoc_md381"/>
418432
<a href="physics_constraints.html#autotoc_md382"/>
419-
<a href="physics_constraints.html#autotoc_md383"/>
420433
<a href="physics_constraints.html#autotoc_md384"/>
434+
<a href="physics_constraints.html#autotoc_md385"/>
421435
<a href="physics_constraints.html#autotoc_md386"/>
422-
<a href="physics_constraints.html#autotoc_md387"/>
423436
<a href="physics_constraints.html#autotoc_md388"/>
424437
<a href="physics_constraints.html#autotoc_md389"/>
438+
<a href="physics_constraints.html#autotoc_md390"/>
425439
<a href="physics_constraints.html#autotoc_md391"/>
426-
<a href="physics_constraints.html#autotoc_md392"/>
440+
<a href="physics_constraints.html#autotoc_md393"/>
427441
<a href="physics_constraints.html#autotoc_md394"/>
428-
<a href="physics_constraints.html#autotoc_md395"/>
442+
<a href="physics_constraints.html#autotoc_md396"/>
429443
<a href="physics_constraints.html#autotoc_md397"/>
430-
<a href="physics_constraints.html#autotoc_md398"/>
444+
<a href="physics_constraints.html#autotoc_md399"/>
431445
<a href="physics_constraints.html#autotoc_md400"/>
432-
<a href="physics_constraints.html#autotoc_md401"/>
433446
<a href="physics_constraints.html#autotoc_md402"/>
434447
<a href="physics_constraints.html#autotoc_md403"/>
448+
<a href="physics_constraints.html#autotoc_md404"/>
435449
<a href="physics_constraints.html#autotoc_md405"/>
436-
<a href="physics_constraints.html#autotoc_md406"/>
437450
<a href="physics_constraints.html#autotoc_md407"/>
438451
<a href="physics_constraints.html#autotoc_md408"/>
439452
<a href="physics_constraints.html#autotoc_md409"/>
440453
<a href="physics_constraints.html#autotoc_md410"/>
441454
<a href="physics_constraints.html#autotoc_md411"/>
455+
<a href="physics_constraints.html#autotoc_md412"/>
442456
<a href="physics_constraints.html#autotoc_md413"/>
443-
<a href="physics_constraints.html#autotoc_md414"/>
444457
<a href="physics_constraints.html#autotoc_md415"/>
445458
<a href="physics_constraints.html#autotoc_md416"/>
446459
<a href="physics_constraints.html#autotoc_md417"/>
460+
<a href="physics_constraints.html#autotoc_md418"/>
447461
<a href="physics_constraints.html#autotoc_md419"/>
448-
<a href="physics_constraints.html#autotoc_md420"/>
462+
<a href="physics_constraints.html#autotoc_md421"/>
449463
<a href="physics_constraints.html#autotoc_md422"/>
450-
<a href="physics_constraints.html#autotoc_md423"/>
451464
<a href="physics_constraints.html#autotoc_md424"/>
465+
<a href="physics_constraints.html#autotoc_md425"/>
466+
<a href="physics_constraints.html#autotoc_md426"/>
452467
<a href="running.html"/>
453-
<a href="running.html#autotoc_md431"/>
454-
<a href="running.html#autotoc_md432"/>
468+
<a href="running.html#autotoc_md433"/>
455469
<a href="running.html#autotoc_md434"/>
456470
<a href="running.html#autotoc_md436"/>
457-
<a href="running.html#autotoc_md437"/>
458471
<a href="running.html#autotoc_md438"/>
459472
<a href="running.html#autotoc_md439"/>
460473
<a href="running.html#autotoc_md440"/>
461474
<a href="running.html#autotoc_md441"/>
462475
<a href="running.html#autotoc_md442"/>
463476
<a href="running.html#autotoc_md443"/>
464477
<a href="running.html#autotoc_md444"/>
478+
<a href="running.html#autotoc_md445"/>
465479
<a href="running.html#autotoc_md446"/>
466-
<a href="running.html#autotoc_md447"/>
467480
<a href="running.html#autotoc_md448"/>
468481
<a href="running.html#autotoc_md449"/>
469482
<a href="running.html#autotoc_md450"/>
470483
<a href="running.html#autotoc_md451"/>
484+
<a href="running.html#autotoc_md452"/>
471485
<a href="running.html#autotoc_md453"/>
472486
<a href="running.html#autotoc_md455"/>
487+
<a href="running.html#autotoc_md457"/>
473488
<a href="testing.html"/>
474-
<a href="testing.html#autotoc_md456"/>
475-
<a href="testing.html#autotoc_md457"/>
476489
<a href="testing.html#autotoc_md458"/>
490+
<a href="testing.html#autotoc_md459"/>
491+
<a href="testing.html#autotoc_md460"/>
477492
<a href="troubleshooting.html"/>
478-
<a href="troubleshooting.html#autotoc_md459"/>
479-
<a href="troubleshooting.html#autotoc_md460"/>
480493
<a href="troubleshooting.html#autotoc_md461"/>
481494
<a href="troubleshooting.html#autotoc_md462"/>
482495
<a href="troubleshooting.html#autotoc_md463"/>
496+
<a href="troubleshooting.html#autotoc_md464"/>
483497
<a href="troubleshooting.html#autotoc_md465"/>
484-
<a href="troubleshooting.html#autotoc_md466"/>
485498
<a href="troubleshooting.html#autotoc_md467"/>
486499
<a href="troubleshooting.html#autotoc_md468"/>
500+
<a href="troubleshooting.html#autotoc_md469"/>
487501
<a href="troubleshooting.html#autotoc_md470"/>
488-
<a href="troubleshooting.html#autotoc_md471"/>
489502
<a href="troubleshooting.html#autotoc_md472"/>
490503
<a href="troubleshooting.html#autotoc_md473"/>
491504
<a href="troubleshooting.html#autotoc_md474"/>
492505
<a href="troubleshooting.html#autotoc_md475"/>
506+
<a href="troubleshooting.html#autotoc_md476"/>
493507
<a href="troubleshooting.html#autotoc_md477"/>
494-
<a href="troubleshooting.html#autotoc_md478"/>
495508
<a href="troubleshooting.html#autotoc_md479"/>
496509
<a href="troubleshooting.html#autotoc_md480"/>
497510
<a href="troubleshooting.html#autotoc_md481"/>
511+
<a href="troubleshooting.html#autotoc_md482"/>
498512
<a href="troubleshooting.html#autotoc_md483"/>
499-
<a href="troubleshooting.html#autotoc_md484"/>
500513
<a href="troubleshooting.html#autotoc_md485"/>
501514
<a href="troubleshooting.html#autotoc_md486"/>
502515
<a href="troubleshooting.html#autotoc_md487"/>
503516
<a href="troubleshooting.html#autotoc_md488"/>
517+
<a href="troubleshooting.html#autotoc_md489"/>
504518
<a href="troubleshooting.html#autotoc_md490"/>
505-
<a href="troubleshooting.html#autotoc_md491"/>
506519
<a href="troubleshooting.html#autotoc_md492"/>
507520
<a href="troubleshooting.html#autotoc_md493"/>
521+
<a href="troubleshooting.html#autotoc_md494"/>
508522
<a href="troubleshooting.html#autotoc_md495"/>
509-
<a href="troubleshooting.html#autotoc_md496"/>
510523
<a href="troubleshooting.html#autotoc_md497"/>
511524
<a href="troubleshooting.html#autotoc_md498"/>
512525
<a href="troubleshooting.html#autotoc_md499"/>
513526
<a href="troubleshooting.html#autotoc_md500"/>
527+
<a href="troubleshooting.html#autotoc_md501"/>
514528
<a href="troubleshooting.html#autotoc_md502"/>
515-
<a href="troubleshooting.html#autotoc_md503"/>
516529
<a href="troubleshooting.html#autotoc_md504"/>
517530
<a href="troubleshooting.html#autotoc_md505"/>
518531
<a href="troubleshooting.html#autotoc_md506"/>
532+
<a href="troubleshooting.html#autotoc_md507"/>
519533
<a href="troubleshooting.html#autotoc_md508"/>
534+
<a href="troubleshooting.html#autotoc_md510"/>
520535
<a href="visualization.html"/>
521-
<a href="visualization.html#autotoc_md509"/>
522-
<a href="visualization.html#autotoc_md510"/>
523536
<a href="visualization.html#autotoc_md511"/>
524537
<a href="visualization.html#autotoc_md512"/>
525538
<a href="visualization.html#autotoc_md513"/>
526539
<a href="visualization.html#autotoc_md514"/>
527540
<a href="visualization.html#autotoc_md515"/>
528541
<a href="visualization.html#autotoc_md516"/>
529542
<a href="visualization.html#autotoc_md517"/>
543+
<a href="visualization.html#autotoc_md518"/>
544+
<a href="visualization.html#autotoc_md519"/>
530545
</body>
531546
</html>

0 commit comments

Comments
 (0)