Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
ae11a4c
Per #91, adding files for parameter table.
jprestop Sep 15, 2025
df2babe
Per #91, correcting csv file format by removing an additional comma
jprestop Sep 15, 2025
d41ccb6
Per #91, attempt to fix table formatting for option 2
jprestop Sep 15, 2025
757c5b3
Per #91, attempt to fix table formatting for option 2
jprestop Sep 15, 2025
d7a56fe
Per #91, attempt to fix header formatting for option 2
jprestop Sep 15, 2025
ac84cb7
Per #91, remove headers for tables since the names were the same as t…
jprestop Sep 15, 2025
ed8c19e
Per #91, renaming files, removing headers from all but femain, and ad…
jprestop Sep 15, 2025
708c73a
Per #91, removed additional commas
jprestop Sep 15, 2025
a922013
Per #91, adding a new column for defaults
jprestop Sep 15, 2025
a3b1c9b
Per #91, adjusting spacing
jprestop Sep 15, 2025
e88d1ce
Per #91, removing widths in favor of leaving them in custom.css file
jprestop Sep 15, 2025
d418178
Per #91, correcting femain to be fempi.
jprestop Sep 15, 2025
e76937c
Per #91, header column name change to Requirement.
jprestop Sep 15, 2025
21ac776
Per #91, updating to add defaults and conditional requirements
jprestop Sep 17, 2025
55833d8
Per #91, update top level description of parameters.
jprestop Sep 17, 2025
6b1d979
Per #91, swapping commas for semicolons
jprestop Sep 17, 2025
72146f5
Per #91, updating some conditional values
jprestop Sep 18, 2025
12ec48c
Per #91, trying new settings so that only the Description column will…
jprestop Sep 18, 2025
210b1cb
Per #91, attempt to fix problem with table running off boundary
jprestop Sep 18, 2025
f2078df
Per #91, modifying css for column widths
jprestop Sep 18, 2025
9ed7ca2
Per #91, modifying css for column widths
jprestop Sep 18, 2025
af857a4
Per #91, modifying css for column widths
jprestop Sep 18, 2025
3e8099b
Per #91, modifying css for column widths
jprestop Sep 18, 2025
1f83647
Per #91, reduce padding
jprestop Sep 18, 2025
1243896
Per #91, modifying widths after padding changes
jprestop Sep 18, 2025
f7ce641
Per #91, modifying widths after padding changes
jprestop Sep 18, 2025
53dff3d
Per #91, modifying widths after padding changes
jprestop Sep 18, 2025
6c3e59f
Per #91, modifying widths after padding changes
jprestop Sep 18, 2025
6eb38ee
Per #91, trying new format with combining name and description
jprestop Sep 19, 2025
daa9c05
Per #91, modifying column widths
jprestop Sep 19, 2025
c2c2134
Per #91, change Optional to O
jprestop Sep 19, 2025
13a50a3
Per #91, modifying width values
jprestop Sep 19, 2025
f423f87
Per #91, continue to experiment with widths
jprestop Sep 19, 2025
1a6a42e
Per #91, updating files with new format
jprestop Sep 23, 2025
628868c
Per #91, modifying header row in fempi.csv and page description.
jprestop Sep 23, 2025
c389e87
Per #91, adding GAD and urban parameters.
jprestop Oct 2, 2025
3f4b133
Per #91, adding urban parameters.
jprestop Oct 2, 2025
21cb4a1
Per #91, updated parameters fields as directed
jprestop Oct 3, 2025
a155aef
Per #91, updating urbanSelector
jprestop Oct 6, 2025
9c5612a
Per #91, remove extra comma
jprestop Oct 6, 2025
1ba6f4f
Per #91, making updates per suggestions from Jeremy and other fixes a…
jprestop Oct 7, 2025
440d1b2
Per #91, updated Nx to the correct default value of 128
jprestop Oct 11, 2025
0c6c719
Per #91, renaming Parameters Reference Guide
jprestop Oct 14, 2025
00e5f57
Per #91, adding default values of 1.
jprestop Oct 14, 2025
884a454
Per #91, adding a default value of 0 for ioOutputMode
jprestop Oct 14, 2025
11f52df
Per #91, added
jprestop Oct 14, 2025
9151c3c
Per #91, updated definition of verticalDeformQuadCoeff to be Quadrati…
jprestop Oct 14, 2025
7bb41c4
Per #91, changed language from 'dumping' to 'writing output of'for hy…
jprestop Oct 14, 2025
bfaae8e
Per #91, resolving conflict in grid.csv
jprestop Oct 14, 2025
ce1b946
Per #91, added '; should be an even multiple of NtBatch' to the descr…
jprestop Oct 14, 2025
d518477
Per #91, testing out line breaks
jprestop Oct 14, 2025
6dc333b
Per #91, testing out line breaks
jprestop Oct 14, 2025
2b84e04
Per #91, adding a space after '|br|'
jprestop Oct 14, 2025
461118b
Per #91, adding space for consistent formatting
jprestop Oct 14, 2025
7f15bec
Modifying URL for intersphinx_mapping to resolve error
jprestop Oct 14, 2025
b0f385b
Per #91, adding breaks in the descriptions for cleaner formatting
jprestop Oct 14, 2025
52ee447
Per #91, make formatting consistent and cleaner
jprestop Oct 14, 2025
ffe8b24
Per #91, make formatting consistent and cleaner
jprestop Oct 14, 2025
cb050e5
Per #91, cleaned up formatting and modified order of TOC
jprestop Oct 14, 2025
9119183
Per #91, added default values
jprestop Oct 14, 2025
05132b2
Per #91, attempting to make the conditional statements darker grey
jprestop Oct 14, 2025
e34a9db
Per #91, attempt #2 at coloring the conditionals
jprestop Oct 14, 2025
e9d1ea2
Per #91, trying a new color
jprestop Oct 14, 2025
a9d4903
Per #91, trying a new color
jprestop Oct 14, 2025
cc59000
Per #91, trying a new color
jprestop Oct 14, 2025
670c83c
Per #91, trying a new color blue
jprestop Oct 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/* Force longtable width control - MUST use fixed layout for width control */
.longtable table {
table-layout: fixed !important; /* Required for width specifications to work */
width: 100% !important;
}

