Model Reference Guide
Parameters
This page defines the configurable parameters available in FastEddy®. Parameters are organized into logical sets by model feature or model configuration component.
Each table provides the:
Parameter name: Description
Minimum value (if applicable)
Maximum value (if applicable)
Default value (if applicable)
Req. (Requirement)
M (Mandatory)
O (Optional)
C-M (Conditionally Mandatory, with the condition listed in the description)
C-O (Conditionally Optional, with the condition listed in the description)
These definitions serve as a reference to ensure correct configuration and valid inputs for FastEddy simulations.
FEMPI
Parameter Name: Description |
Min |
Max |
Default |
Req. |
|---|---|---|---|---|
numProcsX: |
1 |
INT_MAX |
1 |
M |
numProcsY: |
1 |
INT_MAX |
1 |
M |
FECUDA
tBx: |
1 |
INT_MAX |
1 |
M |
tBy: |
1 |
INT_MAX |
8 |
M |
tBz: |
1 |
INT_MAX |
32 |
M |
IO
inPath: |
N/A |
N/A |
O |
|
inFile: |
N/A |
N/A |
O |
|
outPath: |
N/A |
N/A |
M |
|
outFileBase: |
N/A |
N/A |
M |
|
frqOutput: |
0 |
INT_MAX |
M |
|
ioOutputMode: |
0 |
1 |
0 |
O |
towerIOSelector |
0 |
1 |
0 |
O |
towerPath |
N/A |
N/A |
C-M |
|
towerSpecsFile |
N/A |
N/A |
C-M |
GRID
Nx: |
1 |
INT_MAX |
128 |
M |
Ny: |
1 |
INT_MAX |
122 |
M |
Nz: |
1 |
INT_MAX |
122 |
M |
Nh: |
0 |
INT_MAX |
3 |
M |
d_xi: |
FLT_MIN |
FLT_MAX |
10.0 |
M |
d_eta: |
FLT_MIN |
FLT_MAX |
10.0 |
M |
d_zeta: |
FLT_MIN |
FLT_MAX |
10.0 |
M |
coordHorizHalos: |
0 |
1 |
1 |
M |
topoFile: |
N/A |
N/A |
O |
|
verticalDeformSwitch: |
0 |
1 |
M |
|
verticalDeformFactor: |
0.0 |
1.0 |
M |
|
verticalDeformQuadCoeff: |
-2.0 |
2.0 |
0.0 |
M |
TIME INTEGRATION
timeMethod: |
0 |
0 |
0 |
O |
Nt: |
1 |
INT_MAX |
1000 |
M |
dt: |
FLT_MIN |
FLT_MAX |
1.0 |
M |
NtBatch: |
1 |
Nt |
1 |
M |
HYDRO CORE
BOUNDARY CONDITIONS
hydroBCs: |
1 |
2 |
2 |
M |
ceilingAdvectionBC: |
0 |
1 |
0 |
O |
hydroBndysFileBase: |
N/A |
N/A |
C-M |
|
hydroBndysFileStart: |
0 |
500000 |
0 |
C-M |
hydroBndysFileEnd: |
0 |
500000 |
0 |
C-M |
dtBdyPlaneBCs: |
0.0 |
6e5 |
0.0 |
C-M |
HYDRO_IO/LOGGING
hydroForcingWrite: |
0 |
1 |
0 |
O |
hydroSubGridWrite: |
0 |
1 |
0 |
M |
hydroForcingLog: |
0 |
1 |
0 |
M |
ADVECTION
advectionSelector: |
0 |
6 |
3 |
O |
b_hyb: |
0.0 |
1.0 |
0.8 |
O; C-M |
MOISTURE
moistureSelector: |
0 |
1 |
0 |
M |
moistureNvars: |
0 |
2 |
0 |
C-M |
moistureAdvSelectorQv: |
0 |
6 |
0 |
C-M |
moistureAdvSelectorQv_b: |
0.0 |
1.0 |
0.0 |
C-M |
moistureAdvSelectorQi: |
0 |
2 |
0 |
C-M |
moistureSGSturb: |
0 |
1 |
0 |
C-M |
moistureCond: |
1 |
4 |
1 |
C-M |
moistureCondTscale: |
1e-4 |
1000.0 |
1.0 |
C-M |
moistureCondBasePres: |
0 |
1 |
0 |
C-M |
moistureMPcallTscale: |
1e-4 |
1000.0 |
1.0 |
C-M |
CORIOLIS
coriolisSelector: |
0 |
2 |
0 |
M |
coriolisLatitude: |
-90.0 |
90.0 |
54.0 |
M |
TURBULENCE
turbulenceSelector: |
0 |
1 |
0 |
M |
TKESelector: |
0 |
2 |
1 |
O |
TKEAdvSelector: |
0 |
6 |
0 |
O |
TKEAdvSelector_b_hyb: |
0.0 |
1.0 |
0.0 |
O |
c_s: |
1e-6 |
1e6 |
0.18 |
O |
c_k: |
1e-6 |
1e6 |
0.10 |
O |
CANOPY
canopySelector: |
0 |
1 |
0 |
O |
canopySkinOpt: |
0 |
1 |
0 |
C-M |
canopy_cd: |
0.0 |
1e+2 |
0.15 |
C-M |
canopy_lf: |
0.0 |
1e+2 |
0.1 |
C-M |
DIFFUSION
diffusionSelector: |
0 |
1 |
0 |
O |
nu_0: |
0 |
FLT_MAX |
1.0 |
O |
AUXILIARY SCALARS AND SOURCES
NhydroAuxScalars: |
0 |
256 |
0 |
O |
AuxScAdvSelector: |
0 |
6 |
0 |
C-M |
AuxScAdvSelector_b_hyb: |
0.0 |
1.0 |
0.0 |
C-M |
AuxScSGSturb: |
0 |
1 |
0 |
C-M |
srcAuxScFile: |
N/A |
N/A |
C-O |
|
srcAuxScTemporalType: |
0 |
1 |
0 |
C-M |
srcAuxScStartSeconds: |
0 |
FLT_MAX |
0 |
C-M |
srcAuxScDurationSeconds: |
0 |
FLT_MAX |
30 |
C-M |
srcAuxScGeometryType: |
0 |
0 |
0 |
C-M |
srcAuxScMassSpecType: |
0 |
0 |
0 |
C-M |
srcAuxScMassSpecValue: |
0.0 |
FLT_MAX |
1.0 |
C-M |
srcAuxScLocation_X: |
-FLT_MAX |
FLT_MAX |
0.0 |
C-M |
srcAuxScLocation_Y: |
-FLT_MAX |
FLT_MAX |
0.0 |
C-M |
srcAuxScLocation_Z: |
-FLT_MAX |
FLT_MAX |
0.0 |
C-M |
EXPLICIT FILTERS
filterSelector: |
0 |
1 |
0 |
O |
filter_6thdiff_vert: |
0 |
1 |
0 |
C-O |
filter_6thdiff_hori: |
0 |
1 |
0 |
C-O |
filter_6thdiff_vert_coeff: |
0.0 |
1.0 |
0.03 |
C-M |
filter_6thdiff_hori_coeff: |
0.0 |
1.0 |
0.03 |
C-M |
filter_divdamp: |
0 |
1 |
0 |
C-O |
RAYLEIGH DAMPING LAYER
dampingLayerSelector: |
0 |
1 |
0 |
O |
dampingLayerDepth: |
0.0 |
FLT_MAX |
100.0 |
C-O |
SURFACE LAYER
surflayerSelector: |
0 |
3 |
0 |
M |
surflayer_z0: |
1e-12 |
1e+0 |
0.1 |
M |
surflayer_z0t: |
1e-6 |
1e+1 |
0.1 |
M |
surflayer_z0tdyn: |
0 |
2 |
1 |
O |
surflayer_wth: |
-5e+0 |
5e+0 |
0.0 |
C-M |
surflayer_tr: |
-1e+1 |
1e+1 |
0.0 |
C-M |
surflayer_wq: |
-5e+0 |
5e+0 |
0.0 |
C-M |
surflayer_qr: |
-1e+1 |
1e+1 |
0.0 |
C-M |
surflayer_idealsine: |
0 |
1 |
0 |
O |
surflayer_ideal_ts: |
0 |
1e+5 |
0.0 |
C-M |
surflayer_ideal_te: |
0 |
1e+5 |
0.0 |
C-M |
surflayer_ideal_amp: |
0 |
1e+3 |
0.1 |
C-M |
surflayer_ideal_qts: |
0 |
1e+5 |
0.0 |
C-M |
surflayer_ideal_qte: |
0 |
1e+5 |
0.0 |
C-M |
surflayer_ideal_qamp: |
0 |
1e+3 |
0.1 |
C-M |
surflayer_qskin_input: |
0 |
1 |
0 |
C-O |
surflayer_offshore: |
0 |
1 |
1 |
O |
surflayer_offshore_visc: |
0 |
1 |
1 |
O |
surflayer_offshore_opt: |
0 |
5 |
4 |
O |
surflayer_offshore_dyn: |
0 |
1 |
1 |
C-O |
surflayer_offshore_hs: |
0 |
1e+2 |
0.0 |
C-M |
surflayer_offshore_lp: |
0.1 |
1e+3 |
0.1 |
C-M |
surflayer_offshore_cp: |
0.1 |
1e+2 |
0.1 |
C-M |
surflayer_offshore_theta: |
0.0 |
180.0 |
0.0 |
C-M |
CELL PERTURBATION METHOD
cellpertSelector: |
0 |
1 |
0 |
O |
cellpert_nts: |
0 |
1e+6 |
500 |
O |
cellpert_sw2b: |
0 |
3 |
0 |
C-O |
cellpert_amp: |
0.0 |
20.0 |
0.5 |
C-O |
cellpert_gppc: |
0 |
50 |
8 |
C-O |
cellpert_ndbc: |
0 |
10 |
3 |
C-O |
cellpert_kbottom: |
1 |
10 |
1 |
C-O |
cellpert_ktop: |
0 |
200 |
20 |
C-O |
cellpert_tvcp: |
0 |
1 |
0 |
C-O |
cellpert_eckert: |
0.0 |
10.0 |
0.2 |
C-O |
cellpert_tsfact: |
0.0 |
10.0 |
1.0 |
C-O |
BASE-STATE
stabilityScheme: |
1 |
2 |
2 |
M |
temp_grnd: |
FLT_MIN |
FLT_MAX |
300.0 |
M |
pres_grnd: |
FLT_MIN |
FLT_MAX |
1.0e5 |
M |
zStableBottom: |
0 |
FLT_MAX |
1000.0 |
M |
stableGradient: |
FLT_MIN |
FLT_MAX |
0.1 |
M |
zStableBottom2: |
0 |
FLT_MAX |
1100.0 |
M |
stableGradient2: |
FLT_MIN |
FLT_MAX |
0.03 |
M |
zStableBottom3: |
0 |
FLT_MAX |
1500.0 |
M |
stableGradient3: |
FLT_MIN |
FLT_MAX |
0.03 |
M |
thetaPerturbationSwitch: |
0 |
1 |
0 |
M |
thetaHeight: |
0.0 |
FLT_MAX |
0.0 |
M |
thetaAmplitude: |
0.0 |
2.0 |
0.0 |
M |
U_g: |
-FLT_MAX |
FLT_MAX |
0.0 |
M |
V_g: |
-FLT_MAX |
FLT_MAX |
0.0 |
M |
z_Ug: |
0.0 |
FLT_MAX |
10000.0 |
M |
z_Vg: |
0.0 |
FLT_MAX |
10000.0 |
M |
Ug_grad: |
-1e2 |
1e2 |
0.0 |
M |
Vg_grad: |
-1e2 |
1e2 |
0.0 |
M |
physics_oneRKonly: |
0 |
1 |
1 |
O |
LARGE SCALE FORCINGS
lsfSelector: |
0 |
1 |
0 |
M |
lsf_horMnSubTerms: |
0 |
1 |
0 |
C-M |
lsf_freq: |
1e-3 |
1e+3 |
1.0 |
C-M |
lsf_w_surf: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_w_lev1: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_w_lev2: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_w_zlev1: |
0.0 |
1e+4 |
100.0 |
C-M |
lsf_w_zlev2: |
0.0 |
1e+4 |
200.0 |
C-M |
lsf_th_surf: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_th_lev1: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_th_lev2: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_th_zlev1: |
0.0 |
1e+4 |
100.0 |
C-M |
lsf_th_zlev2: |
0.0 |
1e+4 |
200.0 |
C-M |
lsf_qv_surf: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_qv_lev1: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_qv_lev2: |
-1e+4 |
1e+4 |
0.0 |
C-M |
lsf_qv_zlev1: |
0.0 |
1e+4 |
100.0 |
C-M |
lsf_qv_zlev2: |
0.0 |
1e+4 |
200.0 |
C-M |
EXTENSIONS
GAD
GADSelector: |
0 |
1 |
0 |
O |
turbineSpecsFile: |
N/A |
N/A |
C-O |
|
GADoutputForces: |
0 |
1 |
0 |
C-O |
GADofflineForces: |
0 |
1 |
0 |
C-O |
GADaxialInduction: |
0 |
1 |
1 |
C-O |
GADaxialIndVal: |
0.0 |
1.0 |
0.02 |
C-O |
GADrefSwitch: |
0 |
1 |
0 |
C-O |
GADrefU: |
0.0 |
50.0 |
0.0 |
C-M |
GADrefSampleWindow: |
1.0 |
300.0 |
30.0 |
C-O |
GADrefSeriesLength: |
1 |
360 |
10 |
C-O |
GADForcingSwitch: |
0 |
1 |
0 |
C-O |
URBAN
urbanSelector: |
0 |
2 |
0 |
O |
cd_build: |
0.0 |
1e+8 |
100.0 |
C-O |
ct_build: |
0.0 |
1e+8 |
10.0 |
C-O |
urban_heatRedis: |
0 |
1 |
0 |
C-O |