Skip to content

Commit 96199c9

Browse files
authored
Add documentation for immersed boundaries (#343)
1 parent 4c162bc commit 96199c9

File tree

1 file changed

+56
-7
lines changed

1 file changed

+56
-7
lines changed

docs/documentation/case.md

Lines changed: 56 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,43 @@ See also `adv_alphan` in table [Simulation Algorithm Parameters](#5-simulation-a
270270

271271
- 'model%scale', 'model%rotate` and `model%translate` define how the model should be transformed to domain-space by first scaling by `model%scale`, then rotating about the Z, X, and Y axes (using `model%rotate`), and finally translating by `model%translate`.
272272

273-
### 4. Fluid Material’s
273+
### 4. Immersed Boundary Patches
274+
275+
| Parameter | Type | Analytical Definition Description |
276+
| ---: | :----: | :----: |
277+
| `geometry` | Integer | Geometry configuration of the patch.|
278+
| `x[y,z]_centroid` | Real | Centroid of the applied geometry in the [x,y,z]-direction. |
279+
| `length_x[y,z]` | Real | Length, if applicable, in the [x,y,z]-direction. |
280+
| `radius` | Real | Radius, if applicable, of the applied geometry. |
281+
| `theta` | Real | Angle of attach applied to airfoil IB patches |
282+
| `c` | Real |
283+
| `t` | Real |
284+
| `m` | Real |
285+
| `p` | Real |
286+
| `slip` | Logical | Apply a slip boundary |
287+
288+
These parameters should be prepended with `patch_ib(j)%` where $j$ is the patch index.
289+
290+
#### Parameter Descriptions
291+
292+
- `geometry` defines the type of geometry of a patch with an integer number.
293+
Definitions for currently implemented patch types are list in table [Immersed Boundary Patch Type](#immersed-boundary-patch-types)
294+
295+
- `x[y,z]_centroid` is the centroid location of the patch in the x[y,z]-direction
296+
297+
- `length_x[y,z]` is the length of the patch in the x[y,z]-direction.
298+
299+
- `radius` is the radius to be used for circular patches.
300+
301+
- `theta` allows for the angle of attach of airfoil patches to be changed.
302+
303+
- `c`, `t`, `p`, and `m` specify the parameters for a NACA airfoil.
304+
`m` is the maximum camber, `p` is the location of maximum camber, `c` is the coord length, and `t` is the thickness.
305+
Additional details on this specification can be found in [The Naca Airfoil Series](https://web.stanford.edu/~cantwell/AA200_Course_Material/The%20NACA%20airfoil%20series.pdf)
306+
307+
- `slip` applies a slip boundary to the surface of the patch if true and a no-slip boundary condition to the surface if false.
308+
309+
### 5. Fluid Material’s
274310

275311
| Parameter | Type | Description |
276312
| ---: | :----: | :--- |
@@ -300,7 +336,7 @@ Details of implementation of viscosity in MFC can be found in [Coralic (2015)](r
300336

301337
- `fluid_pp(i)%cv`, `fluid_pp(i)%qv`, and `fluid_pp(i)%qvp` define $c_v$, $q$, and $q'$ as parameters of $i$-th fluid that are used in stiffened gas equation of state.
302338

303-
### 5. Simulation Algorithm
339+
### 6. Simulation Algorithm
304340

305341
| Parameter | Type | Description |
306342
| ---: | :----: | :--- |
@@ -392,7 +428,7 @@ If this option is false, velocity gradient is computed using finite difference s
392428
This option requires `weno_Re_flux` to be true because cell boundary values are only utilized when employing the scalar divergence method in the computation of velocity gradients.
393429

394430

395-
### 6. Formatted Output
431+
### 7. Formatted Output
396432

397433
| Parameter | Type | Description |
398434
| ---: | :----: | :--- |
@@ -450,7 +486,7 @@ If `file_per_process` is true, then pre_process, simulation, and post_process mu
450486
- `probe_wrt` activates output of state variables at coordinates specified by `probe(i)%[x;y,z]`.
451487

452488

453-
### 7. Acoustic Source
489+
### 8. Acoustic Source
454490

455491
| Parameter | Type | Description |
456492
| ---: | :----: | :--- |
@@ -495,7 +531,7 @@ There are a few additional spatial support types available for special source ty
495531
- `Mono(i)%support_width` defines how many cell width the monopole support function extended by.
496532
Large `Mono(i)%support_width` is preferred when `Mono(i)%mag` is large.
497533

498-
### 8. Ensemble-Averaged Bubble Model
534+
### 9. Ensemble-Averaged Bubble Model
499535

500536
| Parameter | Type | Description |
501537
| ---: | :----: | :--- |
@@ -571,7 +607,7 @@ Implementation of the parameters into the model follow [Ando (2010)](references.
571607

572608
- `rhoRV` specifies the correlation coefficient of the joint PDF of bubble radius and bubble velocity required in qbmm.
573609

574-
### 9. Velocity Field Setup
610+
### 10. Velocity Field Setup
575611

576612
| Parameter | Type | Description |
577613
| ---: | :----: | :--- |
@@ -601,7 +637,7 @@ The parameters are optionally used to define initial velocity profiles and pertu
601637
- `instability_wave` activates the perturbation of initial velocity by instability waves obtained from linear stability analysis for a mixing layer with hyperbolic tangent mean streamwise velocity profile.
602638
This option only works for 2D and 3D cases, together with `vel_profile = TRUE`.
603639

604-
### 10. Phase Change Model
640+
### 11. Phase Change Model
605641
| Parameter | Type | Description |
606642
| ---: | :----: | :--- |
607643
| `relax` | Logical | Activates Phase Change model |
@@ -676,6 +712,19 @@ This includes types exclusive to one-, two-, and three-dimensional problems.
676712
The patch type number (`#`) corresponds to the input value in `input.py` labeled `patch_icpp(j)%geometry` where $j$ is the patch index.
677713
Each patch requires a different set of parameters, which are also listed in this table.
678714

715+
### Immersed Boundary Patch Types
716+
717+
| # | Name | Dim. |
718+
| ---: | :----: | :--- |
719+
| 2 | 2D Circle | 2 |
720+
| 3 | 2D Rectangle | 2 |
721+
| 4 | 2D Airfoil | 2 |
722+
| 8 | 3D Sphere | 3 |
723+
| 10 | 3D Cylinder | 3 |
724+
| 11 | 3D Airfoil | 3 |
725+
726+
727+
679728
### Monopole supports
680729

681730
| # | Description |

0 commit comments

Comments
 (0)