/* Override RTD theme responsive behavior */
.wy-table-responsive {
overflow: visible !important;
}

.wy-table-responsive table {
table-layout: fixed !important;
width: 100% !important;
}

/* Prevent wrapping in all columns by default */
.longtable td,
.longtable th {
padding: 4px 6px !important; /* Default is usually 8px 12px */
white-space: nowrap !important; /* keep text on one line */
overflow: hidden !important; /* hide overflow if needed */
text-overflow: ellipsis !important; /* show "…" for cut-off text */
}

/* Allow wrapping ONLY in the Description column (6th column) */
.longtable td:nth-child(1),
.longtable th:nth-child(1) {
white-space: normal !important; /* wrapping allowed */
word-wrap: break-word !important;
overflow: visible !important;
text-overflow: unset !important;
}

/* Fixed widths for each column */
.longtable td:nth-child(1),
.longtable th:nth-child(1) { width: 73% !important; } /* Name and Description*/

.longtable td:nth-child(2),
.longtable th:nth-child(2) { width: 8% !important; } /* Min */

.longtable td:nth-child(3),
.longtable th:nth-child(3) { width: 6% !important; } /* Max */

.longtable td:nth-child(4),
.longtable th:nth-child(4) { width: 4% !important; } /* Default */

.longtable td:nth-child(5),
.longtable th:nth-child(5) { width: 4% !important; } /* Mandatory/Optional */

/* Style italic text in first column only */
.longtable td:nth-child(1) em,
.longtable th:nth-child(1) em {
color: #1e6ba6;
font-style: italic;
}


4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
html_theme = 'sphinx_rtd_theme'
html_theme_path = ["_themes", ]
html_js_files = ['pop_ver.js']
html_css_files = ['theme_override.css']
html_css_files = ['theme_override.css', 'custom.css']

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand All @@ -67,7 +67,7 @@
html_logo = os.path.join('_static','fasteddy_logo_large_vertical_2024_06.png')

# -- Intersphinx control -----------------------------------------------------
intersphinx_mapping = {'numpy':("https://docs.scipy.org/doc/numpy/", None)}
intersphinx_mapping = {'numpy':("https://numpy.org/doc/stable/", None)}

