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/contributing.md
+20-3Lines changed: 20 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -148,7 +148,7 @@ Both human reviewers and AI code reviewers reference this section.
148
148
### Memory and Allocation
149
149
150
150
-**ALLOCATE/DEALLOCATE pairing:** Every `@:ALLOCATE()` must have a matching `@:DEALLOCATE()`. Missing deallocations leak GPU memory.
151
-
-**@:ACC_SETUP_VFs / @:ACC_SETUP_SFs:** Vector/scalar fields must have GPU pointer setup before use in kernels.
151
+
-**`@:ACC_SETUP_VFs` / `@:ACC_SETUP_SFs`:** Vector/scalar fields must have GPU pointer setup before use in kernels.
152
152
-**Conditional allocation:** If an array is allocated inside an `if` block, its deallocation must follow the same condition.
153
153
-**Out-of-bounds access:** Fortran is permissive with assumed-shape arrays. Check that index arithmetic stays within declared bounds.
154
154
@@ -212,10 +212,27 @@ Adding a parameter touches both the Python toolchain and Fortran source. Follow
212
212
Add a call to `_r()` inside the `_load()` function:
213
213
214
214
```python
215
-
_r("my_param", REAL, {"my_feature_tag"})
215
+
_r("my_param", REAL, {"my_feature_tag"},
216
+
desc="Description of the parameter",
217
+
math=r"\f$\xi\f$")
216
218
```
217
219
218
-
The arguments are: name, type (`INT`, `REAL`, `LOG`, `STR`), and a set of feature tags. You can add an explicit description with `desc="..."`, otherwise one is auto-generated from `_SIMPLE_DESCS` or `_ATTR_DESCS`.
220
+
The arguments are:
221
+
-**name**: parameter name (must match the Fortran namelist variable)
222
+
-**type**: `INT`, `REAL`, `LOG`, `STR`, or `A_REAL` (analytic expression)
223
+
-**tags**: set of feature tags for grouping (e.g. `{"bubbles"}`, `{"mhd"}`)
224
+
-**desc**: human-readable description (optional; auto-generated from `_SIMPLE_DESCS` or `_ATTR_DESCS` if omitted)
225
+
-**math**: LaTeX math symbol in Doxygen format (optional; shown in the Symbol column of @ref parameters)
226
+
227
+
For indexed families like `fluid_pp`, put the symbol next to its attribute name using tuples:
Copy file name to clipboardExpand all lines: docs/documentation/equations.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,8 @@ Each section notes the input parameter(s) that activate the corresponding physic
7
7
8
8
The models and algorithms described here are detailed in \cite Wilfong26 (MFC 5.0) and \cite Bryngelson21. Foundational references for each model are cited inline; see the \ref citelist "Bibliography" for full details.
9
9
10
+
For parameter details and allowed values, see @ref case "Case Files" and the @ref parameters "Case Parameters" reference.
0 commit comments