You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/documentation/case.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -312,24 +312,16 @@ This is enabled by adding ``'elliptic_smoothing': "T",`` and ``'elliptic_smoothi
312
312
| Parameter | Type | Description |
313
313
| ---: | :----: | :--- |
314
314
|`num_ibs`| Integer | Number of immersed boundary patches |
315
+
|`num_stl_models`| Integer | Number of STL/OBJ model entries in the `stl_models` array |
315
316
|`num_particle_beds`| Integer | Number of particle bed specifications to generate immersed boundary patches from |
316
317
|`ib_neighborhood_radius`| Integer | Parameter that controls the neighborhood size for IB detection. |
317
318
|`geometry`| Integer | Geometry configuration of the patch.|
318
319
|`x[y,z]_centroid`| Real | Centroid of the applied geometry in the [x,y,z]-direction. |
319
320
|`length_x[y,z]`| Real | Length, if applicable, in the [x,y,z]-direction. |
320
321
|`radius`| Real | Radius, if applicable, of the applied geometry. |
321
-
|`theta`| Real | Angle of attach applied to airfoil IB patches |
322
-
|`c`| Real | NACA airfoil parameters (see below) |
323
-
|`t`| Real | NACA airfoil parameters (see below) |
324
-
|`m`| Real | NACA airfoil parameters (see below) |
325
-
|`p`| Real | NACA airfoil parameters (see below) |
322
+
|`airfoil_id`| Integer | Index into `ib_airfoil` array for NACA airfoil geometry patches. |
323
+
|`model_id`| Integer | Index into `stl_models` array for STL/OBJ geometry patches. |
326
324
|`slip`| Logical | Apply a slip boundary |
327
-
|`model_filepath`| String | Path to an STL or OBJ file (not all OBJs are supported). |
328
-
|`model_scale(i)`| Real | Model's (applied) scaling factor for component $i$. |
329
-
|`model_rotate(i)`| Real | Model's (applied) angle of rotation about axis $i$. |
330
-
|`model_translate(i)`| Real | Model's $i$-th component of (applied) translation. |
331
-
|`model_spc`| Integer | Number of samples per cell when discretizing the model into the grid. |
332
-
|`model_threshold`| Real | Ray fraction inside the model patch above which the fraction is set to one.|
333
325
|`moving_ibm`| Integer | Sets the method used for IB movement. |
334
326
|`vel(i)`| Real | Initial velocity of the moving IB in the i-th direction. |
335
327
|`angular_vel(i)`| Real | Initial angular velocity of the moving IB in the i-th direction. |
@@ -340,6 +332,17 @@ This is enabled by adding ``'elliptic_smoothing': "T",`` and ``'elliptic_smoothi
340
332
341
333
These parameters should be prepended with `patch_ib(j)%` where $j$ is the patch index.
342
334
335
+
STL/OBJ model geometry parameters are set on the `stl_models` array (indexed by `model_id`):
336
+
337
+
| Parameter | Type | Description |
338
+
|:---------------------|:--------|:------------|
339
+
|`model_filepath`| String | Path to an STL or OBJ file (not all OBJs are supported). |
340
+
|`model_scale(i)`| Real | Model's scaling factor for component $i$. |
341
+
|`model_translate(i)`| Real | Model's $i$-th component of translation. |
342
+
|`model_threshold`| Real | Winding number threshold above which a cell is marked as inside the model. |
343
+
344
+
These parameters should be prepended with `stl_models(k)%` where $k$ is the model index.
345
+
343
346
#### Parameter Descriptions
344
347
345
348
-`geometry` defines the type of geometry of an immersed boundary patch with an integer number.
@@ -351,15 +354,13 @@ Definitions for currently implemented immersed boundary patch types are listed i
351
354
352
355
-`radius` is the radius to be used for circular patches.
353
356
354
-
-`theta` allows for the angle of attach of airfoil patches to be changed.
355
-
356
-
-`c`, `t`, `p`, and `m` specify the parameters for a NACA airfoil.
357
-
`m` is the maximum camber, `p` is the location of maximum camber, `c` is the coord length, and `t` is the thickness.
357
+
-`c`, `t`, `p`, and `m` specify the parameters for a NACA airfoil (set on the referenced `ib_airfoil` entry).
358
+
`m` is the maximum camber, `p` is the location of maximum camber, `c` is the chord length, and `t` is the thickness.
358
359
Additional details on this specification can be found in [NACA airfoil](https://en.wikipedia.org/wiki/NACA_airfoil).
359
360
360
361
-`slip` applies a slip boundary to the surface of the patch if true and a no-slip boundary condition to the surface if false.
361
362
362
-
-Please see [Patch Parameters](#sec-patches) for the descriptions of `model_filepath`, `model_scale`, `model_rotate`, `model_translate`, `model_spc`, and `model_threshold`.
363
+
-For STL/OBJ geometry (geometry 5 or 12), set `model_id` to index into the `stl_models` array and specify `model_filepath`, `model_scale`, `model_translate`, and `model_threshold` on that entry.
363
364
364
365
-`moving_ibm` sets the method by which movement will be applied to the immersed boundary. Using 0 will result in no movement. Using 1 will result 1-way coupling where the boundary moves at a constant rate and applied forces to the fluid based upon it's own motion. In 1-way coupling, the fluid does not apply forces back onto the IB. Using 2 will result in 2-way coupling, where the boundary pushes on the fluid and the fluid pushes back on the boundary via pressure and viscous forces. If external forces are applied, the boundary will also experience those forces.
0 commit comments