numfig = True

Expand Down
11 changes: 11 additions & 0 deletions docs/csv/extensions_gad.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**GADSelector:** |br| Generalized Actuator Disk Selector: |br| 0=off; 1=on, 0, 1, 0, O
**turbineSpecsFile:** |br| The path+filename to a turbine specifications file |br| *C-O if GADSelector > 0*, N/A, N/A, , C-O
**GADoutputForces:** |br| Flag to include GAD forces in the output: |br| 0=off; 1=on |br| *C-O if GADSelector > 0*, 0, 1, 0, C-O
**GADofflineForces:** |br| Flag to compute GAD forces in an offline mode: |br| 0=off; 1=on |br| *C-O if GADSelector > 0*, 0, 1, 0, C-O
**GADaxialInduction:** |br| Flag to compute axial induction factor: |br| 0=off (uses prescribed GADaxialIndVal) |br| 1=on |br| *C-O if GADSelector > 0*, 0, 1, 0, C-O
**GADaxialIndVal:** |br| Prescribed constant axial induction factor when GADaxialInduction==1 |br| *C-O if GADSelector > 0*, 0.0, 1.0, 0.02, C-O
**GADrefSwitch:** |br| Switch to use reference windspeed: |br| 0=off; 1=on |br| *C-O if GADSelector > 0*, 0, 1, 0, C-O
**GADrefU:** |br| Prescribed constant reference hub-height windspeed |br| *C-O if GADSelector > 0*, 0.0, 50.0, 0.0, C-O
**GADrefSampleWindow:** |br| Sample duration over which to average per-timestep values (filtering out highest frequencies) |br| *C-O if GADSelector > 0*, 1.0, 60.0, 10.0, C-O
**GADrefSeriesLength:** |br| Number of sampling windows over which to average again for reference velocity magnitude and direction |br| *C-O if GADSelector > 0*, 1, 360, 30, C-O
**GADForcingSwitch:** |br| Switch to use the GADrefU-based or local windspeed in computing GAD forces: |br| 0=local |br| 1=ref |br| *C-O if GADSelector > 0*, 0, 1, 0, C-O
4 changes: 4 additions & 0 deletions docs/csv/extensions_urban.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**urbanSelector:** |br| Urban selector: |br| 0=off |br| 1=on with no thermal contribution |br| 2=on with thermal relaxation towards base state, 0, 2, 0, O
**cd_build:** |br| c_d coefficient (m-1) used by the drag-based building formulation: |br| -c_d|u_i|u_i |br| *C-O if urbanSelector > 0*, 0.0, 1e+8, 100.0, C-O
**ct_build:** |br| c_t coefficient (s-1) used by the drag-based building formulation: |br| -c_t(rho*theta-rho_b*theta_b) & -c_t(rho-rho_b) |br| *C-O if urbanSelector > 0*, 0.0, 1e+8, 10.0, C-O
**urban_heatRedis:** |br| Selector to activate surface heat redistribution |br| *C-O if urbanSelector > 0*, 0, 1, 0, C-O
3 changes: 3 additions & 0 deletions docs/csv/fecuda.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**tBx:** |br| Number of threads in x-dimension, 1, INT_MAX, 1, M
**tBy:** |br| Number of threads in y-dimension, 1, INT_MAX, 8, M
**tBz:** |br| Number of threads in z-dimension, 1, INT_MAX, 32, M
3 changes: 3 additions & 0 deletions docs/csv/fempi.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Parameter Name: Description, Min, Max, Default, Req.
**numProcsX:** |br| Number of cores to be used for horizontal domain decomposition in X, 1, INT_MAX, 1, M
**numProcsY:** |br| Number of cores to be used for horizontal domain decomposition in Y, 1, INT_MAX, 1, M
12 changes: 12 additions & 0 deletions docs/csv/grid.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**Nx:** |br| Number of discretised domain elements in the |br| x (zonal) direction, 1, INT_MAX, 128, M
**Ny:** |br| Number of discretised domain elements in the |br| y (meridional) direction, 1, INT_MAX, 122, M
**Nz:** |br| Number of discretised domain elements in the |br| z (vertical) direction, 1, INT_MAX, 122, M
**Nh:** |br| Number of halo cells to be used |br| (dependent on largest stencil extent), 0, INT_MAX, 3, M
**d_xi:** |br| Computational domain fixed resolution in the 'i' direction, FLT_MIN, FLT_MAX, 10.0, M
**d_eta:** |br| Computational domain fixed resolution in the 'j' direction, FLT_MIN, FLT_MAX, 10.0, M
**d_zeta:** |br| Computational domain fixed resolution in the 'k' direction, FLT_MIN, FLT_MAX, 10.0, M
**coordHorizHalos:** |br| Switch to setup coordinate halos as periodic=1 or gradient-following=0, 0, 1, 1, M
**topoFile:** |br| A file containing topography |br| (surface elevation in meters ASL), N/A, N/A, , O
**verticalDeformSwitch:** |br| Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , M
**verticalDeformFactor:** |br| Deformation factor |br| 0.0=max compression |br| 1.0=no compression, 0.0, 1.0, , M
**verticalDeformQuadCoeff:** |br| Quadratic term coefficient in the deformation scheme, -2.0, 2.0, 0.0, M
2 changes: 2 additions & 0 deletions docs/csv/hydro_core_advection.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**advectionSelector:** |br| Advection scheme selector: |br| 0=1st-order upwind |br| 1=3rd-order QUICK |br| 2=hybrid 3rd-4th order |br| 3=hybrid 5th-6th order |br| 4=3rd-order WENO |br| 5=5th-order WENO |br| 6=2nd-order centered, 0, 6, 3, O
**b_hyb:** |br| Hybrid advection scheme parameter: |br| 0.0=lower-order upwind |br| 1.0=higher-order centered |br| 0.0 < b_hyb < 1.0 = hybrid |br| *C-M if advectionSelector==2 or 3*, 0.0, 1.0, 0.8, O; C-M
14 changes: 14 additions & 0 deletions docs/csv/hydro_core_auxiliary_scalars.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**NhydroAuxScalars:** |br| Number of prognostic auxiliary scalar fields, 0, 256, 0, O
**AuxScAdvSelector:** |br| Advection scheme for auxiliary scalar fields |br| *C-M if NhydroAuxScalars > 0*, 0, 6, 0, C-M
**AuxScAdvSelector_b_hyb:** |br| Hybrid advection scheme parameter |br| *C-M if NhydroAuxScalars > 0*, 0.0, 1.0, 0.0, C-M
**AuxScSGSturb:** |br| Selector to apply sub-grid scale diffusion to auxiliary scalar fields |br| *C-M if NhydroAuxScalars > 0*, 0, 1, 0, C-M
**srcAuxScFile:** |br| The path and filename to an Auxilliary Scalar Sources specification file |br| *C-O if NhydroAuxScalars > 0*, N/A, N/A, , C-O
**srcAuxScTemporalType:** |br| Temporal characterization of source (0=instantaneous; 1=continuous) |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, 0, 1, 0, C-M
**srcAuxScStartSeconds:** |br| Source start time in seconds |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, 0, FLT_MAX, 0, C-M
**srcAuxScDurationSeconds:** |br| Source duration in seconds |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, 0, FLT_MAX, 30, C-M
**srcAuxScGeometryType:** |br| 0=point (single cell volume) |br| 1=line (line of surface cells) |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, 0, 0, 0, C-M
**srcAuxScMassSpecType:** |br| Mass specification type |br| 0=strict mass in kg |br| 1=mass source rate in kg/s |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, 0, 0, 0, C-M
**srcAuxScMassSpecValue:** |br| Mass specification value in kg or kg/s given by srcAuxScMassSpecType 0 or 1 |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, 0.0, FLT_MAX, 1.0, C-M
**srcAuxScLocation_X:** |br| Source geometry centroid position in x (west-east) |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M
**srcAuxScLocation_Y:** |br| Source geometry centroid position in y (south-north) |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M
**srcAuxScLocation_Z:** |br| Source geometry centroid position in z (vertical above the surface) |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M
19 changes: 19 additions & 0 deletions docs/csv/hydro_core_base_state.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
**stabilityScheme:** |br| Scheme used to set hydrostatic stability-dependent Base-State EOS fields |br| 0=none |br| 1=profile |br| 2=linear in theta, 0, 4, 0, M
**temp_grnd:** |br| Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields, FLT_MIN, FLT_MAX, 300.0, M
**pres_grnd:** |br| Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields, FLT_MIN, FLT_MAX, 1.0e5, M
**zStableBottom:** |br| Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2, 0, FLT_MAX, 1000.0, M
**stableGradient:** |br| Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2, FLT_MIN, FLT_MAX, 0.1, M
**zStableBottom2:** |br| Height (m) of the second stable upper-layer when stabilityScheme = 2, 0, FLT_MAX, 1100.0, M
**stableGradient2:** |br| Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2, FLT_MIN, FLT_MAX, 0.03, M
**zStableBottom3:** |br| Height (m) of the third stable upper-layer when stabilityScheme = 2, 0, FLT_MAX, 1500.0, M
**stableGradient3:** |br| Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2, FLT_MIN, FLT_MAX, 0.03, M
**thetaPerturbationSwitch:** |br| Switch to include initial theta perturbations: |br| 0=off; 1=on, 0, 1, 0, M
**thetaHeight:** |br| Height below which to include initial theta perturbations: |br| (meters), 0.0, FLT_MAX, 0.0, M
**thetaAmplitude:** |br| Maximum amplitude for theta perturbations: |br| thetaAmplitude*[-1;+1] K, 0.0, 2.0, 0.0, M
**U_g:** |br| Zonal (West-East) component of the geostrophic wind (m/s), -FLT_MAX, FLT_MAX, 0.0, M
**V_g:** |br| Meridional (South-North) component of the geostrophic wind (m/s), -FLT_MAX, FLT_MAX, 0.0, M
**z_Ug:** |br| Height (m) above ground for linear geostrophic wind gradient (zonal component), 0.0, FLT_MAX, 10000.0, M
**z_Vg:** |br| Height (m) above ground for linear geostrophic wind gradient (meridional component), 0.0, FLT_MAX, 10000.0, M
**Ug_grad:** |br| Geostrophic wind gradient for U component |br| U_g gradient above z_Ug (ms-1/m), -1e2, 1e2, 0.0, M
**Vg_grad:** |br| Geostrophic wind gradient for V component |br| V_g gradient above z_Vg (ms-1/m), -1e2, 1e2, 0.0, M
**physics_oneRKonly:** |br| Selector to apply physics RHS forcing only at the latest RK stage: |br| 0=off; 1=on, 0, 1, 1, O
6 changes: 6 additions & 0 deletions docs/csv/hydro_core_boundary_cond.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
**hydroBCs:** |br| Selector for hydro BC set. |br| 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD) |br| 2=periodicHorizVerticalAbl, 1, 2, 2, M
**ceilingAdvectionBC:** |br| Selector for normal advection at the domain ceiling |br| 0=zero-valued w-BC |br| 1=non-zero w-BC, 0, 1, 0, O
**hydroBndysFileBase:** |br| Base file name LAD BC set |br| *C-M if hydroBCs==1*, N/A, N/A, , C-M
**hydroBndysFileStart:** |br| Start counter value for LAD BC set files |br| *C-M if hydroBCs==1*, 0, 500000, 0, C-M
**hydroBndysFileEnd:** |br| End counter value for LAD BC set files |br| *C-M if hydroBCs==1*, 0, 500000, 0, C-M
**dtBdyPlaneBCs:** |br| Delta in time (seconds) between BdyPlane sets |br| *C-M if hydroBCs==1*, 0.0, 6e5, 0.0, C-M
4 changes: 4 additions & 0 deletions docs/csv/hydro_core_canopy.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**canopySelector:** |br| Canopy selector: |br| 0=off; 1=on, 0, 1, 0, O
**canopySkinOpt:** |br| Canopy selector to use additional skin friction effect on drag coefficient: |br| 0=off; 1=on |br| *C-M if canopySelector==1*, 0, 1, 0, C-M
**canopy_cd:** |br| Non-dimensional canopy drag coefficient |br| *C-M if canopySelector==1*, 0.0, 1e+2, 0.15, C-M
**canopy_lf:** |br| Representative canopy element length scale |br| *C-M if canopySelector==1*, 0.0, 1e+2, 0.1, C-M
11 changes: 11 additions & 0 deletions docs/csv/hydro_core_cell_perturbation.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**cellpertSelector:** |br| CP method selector: |br| 0=off; 1=on, 0, 1, 0, O
**cellpert_nts:** |br| Number of time steps after which perturbations are seeded, 0, 1e+6, 500, O
**cellpert_sw2b:** |br| Only south and west bnds perturbed (for idealized cases): |br| 0=off |br| 1=south & west |br| 2=south |br| *C-O if cellpertSelector > 0*, 0, 3, 0, C-O
**cellpert_amp:** |br| Maximum amplitude for the potential temperature perturbations |br| *C-O if cellpertSelector > 0*, 0.0, 20.0, 0.5, C-O
**cellpert_gppc:** |br| Number of grid points conforming the cell |br| *C-O if cellpertSelector > 0*, 0, 50, 8, C-O
**cellpert_ndbc:** |br| Number of cells normal to domain lateral boundaries |br| *C-O if cellpertSelector > 0*, 0, 10, 3, C-O
**cellpert_kbottom:** |br| Z-grid point where the perturbations start |br| *C-O if cellpertSelector > 0*, 1, 10, 1, C-O
**cellpert_ktop:** |br| Z-grid point where the perturbations end |br| *C-O if cellpertSelector > 0*, 0, 200, 20, C-O
**cellpert_tvcp:** |br| Time-varying CP method selector: |br| 0=off; 1=on (hydroBCs==1) |br| *C-O if cellpertSelector > 0*, 0, 1, 0, C-O
**cellpert_eckert:** |br| Eckert number for the potential temperature perturbations (hydroBCs==1) |br| *C-O if cellpertSelector > 0*, 0.0, 10.0, 0.2, C-O
**cellpert_tsfact:** |br| Factor on the refreshing perturbation time scale (hydroBCs==1) |br| *C-O if cellpertSelector > 0*, 0.0, 10.0, 1.0, C-O
2 changes: 2 additions & 0 deletions docs/csv/hydro_core_coriolis.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**coriolisSelector:** |br| Coriolis Force selector: |br| 0=None |br| 1=Horizontal-only |br| 2=Horizontal & Vertical, 0, 2, 0, M
**coriolisLatitude:** |br| Characteristic latitude in degrees from equator of the LES domain, -90.0, 90.0, 54.0, M
2 changes: 2 additions & 0 deletions docs/csv/hydro_core_diffusion.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**diffusionSelector:** |br| Diffusion term-type selector: |br| 0=none |br| 1=constant |br| 2=scalar turbulent-diffusivity, 0, 1, 0, O
**nu_0:** |br| Constant diffusivity used when diffusionSelector=1, 0, FLT_MAX, 1.0, O
6 changes: 6 additions & 0 deletions docs/csv/hydro_core_explicit_filters.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
**filterSelector:** |br| Explicit filter selector: |br| 0=off; 1=on, 0, 1, 0, O
**filter_6thdiff_vert:** |br| Vertical 6th-order filter on w selector: |br| 0=off; 1=on |br| *C-O if filterSelector == 1*, 0, 1, 0, C-O
**filter_6thdiff_hori:** |br| Horizontal 6th-order filter on rho; theta; qv selector: |br| 0=off; 1=on |br| *C-O if filterSelector == 1*, 0, 1, 0, C-O
**filter_6thdiff_vert_coeff:** |br| Vertical 6th-order filter factor: |br| 0.0=off; 1.0=full |br| *C-M if filterSelector == 1 and* |br| *filter_6thdiff_vert == 1*, 0.0, 1.0, 0.03, C-M
**filter_6thdiff_hori_coeff:** |br| Horizontal 6th-order filter factor: |br| 0.0=off; 1.0=full |br| *C-M if filterSelector == 1 and* |br| *filter_6thdiff_hori == 1*, 0.0, 1.0, 0.03, C-M
**filter_divdamp:** |br| Divergence damping selector: |br| 0=off; 1=on |br| *C-O if filterSelector == 1*, 0, 1, 0, C-O
3 changes: 3 additions & 0 deletions docs/csv/hydro_core_io_logging.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**hydroForcingWrite:** |br| Switch for writing output of hydroFldsFrhs for prognostic fields |br| 0=off; 1=on, 0, 1, 0, O
**hydroSubGridWrite:** |br| Switch for writing output of SGS fields |br| 0=off; 1=on, 0, 1, 0, M
**hydroForcingLog:** |br| Switch for logging Frhs min/max etc |br| 0=off; 1=on, 0, 1, 0, M
18 changes: 18 additions & 0 deletions docs/csv/hydro_core_large_scale_forcings.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
**lsfSelector:** |br| Large-scale forcings selector: |br| 0=off; 1=on, 0, 1, 0, M
**lsf_horMnSubTerms:** |br| Large-scale subsidence terms switch: |br| 0=off; 1=on |br| *C-M if lsfSelector > 0*, 0, 1, 0, C-M
**lsf_freq:** |br| Large-scale forcing frequency (seconds) |br| *C-M if lsfSelector > 0*, 1e-3, 1e+3, 1.0, C-M
**lsf_w_surf:** |br| Large-scale forcing to w at the surface |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_w_lev1:** |br| Large-scale forcing to w at the first specified level |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_w_lev2:** |br| Large-scale forcing to w at the second specified level |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_w_zlev1:** |br| Large-scale forcing to w height 1 |br| *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M
**lsf_w_zlev2:** |br| Large-scale forcing to w height 2 |br| *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M
**lsf_th_surf:** |br| Large-scale forcing to theta at the surface |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_th_lev1:** |br| Large-scale forcing to theta at the first specified level |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_th_lev2:** |br| Large-scale forcing to theta at the second specified level |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_th_zlev1:** |br| Large-scale forcing to theta height 1 |br| *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M
**lsf_th_zlev2:** |br| Large-scale forcing to theta height 2 |br| *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M
**lsf_qv_surf:** |br| Large-scale forcing to qv at the first specified level |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_qv_lev1:** |br| Large-scale forcing to qv at the first specified level |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_qv_lev2:** |br| Large-scale forcing to qv at the second specified level |br| *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M
**lsf_qv_zlev1:** |br| Large-scale forcing to qv height 1 |br| *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M
**lsf_qv_zlev2:** |br| Large-scale forcing to qv height 2 |br| *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M
10 changes: 10 additions & 0 deletions docs/csv/hydro_core_moisture.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
**moistureSelector:** |br| Moisture selector: |br| 0=off; 1=on, 0, 1, 0, M
**moistureNvars:** |br| Number of moisture species |br| *C-M if moistureSelector==1*, 0, 2, 0, C-M
**moistureAdvSelectorQv:** |br| Water vapor advection scheme selector |br| *C-M if moistureSelector==1*, 0, 6, 0, C-M
**moistureAdvSelectorQv_b:** |br| Hybrid advection scheme parameter for water vapor |br| *C-M if moistureSelector==1*, 0.0, 1.0, 0.0, C-M
**moistureAdvSelectorQi:** |br| Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) |br| *C-M if moistureSelector==1*, 0, 2, 0, C-M
**moistureSGSturb:** |br| Selector to apply sub-grid scale diffusion to moisture fields |br| *C-M if moistureSelector==1*, 0, 1, 0, C-M
**moistureCond:** |br| Selector to apply condensation to moisture fields |br| *C-M if moistureSelector==1*, 1, 4, 1, C-M
**moistureCondTscale:** |br| Relaxation time in seconds |br| *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M
**moistureCondBasePres:** |br| Selector to use base pressure for microphysics |br| *C-M if moistureSelector==1*, 0, 1, 0, C-M
**moistureMPcallTscale:** |br| Time scale for microphysics to be called |br| *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M
2 changes: 2 additions & 0 deletions docs/csv/hydro_core_rayleigh_damping_layer.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**dampingLayerSelector:** |br| Rayleigh Damping Layer selector, 0, 1, 0, O
**dampingLayerDepth:** |br| Rayleigh Damping Layer Depth |br| *C-O if dampingLayerSelector==1*, 0.0, FLT_MAX, 100.0, C-O
Loading