Reference / Input deck
Input deck
A whole deck: how to solve (solver) and what to solve (model).
config version
default 2
Configuration schema version. Only version 2 is supported.
Options
| Value | What it does | When to use it |
|---|---|---|
| 2 default | The current input format, against which the deck is validated. | Every deck sets it. A deck without |
A minimal deck
The keys every deck must set, with one boundary condition and one fluid zone. Each key links to its entry. Names in angle brackets are chosen by the deck, and ... marks optional keys left out.
control.py
parameters = {
"config version": 2,
"solver": {
"solver settings": {...},
"equations": {...},
"fluid properties": {...},
"initialisation": {...},
"time settings": {...},
"numerical scheme": {...},
"output settings": {...},
...
},
"model": {
"<mesh>": {
"mesh": <str>,
"<name>": {
"type": "wall",
"zones": [...],
...
},
},
"<name>": {
"type": "momentum",
...
},
},
...
},
},
}
- config version
- The deck format version. The only value accepted is
2. - solver
- Settings shared by every mesh. It must set
solver settings,equations,fluid properties,initialisation,time settings,numerical schemeandoutput settings.reference conditionsandconvergence controlare optional. - model
- One block per mesh, under a name of your choosing. Each must set
meshandboundary conditions, and may setfluid zonesandtransforms. Itsinitialisation,convergence control,numerical schemeandoutput settingsoverride the solver's blocks of the same name for that mesh.