The installation below assumes you have already created a virtual python environment
pip install -r requirements.txt
Every line that starts with a !
represents the key to the dictionary when reading the file for computing time averages. For example, grid
can be used to access the grid information. Parameters below are in order corresponding to the list elements.
grid
: Computational grid pointsNx
- Number of grid points in xNx
- Number of grid points in yNx
- Number of grid points in zNks
- Number of grid points over the roughness heightks
domain
: Domain lengthlx
- Domain length in xly
- Domain length in ylz
- Domain length in zks
- Height of the roughness
ivisc
: Inverse of the the viscosity i.e., [Re
] Reynolds numbersaveinfo
: Information about simulation data savesniter
- Total number of iterations in the simulationsnsaves
- Frequency at which results are saved
wavecondition
: Wave forcing conditionsUb
- Wave orbital velocity in[m/s]
Tw
- Wave period is[s]
dts
- Results saved everydts
[s]
avginfo
: User input for averagingavgs
- At which index does the time averaging start?avge
- At which index does the time averaging end?