Skip to content

Commit 82adb55

Browse files
sbryngelsonclaude
andcommitted
Add descriptions and docs for interfacial IC parameters
Required by lint_param_docs.py (merged in #1327): interface_file, normFac, normMag, g0_ic, p0_ic used by hcid 304/305 hardcoded ICs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 06ec049 commit 82adb55

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

docs/documentation/case.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,16 @@ Setup: Only requires specifying `init_dir` and filename pattern via `zeros_defau
266266
Implementation: All variables and file handling are managed in `src/common/include/ExtrusionHardcodedIC.fpp` with no manual grid configuration needed.
267267
Usage: Ideal for initializing simulations from lower-dimensional solutions, enabling users to add perturbations or modifications to the base extruded fields for flow instability studies.
268268

269+
The following parameters support hardcoded initial conditions that read interface data from files:
270+
271+
| Parameter | Type | Description |
272+
| ---: | :---: | :--- |
273+
| `interface_file` | String | Path to interface geometry data file |
274+
| `normFac` | Real | Interface normalization factor |
275+
| `normMag` | Real | Interface normal magnitude |
276+
| `g0_ic` | Real | Initial gas volume fraction for interfacial IC |
277+
| `p0_ic` | Real | Initial pressure for interfacial IC |
278+
269279
#### Parameter Descriptions
270280

271281
- `num_patches` defines the total number of patches defined in the domain.

toolchain/mfc/params/descriptions.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,12 @@
250250
"lag_mg_wrt": "Write bubble gas mass",
251251
"lag_betaT_wrt": "Write bubble heat transfer coefficient",
252252
"lag_betaC_wrt": "Write bubble mass transfer coefficient",
253+
# Interfacial flow parameters
254+
"interface_file": "Path to interface geometry data file",
255+
"normFac": "Interface normalization factor",
256+
"normMag": "Interface normal magnitude",
257+
"g0_ic": "Initial gas volume fraction for interfacial IC",
258+
"p0_ic": "Initial pressure for interfacial IC",
253259
}
254260

255261
# Patterns for auto-generating descriptions of indexed parameters

0 commit comments

Comments
 (0)