Skip to content

Commit 72639c4

Browse files
committed
docs: add m_particle_bed module brief, category, and num_particle_beds param description
1 parent 5bb2160 commit 72639c4

4 files changed

Lines changed: 5 additions & 0 deletions

File tree

docs/documentation/case.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ This is enabled by adding ``'elliptic_smoothing': "T",`` and ``'elliptic_smoothi
312312
| Parameter | Type | Description |
313313
| ---: | :----: | :--- |
314314
| `num_ibs` | Integer | Number of immersed boundary patches |
315+
| `num_particle_beds` | Integer | Number of particle bed specifications to generate immersed boundary patches from |
315316
| `ib_neighborhood_radius` | Integer | Parameter that controls the neighborhood size for IB detection. |
316317
| `geometry` | Integer | Geometry configuration of the patch.|
317318
| `x[y,z]_centroid` | Real | Centroid of the applied geometry in the [x,y,z]-direction. |

docs/module_categories.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"m_compute_cbc",
3939
"m_boundary_common",
4040
"m_ibm",
41+
"m_particle_bed",
4142
"m_igr",
4243
"m_ib_patches",
4344
"m_compute_levelset"

src/simulation/m_particle_bed.fpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
!! @brief Generates particle beds: converts particle_bed specifications into
44
!! individual sphere/circle patch_ib entries before MPI broadcast.
55

6+
!> @brief Generates particle beds by converting particle_bed patch specifications into individual immersed boundary patches before
7+
!! MPI broadcast.
68
module m_particle_bed
79

810
use m_global_parameters

toolchain/mfc/params/descriptions.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@
133133
# Immersed boundaries
134134
"ib": "Enable immersed boundary method",
135135
"num_ibs": "Number of immersed boundary patches",
136+
"num_particle_beds": "Number of particle bed specifications to generate immersed boundary patches from",
136137
"ib_neighborhood_radius": "Neighborhood radius in ranks for IB awareness",
137138
# Acoustic sources
138139
"acoustic_source": "Enable acoustic source terms",

0 commit comments

Comments
 (0)