Skip to content

Commit 498b0f6

Browse files
authored
Merge pull request #100 from wilfonba/variablesDocumentation
2 parents 2b4f815 + 12ed0e2 commit 498b0f6

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

docs/documentation/running.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,12 @@ The entries labeled "Characteristic." are characteristic boundary conditions bas
422422
| 11 | Sweep plane | 3 | Y | Not coordinate-aligned. Requires `x[y,z]_centroid` and `normal(i)`. |
423423
| 12 | Ellipsoid | 3 | Y | Requires `[x,y,z]_centroid` and `radii(i)`. |
424424
| 13 | 3D analytical | 3 | N | Assigns the primitive variables as analytical functions |
425+
| 14 | Spherical Harmonic | 3 | N | Requires `[x,y,z]_centroid`, `radius`, `epsilon`, `beta` |
426+
| 15 | 1D analytical | 1 | N | Assigns the primitive variables as analytical functions |
427+
| 16 | 1D bubble pulse | 1 | N | Requires `x_centroid`, `length_x` |
428+
| 17 | Spiral | 2 | N | Requires `[x,y]_centroid` |
429+
| 18 | 2D Varcircle | 2 | Y | Requires `[x,y]_centroid`, `radius`, and `thickness` |
430+
| 19 | 3D Varcircle | 3 | Y | Requires `[x,y,z]_centroid`, `length_z`, `radius`, and `thickness` |
425431

426432
The patch types supported by the MFC are listed in table [Patch Types](#patch-types). This includes
427433
types exclusive to one-, two-, and three-dimensional problems. The patch type number (`#`)
@@ -446,7 +452,7 @@ The flux limiters supported by the MFC are listed in table [Flux Limiters](#flux
446452
### Monopole supports
447453

448454
| # | Description |
449-
| ---: | :---- |
455+
| --- | ---- |
450456
| 1 | 1D normal to x-axis |
451457
| 2 | 2D semi-infinite source plane |
452458
| 3 | 3D semi-infinite source plane along some lines |
@@ -458,6 +464,44 @@ The monopole support types available in MFC are listed in table [Monopole suppor
458464
types exclusive to one-, two-, and three-dimensional problems with special souce geometry like transducers as well as coordinate systems such as cylindrical coordinates. The monopole support number (`#`) corresponds to the input value in `input.py` labeled `Mono(i)%support` where
459465
$i$ is the monopole source index.
460466

467+
### Conservative Variables Ordering
468+
469+
| 5-eqn | 6-eqn |
470+
| ---- | ---- |
471+
| num_fluids continuity variables | num_fluids continuity variables |
472+
| num_dims momentum variables | num_dims momentum variables |
473+
| 1 energy variable | 1 energy variable |
474+
| num_fluids advection variables | num_fluids advection variables |
475+
| N/A | num_fluids internal energy variables |
476+
477+
The above variables are used for all simulations:
478+
479+
| 5-eqn | 6-eqn |
480+
| ---- | ---- |
481+
| sub-grid bubble variables | N/A |
482+
| hypoelastic variables | N/A |
483+
484+
The above variables correspond to optional physics:
485+
486+
### Primitive Variables Ordering
487+
488+
| 5-eqn | 6-eqn |
489+
| ---- | ---- |
490+
| num_fluids densities | num_fluids densities |
491+
| num_dims velocities | num_dims velocities |
492+
| 1 pressure | 1 pressure |
493+
| num_fluids volume fractions | num_fluids volume fractions |
494+
| N/A | num_fluids partial pressures |
495+
496+
The above variables are used for all simualtions:
497+
498+
| 5-eqn | 6-eqn |
499+
| ---- | ---- |
500+
| sub-grid bubble variables | N/A |
501+
| hypoelastic variables | N/A |
502+
503+
The above variables correspond to optional physics:
504+
461505
## Running
462506

463507
MFC can be run using `mfc.sh`'s `run` command. It supports both interactive and

src/common/m_derived_types.mod

-550 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)