From ae11a4c5f40700d968889fb8aa257574c5bc31e6 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 11:26:51 -0600 Subject: [PATCH 01/65] Per #91, adding files for parameter table. --- docs/_static/custom.css | 28 ++++ docs/conf.py | 2 +- docs/csv/cuda_aales.csv | 4 + docs/csv/grid.csv | 13 ++ docs/csv/hydro_core_advection.csv | 3 + docs/csv/hydro_core_auxiliary_scalars.csv | 6 + docs/csv/hydro_core_base_state.csv | 19 +++ docs/csv/hydro_core_boundary_cond.csv | 7 + docs/csv/hydro_core_canopy.csv | 5 + docs/csv/hydro_core_cell_perturbation.csv | 12 ++ docs/csv/hydro_core_coriolis.csv | 3 + docs/csv/hydro_core_diffusion.csv | 3 + docs/csv/hydro_core_explicit_filters.csv | 4 + docs/csv/hydro_core_io_logging.csv | 5 + docs/csv/hydro_core_large_scale_forcings.csv | 19 +++ docs/csv/hydro_core_moisture.csv | 11 ++ .../csv/hydro_core_rayleigh_damping_layer.csv | 3 + docs/csv/hydro_core_surface_layer.csv | 18 ++ docs/csv/hydro_core_turbulence.csv | 7 + docs/csv/io.csv | 7 + docs/csv/mpi_aales.csv | 3 + docs/csv/time_integration.csv | 5 + docs/index.rst | 1 + docs/parameters.rst | 157 ++++++++++++++++++ 24 files changed, 344 insertions(+), 1 deletion(-) create mode 100644 docs/_static/custom.css create mode 100644 docs/csv/cuda_aales.csv create mode 100644 docs/csv/grid.csv create mode 100644 docs/csv/hydro_core_advection.csv create mode 100644 docs/csv/hydro_core_auxiliary_scalars.csv create mode 100644 docs/csv/hydro_core_base_state.csv create mode 100644 docs/csv/hydro_core_boundary_cond.csv create mode 100644 docs/csv/hydro_core_canopy.csv create mode 100644 docs/csv/hydro_core_cell_perturbation.csv create mode 100644 docs/csv/hydro_core_coriolis.csv create mode 100644 docs/csv/hydro_core_diffusion.csv create mode 100644 docs/csv/hydro_core_explicit_filters.csv create mode 100644 docs/csv/hydro_core_io_logging.csv create mode 100644 docs/csv/hydro_core_large_scale_forcings.csv create mode 100644 docs/csv/hydro_core_moisture.csv create mode 100644 docs/csv/hydro_core_rayleigh_damping_layer.csv create mode 100644 docs/csv/hydro_core_surface_layer.csv create mode 100644 docs/csv/hydro_core_turbulence.csv create mode 100644 docs/csv/io.csv create mode 100644 docs/csv/mpi_aales.csv create mode 100644 docs/csv/time_integration.csv create mode 100644 docs/parameters.rst diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 0000000..35662cb --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,28 @@ +/* Force CSV table width control */ +.wy-table-responsive table td, +.wy-table-responsive table th { + white-space: normal !important; + word-wrap: break-word !important; +} + +.wy-table-responsive { + overflow: visible !important; +} + +.wy-table-responsive table { + table-layout: fixed !important; + width: 100% !important; +} + +/* Specific fixes for parameter tables */ +.longtable table { + table-layout: fixed !important; + width: 100% !important; +} + +.longtable td:nth-child(1) { width: 25% !important; } /* Name */ +.longtable td:nth-child(2) { width: 10% !important; } /* Min */ +.longtable td:nth-child(3) { width: 10% !important; } /* Max */ +.longtable td:nth-child(4) { width: 20% !important; } /* Mandatory/Optional */ +.longtable td:nth-child(5) { width: 35% !important; } /* Description */ + diff --git a/docs/conf.py b/docs/conf.py index af63f7b..7e838df 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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, diff --git a/docs/csv/cuda_aales.csv b/docs/csv/cuda_aales.csv new file mode 100644 index 0000000..9464ee4 --- /dev/null +++ b/docs/csv/cuda_aales.csv @@ -0,0 +1,4 @@ +Name, Min, Max, Mandatory or Optional, Description +tBx, 1, INT_MAX, Mandatory, Number of threads in x-dimension +tBy, 1, INT_MAX, Mandatory, Number of threads in y-dimension +tBz, 1, INT_MAX, Mandatory, Number of threads in z-dimension \ No newline at end of file diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv new file mode 100644 index 0000000..13cdab9 --- /dev/null +++ b/docs/csv/grid.csv @@ -0,0 +1,13 @@ +Name, Min, Max, Mandatory or Optional, Description +Nx, 1, INT_MAX, Mandatory, Number of discretised domain elements in the x (zonal) direction +Ny, 1, INT_MAX, Mandatory, Number of discretised domain elements in the y (meridional) direction +Nz, 1, INT_MAX, Mandatory, Number of discretised domain elements in the z (vertical) direction +Nh, 0, INT_MAX, Mandatory, Number of halo cells to be used (dependent on largest stencil extent) +d_xi, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the 'i' direction +d_eta, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the 'j' direction +d_zeta, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the 'k' direction +coordHorizHalos, 0, 1, Mandatory, Switch to setup coordiante halos as periodic=1 or gradient-following=0 +topoFile, N/A, N/A, Optional, A file containing topography (surface elevation in meters ASL) +verticalDeformSwitch, 0, 1, Mandatory, Switch to use vertical coordinate deformation 0=off, 1=on +verticalDeformFactor, 0.0, 1.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) +verticalDeformQuadCoeff, -2.0, 2.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) \ No newline at end of file diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv new file mode 100644 index 0000000..77641a3 --- /dev/null +++ b/docs/csv/hydro_core_advection.csv @@ -0,0 +1,3 @@ +Name, Min, Max, Mandatory or Optional, Description +advectionSelector, 0, 6, Mandatory, Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order +b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv new file mode 100644 index 0000000..458323a --- /dev/null +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -0,0 +1,6 @@ +Name, Min, Max, Mandatory or Optional, Description +NhydroAuxScalars, 0, MAX_AUXSC_SRC, Optional, Number of prognostic auxiliary scalar fields +AuxScAdvSelector, 0, 6, Mandatory, Advection scheme for auxiliary scalar fields +AuxScAdvSelector_b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter +AuxScSGSturb, 0, 1, Mandatory, Selector to apply sub-grid scale diffusion to auxiliary scalar fields +srcAuxScFile, N/A, N/A, Optional, The path and filename to an Auxilliary Scalar Sources specification file \ No newline at end of file diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv new file mode 100644 index 0000000..9941d65 --- /dev/null +++ b/docs/csv/hydro_core_base_state.csv @@ -0,0 +1,19 @@ +Name, Min, Max, Mandatory or Optional, Description +stabilityScheme, 0, 4, Mandatory, Scheme used to set hydrostatic, stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) +temp_grnd, FLT_MIN, FLT_MAX, Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields +pres_grnd, FLT_MIN, FLT_MAX, Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields +zStableBottom, 0, FLT_MAX, Mandatory, Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2 +stableGradient, FLT_MIN, FLT_MAX, Mandatory, Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2 +zStableBottom2, 0, FLT_MAX, Mandatory, Height (m) of the second stable upper-layer when stabilityScheme = 2 +stableGradient2, FLT_MIN, FLT_MAX, Mandatory, Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2 +zStableBottom3, 0, FLT_MAX, Mandatory, Height (m) of the third stable upper-layer when stabilityScheme = 2 +stableGradient3, FLT_MIN, FLT_MAX, Mandatory, Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2 +thetaPerturbationSwitch, 0, 1, Mandatory, Switch to include initial theta perturbations: 0=off; 1=on +thetaHeight, 0.0, FLT_MAX, Mandatory, Height below which to include initial theta perturbations: (meters) +thetaAmplitude, 0.0, 2.0, Mandatory, Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K +U_g, -FLT_MAX, FLT_MAX, Mandatory, Zonal (West-East) component of the geostrophic wind (m/s) +V_g, -FLT_MAX, FLT_MAX, Mandatory, Meridional (South-North) component of the geostrophic wind (m/s) +z_Ug, 0.0, FLT_MAX, Mandatory, Height (m) above ground for linear geostrophic wind gradient (zonal component) +z_Vg, 0.0, FLT_MAX, Mandatory, Height (m) above ground for linear geostrophic wind gradient (meridional component) +Ug_grad, -1e2, 1e2, Mandatory, Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m) +Vg_grad, -1e2, 1e2, Mandatory, Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m) \ No newline at end of file diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv new file mode 100644 index 0000000..fb30bb2 --- /dev/null +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -0,0 +1,7 @@ +Name, Min, Max, Mandatory or Optional, Description +hydroBCs, 1, 2, Mandatory, Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl +ceilingAdvectionBC, 0, 1, Optional, Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC) +hydroBndysFileBase, N/A, N/A, Optional, Base file name LAD BC set (hydroBCs=1) +hydroBndysFileStart, 0, 500000, Mandatory, Start counter value for LAD BC set files (hydroBCs=1) +hydroBndysFileEnd, 0, 500000, Mandatory, End counter value for LAD BC set files (hydroBCs=1) +dtBdyPlaneBCs, 0.0, 6e5, Mandatory, Delta in time (seconds) between BdyPlane sets diff --git a/docs/csv/hydro_core_canopy.csv b/docs/csv/hydro_core_canopy.csv new file mode 100644 index 0000000..c21dcb1 --- /dev/null +++ b/docs/csv/hydro_core_canopy.csv @@ -0,0 +1,5 @@ +Name, Min, Max, Mandatory or Optional, Description +canopySelector, 0, 1, Optional, Canopy selector: 0=off; 1=on +canopySkinOpt, 0, 1, Mandatory, Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on +canopy_cd, 0.0, 1e+2, Mandatory, Non-dimensional canopy drag coefficient +canopy_lf, 0.0, 1e+2, Mandatory, Representative canopy element length scale diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv new file mode 100644 index 0000000..47cfc55 --- /dev/null +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -0,0 +1,12 @@ +Name, Min, Max, Mandatory or Optional, Description +cellpertSelector, 0, 1, Optional, CP method selector: 0=off; 1=on +cellpert_sw2b, 0, 3, Mandatory, Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south +cellpert_amp, 0.0, 20.0, Mandatory, Maximum amplitude for the potential temperature perturbations +cellpert_nts, 0, 1e+6, Optional, Number of time steps after which perturbations are seeded +cellpert_gppc, 0, 50, Mandatory, Number of grid points conforming the cell +cellpert_ndbc, 0, 10, Mandatory, Number of cells normal to domain lateral boundaries +cellpert_kbottom, 1, 10, Mandatory, Z-grid point where the perturbations start +cellpert_ktop, 0, 200, Mandatory, Z-grid point where the perturbations end +cellpert_tvcp, 0, 1, Mandatory, Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) +cellpert_eckert, 0.0, 10.0, Mandatory, Eckert number for the potential temperature perturbations (hydroBCs == 1) +cellpert_tsfact, 0.0, 10.0, Mandatory, Factor on the refreshing perturbation time scale (hydroBCs == 1) diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv new file mode 100644 index 0000000..9546576 --- /dev/null +++ b/docs/csv/hydro_core_coriolis.csv @@ -0,0 +1,3 @@ +Name, Min, Max, Mandatory or Optional, Description +coriolisSelector, 0, 2, Mandatory, Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical +coriolisLatitude, -90.0, 90.0, Mandatory, Charactersitc latitude in degrees from equator of the LES domain \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv new file mode 100644 index 0000000..d51d9ef --- /dev/null +++ b/docs/csv/hydro_core_diffusion.csv @@ -0,0 +1,3 @@ +Name, Min, Max, Mandatory or Optional, Description +diffusionSelector, 0, 1, Mandatory, Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity +nu_0, 0, FLT_MAX, Mandatory, Constant diffusivity used when diffusionSelector=1 \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv new file mode 100644 index 0000000..10405c3 --- /dev/null +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -0,0 +1,4 @@ +Name, Min, Max, Mandatory or Optional, Description +filterSelector, 0, 1, Mandatory, Explicit filter selector: 0=off; 1=on +filter_6thdiff_vert, 0, 1, Optional, Vertical 6th-order filter on w selector: 0=off; 1=on +filter_6thdiff_vert_coeff, 0.0, 1.0, Mandatory, Vertical 6th-order filter w factor: 0.0=off; 1.0=full diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv new file mode 100644 index 0000000..8c4c79f --- /dev/null +++ b/docs/csv/hydro_core_io_logging.csv @@ -0,0 +1,5 @@ +Name, Min, Max, Mandatory or Optional, Description +hydroForcingWrite, 0, 1, Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on +hydroSubGridWrite, 0, 1, Mandatory, Switch for dumping Tauij fields. 0=off; 1=on +hydroForcingLog, 0, 1, Mandatory, Switch for logging Frhs min/max, etc. 0=off; 1=on + diff --git a/docs/csv/hydro_core_large_scale_forcings.csv b/docs/csv/hydro_core_large_scale_forcings.csv new file mode 100644 index 0000000..1a1779c --- /dev/null +++ b/docs/csv/hydro_core_large_scale_forcings.csv @@ -0,0 +1,19 @@ +Name, Min, Max, Mandatory or Optional, Description +lsfSelector, 0, 1, Mandatory, Large-scale forcings selector: 0=off; 1=on +lsf_horMnSubTerms, 0, 1, Mandatory, Large-scale subsidence terms Switch 0=off 1=on +lsf_freq, 1e-3, 1e+3, Mandatory, Large-scale forcing frequency (seconds) +lsf_w_surf, -1e+4, 1e+4, Mandatory, Large-scale forcing to w at the surface +lsf_w_lev1, -1e+4, 1e+4, Mandatory, Large-scale forcing to w at the first specified level +lsf_w_lev2, -1e+4, 1e+4, Mandatory, Large-scale forcing to w at the second specified level +lsf_w_zlev1, 0.0, 1e+4, Mandatory, Large-scale forcing to w height 1 +lsf_w_zlev2, 0.0, 1e+4, Mandatory, Large-scale forcing to w height 2 +lsf_th_surf, -1e+4, 1e+4, Mandatory, Large-scale forcing to theta at the surface +lsf_th_lev1, -1e+4, 1e+4, Mandatory, Large-scale forcing to theta at the first specified level +lsf_th_lev2, -1e+4, 1e+4, Mandatory, Large-scale forcing to theta at the second specified level +lsf_th_zlev1, 0.0, 1e+4, Mandatory, Large-scale forcing to theta height 1 +lsf_th_zlev2, 0.0, 1e+4, Mandatory, Large-scale forcing to theta height 2 +lsf_qv_surf, -1e+4, 1e+4, Mandatory, Large-scale forcing to qv at the first specified level +lsf_qv_lev1, -1e+4, 1e+4, Mandatory, Large-scale forcing to qv at the first specified level +lsf_qv_lev2, -1e+4, 1e+4, Mandatory, Large-scale forcing to qv at the second specified level +lsf_qv_zlev1, 0.0, 1e+4, Mandatory, Large-scale forcing to qv height 1 +lsf_qv_zlev2, 0.0, 1e+4, Mandatory, Large-scale forcing to qv height 2 \ No newline at end of file diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv new file mode 100644 index 0000000..6392d00 --- /dev/null +++ b/docs/csv/hydro_core_moisture.csv @@ -0,0 +1,11 @@ +Name, Min, Max, Mandatory or Optional, Description +moistureSelector, 0, 1, Mandatory, Moisture selector: 0=off; 1=on +moistureNvars, 0, 2, Mandatory, Number of moisture species +moistureAdvSelectorQv, 0, 6, Mandatory, Water vapor advection scheme selector +moistureAdvSelectorQv_b, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter for water vapor +moistureAdvSelectorQi, 0, 2, Mandatory, Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) +moistureSGSturb, 0, 1, Mandatory, Selector to apply sub-grid scale diffusion to moisture fields +moistureCond, 1, 4, Mandatory, Selector to apply condensation to mositure fields +moistureCondTscale, 1e-4, 1000.0, Mandatory, Relaxation time in seconds +moistureCondBasePres, 0, 1, Mandatory, Selector to use base pressure for microphysics +moistureMPcallTscale, 1e-4, 1000.0, Mandatory, Time scale for microphysics to be called diff --git a/docs/csv/hydro_core_rayleigh_damping_layer.csv b/docs/csv/hydro_core_rayleigh_damping_layer.csv new file mode 100644 index 0000000..74294d5 --- /dev/null +++ b/docs/csv/hydro_core_rayleigh_damping_layer.csv @@ -0,0 +1,3 @@ +Name, Min, Max, Mandatory or Optional, Description +dampingLayerSelector, 0, 1, Mandatory, Rayleigh Damping Layer selector +dampingLayerDepth, 0.0, FLT_MAX, Mandatory, Rayleigh Damping Layer Depth diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv new file mode 100644 index 0000000..218cabf --- /dev/null +++ b/docs/csv/hydro_core_surface_layer.csv @@ -0,0 +1,18 @@ +Name, Min, Max, Mandatory or Optional, Description +surflayerSelector, 0, 3, Mandatory, Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr) +surflayer_z0, 1e-12, 1e+0, Mandatory, Roughness length (momentum) when surflayerSelector > 0 +surflayer_z0t, 1e-6, 1e+1, Mandatory, Roughness length (temperature) when surflayerSelector > 0 +surflayer_z0tdyn, 0, 2, Optional, Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff +surflayer_wth, -5e+0, 5e+0, Mandatory, Kinematic sensible heat flux at the surface when surflayerSelector = 1 +surflayer_tr, -1e+1, 1e+1, Mandatory, Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling) +surflayer_wq, -5e+0, 5e+0, Mandatory, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 +surflayer_qr, -1e+1, 1e+1, Mandatory, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 +surflayer_idealsine, 0, 1, Mandatory, Selector for idealized sinusoidal surface heat flux or skin temperature forcing +surflayer_ideal_ts, 0, 1e+5, Mandatory, Start time in seconds for the idealized sinusoidal surface forcing +surflayer_ideal_te, 0, 1e+5, Mandatory, End time in seconds for the idealized sinusoidal surface forcing +surflayer_ideal_amp, 0, 1e+3, Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing +surflayer_ideal_qts, 0, 1e+5, Mandatory, Start time in seconds for the idealized sinusoidal surface forcing (qv) +surflayer_ideal_qte, 0, 1e+5, Mandatory, End time in seconds for the idealized sinusoidal surface forcing (qv) +surflayer_ideal_qamp, 0, 1e+3, Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing (qv) +surflayer_qskin_input, 0, 1, Optional, Selector for file input (restart) value for qskin under surflayerSelector == 2 +surflayer_offshore, 0, 1, Mandatory, Offshore selector: 0=off;1=on \ No newline at end of file diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv new file mode 100644 index 0000000..6779a2c --- /dev/null +++ b/docs/csv/hydro_core_turbulence.csv @@ -0,0 +1,7 @@ +Name, Min, Max, Mandatory or Optional, Description +turbulenceSelector, 0, 1, Mandatory, Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky +TKESelector, 0, 2, Mandatory, Prognostic TKE selector: 0=None; 1=Prognostic +TKEAdvSelector, 0, 6, Mandatory, SGSTKE advection selector +TKEAdvSelector_b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter +c_s, 1e-6, 1e6, Mandatory, Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0 +c_k, 1e-6, 1e6, Mandatory, Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0 \ No newline at end of file diff --git a/docs/csv/io.csv b/docs/csv/io.csv new file mode 100644 index 0000000..6818b4a --- /dev/null +++ b/docs/csv/io.csv @@ -0,0 +1,7 @@ +Name, Min, Max, Mandatory or Optional, Description +inPath, N/A, N/A, Optional, Path where initial/restart file is read in from +inFile, N/A, N/A, Optional, Name of the input file for coordinate system and initial or restart conditions +outPath, N/A, N/A, Mandatory, Path where output files are to be written +outFileBase, N/A, N/A, Mandatory, Base name of the output file series as in (outFileBase).element-in-series +frqOutput, 0, INT_MAX, Mandatory, Frequency (in timesteps) at which to produce output +ioOutputMode, 0, 1, Optional, 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files \ No newline at end of file diff --git a/docs/csv/mpi_aales.csv b/docs/csv/mpi_aales.csv new file mode 100644 index 0000000..87c2dac --- /dev/null +++ b/docs/csv/mpi_aales.csv @@ -0,0 +1,3 @@ +Name, Min, Max, Mandatory or Optional, Description +numProcsX, 1, INT_MAX, Mandatory, Number of cores to be used for horizontal domain decomposition in X +numProcsY, 1, INT_MAX, Mandatory, Number of cores to be used for horizontal domain decomposition in Y \ No newline at end of file diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv new file mode 100644 index 0000000..8ced187 --- /dev/null +++ b/docs/csv/time_integration.csv @@ -0,0 +1,5 @@ +Name, Min, Max, Mandatory or Optional, Description +timeMethod, 0, 0, Mandatory, Selector for time integration method. [0=RK3-WS2002 (default)] +Nt, 1, INT_MAX, Mandatory, Number of timesteps to perform +dt, FLT_MIN, FLT_MAX, Mandatory, Timestep resolution in seconds +NtBatch, 1, Nt, Mandatory, Number of timesteps to compute in batch launch; must have NtBatch <= Nt \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 55dee87..34f89db 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,6 +54,7 @@ web: https://fluidnumerics.com, email: support@fluidnumerics.com release_notes.rst build_run.rst + parameters.rst downloads.rst Tutorials/index publications.rst diff --git a/docs/parameters.rst b/docs/parameters.rst new file mode 100644 index 0000000..8e04b44 --- /dev/null +++ b/docs/parameters.rst @@ -0,0 +1,157 @@ +********** +Parameters +********** + +This page defines the configurable parameters available in FastEddy\ :sup:`®`. +Parameters are organized into . + +Each table provides the parameter name, +valid range where applicable, requirement status (required or optional), and a +brief description. These definitions serve as a reference to ensure correct +configuration and valid inputs for FastEddy simulations. + +**FORMAT OPTION 1** + +MPI AALES +========= + +.. csv-table:: MPI AALES + :file: csv/mpi_aales.csv + :header-rows: 1 + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +CUDA AALES +========== + +.. csv-table:: CUDA AALES + :file: csv/cuda_aales.csv + :header-rows: 1 + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +IO +=== + +.. csv-table:: IO + :file: csv/io.csv + :header-rows: 1 + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +GRID +==== + +.. csv-table:: GRID + :file: csv/grid.csv + :header-rows: 1 + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +TIME INTEGRATION +================ + +.. csv-table:: TIME INTEGRATION + :file: csv/time_integration.csv + :header-rows: 1 + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +**FORMAT OPTION 2** + ++====================+===========+===========+====================+===============================================+ +| **Name** | **Min** | **Max** | **Mandatory/Optional** | **Description** | ++====================+===========+===========+====================+===============================================+ +| **MPI AALES** | ++====================+===========+===========+====================+===============================================+ +| numProcsX | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | +| | | | | domain decomposition in X | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| numProcsY | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | +| | | | | domain decomposition in Y | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| **CUDA AALES** | ++====================+===========+===========+====================+===============================================+ +| tBx | 1 | INT_MAX | Mandatory | Number of threads in x-dimension | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| tBy | 1 | INT_MAX | Mandatory | Number of threads in y-dimension | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| tBz | 1 | INT_MAX | Mandatory | Number of threads in z-dimension | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| **IO** | ++====================+===========+===========+====================+===============================================+ +| inPath | N/A | N/A | Optional | Path where initial/restart file is read in | +| | | | | from | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| inFile | N/A | N/A | Optional | Name of the input file for coordinate system | +| | | | | and initial or restart conditions | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| outPath | N/A | N/A | Mandatory | Path where output files are to be written | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| outFileBase | N/A | N/A | Mandatory | Base name of the output file series as in | +| | | | | (outFileBase).element-in-series | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| frqOutput | 0 | INT_MAX | Mandatory | Frequency (in timesteps) at which to produce | +| | | | | output | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| ioOutputMode | 0 | 1 | Optional | 0: N-to-1 gather and write to a netcdf file;| +| | | | | 1:N-to-N writes of FastEddy binary files | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| **GRID** | ++====================+===========+===========+====================+===============================================+ +| Nx | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | x (zonal) direction | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| Ny | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | y (meridional) direction | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| Nz | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | z (vertical) direction | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| Nh | 0 | INT_MAX | Mandatory | Number of halo cells to be used (dependent | +| | | | | on largest stencil extent) | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| d_xi | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'i' direction | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| d_eta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'j' direction | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| d_zeta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'k' direction | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| coordHorizHalos | 0 | 1 | Mandatory | Switch to setup coordiante halos as | +| | | | | periodic=1 or gradient-following=0 | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| topoFile | N/A | N/A | Optional | A file containing topography (surface | +| | | | | elevation in meters ASL) | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| verticalDeformSwitch| 0 | 1 | Mandatory | Switch to use vertical coordinate deformation| +| | | | | 0=off, 1=on | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| verticalDeformFactor| 0.0 | 1.0 | Mandatory | Deformation factor (0.0=max compression; | +| | | | | 1.0=no compression) | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| verticalDeformQuadCoeff| -2.0 | 2.0 | Mandatory | Deformation factor (0.0=max compression; | +| | | | | 1.0=no compression) | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| **TIME INTEGRATION** | ++====================+===========+===========+====================+===============================================+ +| timeMethod | 0 | 0 | Mandatory | Selector for time integration method. | +| | | | | [0=RK3-WS2002 (default)] | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| Nt | 1 | INT_MAX | Mandatory | Number of timesteps to perform | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| dt | FLT_MIN | FLT_MAX | Mandatory | Timestep resolution in seconds | ++--------------------+-----------+-----------+--------------------+-----------------------------------------------+ +| NtBatch | 1 | Nt | Mandatory | Number of timesteps to compute in batch | +| | | | | launch; must have NtBatch <= Nt | ++====================+===========+===========+====================+===============================================+ + + + From df2babe8a664c8944370970e98516f25eb3acf98 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 11:30:06 -0600 Subject: [PATCH 02/65] Per #91, correcting csv file format by removing an additional comma --- docs/csv/grid.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 13cdab9..99e6f83 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -8,6 +8,6 @@ d_eta, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the d_zeta, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the 'k' direction coordHorizHalos, 0, 1, Mandatory, Switch to setup coordiante halos as periodic=1 or gradient-following=0 topoFile, N/A, N/A, Optional, A file containing topography (surface elevation in meters ASL) -verticalDeformSwitch, 0, 1, Mandatory, Switch to use vertical coordinate deformation 0=off, 1=on +verticalDeformSwitch, 0, 1, Mandatory, Switch to use vertical coordinate deformation 0=off; 1=on verticalDeformFactor, 0.0, 1.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) verticalDeformQuadCoeff, -2.0, 2.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) \ No newline at end of file From d41ccb62af38568d96d6e8a5346b7eb3302999fc Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 11:37:03 -0600 Subject: [PATCH 03/65] Per #91, attempt to fix table formatting for option 2 --- docs/parameters.rst | 176 ++++++++++++++++++++++---------------------- 1 file changed, 88 insertions(+), 88 deletions(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index 8e04b44..9e451b7 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -64,94 +64,94 @@ TIME INTEGRATION **FORMAT OPTION 2** -+====================+===========+===========+====================+===============================================+ -| **Name** | **Min** | **Max** | **Mandatory/Optional** | **Description** | -+====================+===========+===========+====================+===============================================+ -| **MPI AALES** | -+====================+===========+===========+====================+===============================================+ -| numProcsX | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | -| | | | | domain decomposition in X | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| numProcsY | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | -| | | | | domain decomposition in Y | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| **CUDA AALES** | -+====================+===========+===========+====================+===============================================+ -| tBx | 1 | INT_MAX | Mandatory | Number of threads in x-dimension | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| tBy | 1 | INT_MAX | Mandatory | Number of threads in y-dimension | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| tBz | 1 | INT_MAX | Mandatory | Number of threads in z-dimension | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| **IO** | -+====================+===========+===========+====================+===============================================+ -| inPath | N/A | N/A | Optional | Path where initial/restart file is read in | -| | | | | from | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| inFile | N/A | N/A | Optional | Name of the input file for coordinate system | -| | | | | and initial or restart conditions | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| outPath | N/A | N/A | Mandatory | Path where output files are to be written | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| outFileBase | N/A | N/A | Mandatory | Base name of the output file series as in | -| | | | | (outFileBase).element-in-series | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| frqOutput | 0 | INT_MAX | Mandatory | Frequency (in timesteps) at which to produce | -| | | | | output | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| ioOutputMode | 0 | 1 | Optional | 0: N-to-1 gather and write to a netcdf file;| -| | | | | 1:N-to-N writes of FastEddy binary files | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| **GRID** | -+====================+===========+===========+====================+===============================================+ -| Nx | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | x (zonal) direction | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| Ny | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | y (meridional) direction | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| Nz | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | z (vertical) direction | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| Nh | 0 | INT_MAX | Mandatory | Number of halo cells to be used (dependent | -| | | | | on largest stencil extent) | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| d_xi | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'i' direction | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| d_eta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'j' direction | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| d_zeta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'k' direction | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| coordHorizHalos | 0 | 1 | Mandatory | Switch to setup coordiante halos as | -| | | | | periodic=1 or gradient-following=0 | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| topoFile | N/A | N/A | Optional | A file containing topography (surface | -| | | | | elevation in meters ASL) | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| verticalDeformSwitch| 0 | 1 | Mandatory | Switch to use vertical coordinate deformation| -| | | | | 0=off, 1=on | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| verticalDeformFactor| 0.0 | 1.0 | Mandatory | Deformation factor (0.0=max compression; | -| | | | | 1.0=no compression) | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| verticalDeformQuadCoeff| -2.0 | 2.0 | Mandatory | Deformation factor (0.0=max compression; | -| | | | | 1.0=no compression) | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| **TIME INTEGRATION** | -+====================+===========+===========+====================+===============================================+ -| timeMethod | 0 | 0 | Mandatory | Selector for time integration method. | -| | | | | [0=RK3-WS2002 (default)] | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| Nt | 1 | INT_MAX | Mandatory | Number of timesteps to perform | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| dt | FLT_MIN | FLT_MAX | Mandatory | Timestep resolution in seconds | -+--------------------+-----------+-----------+--------------------+-----------------------------------------------+ -| NtBatch | 1 | Nt | Mandatory | Number of timesteps to compute in batch | -| | | | | launch; must have NtBatch <= Nt | -+====================+===========+===========+====================+===============================================+ ++====================+===========+===========+========================+===============================================+ +| **Name** | **Min** | **Max** | **Mandatory/Optional** | **Description** | ++====================+===========+===========+========================+===============================================+ +| **MPI AALES** | ++====================+===========+===========+========================+===============================================+ +| numProcsX | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | +| | | | | domain decomposition in X | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| numProcsY | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | +| | | | | domain decomposition in Y | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **CUDA AALES** | ++====================+===========+===========+========================+===============================================+ +| tBx | 1 | INT_MAX | Mandatory | Number of threads in x-dimension | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| tBy | 1 | INT_MAX | Mandatory | Number of threads in y-dimension | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| tBz | 1 | INT_MAX | Mandatory | Number of threads in z-dimension | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **IO** | ++====================+===========+===========+========================+===============================================+ +| inPath | N/A | N/A | Optional | Path where initial/restart file is read in | +| | | | | from | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| inFile | N/A | N/A | Optional | Name of the input file for coordinate system | +| | | | | and initial or restart conditions | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| outPath | N/A | N/A | Mandatory | Path where output files are to be written | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| outFileBase | N/A | N/A | Mandatory | Base name of the output file series as in | +| | | | | (outFileBase).element-in-series | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| frqOutput | 0 | INT_MAX | Mandatory | Frequency (in timesteps) at which to produce | +| | | | | output | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| ioOutputMode | 0 | 1 | Optional | 0: N-to-1 gather and write to a netcdf file; | +| | | | | 1:N-to-N writes of FastEddy binary files | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **GRID** | ++====================+===========+===========+========================+===============================================+ +| Nx | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | x (zonal) direction | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Ny | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | y (meridional) direction | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Nz | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | z (vertical) direction | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Nh | 0 | INT_MAX | Mandatory | Number of halo cells to be used (dependent | +| | | | | on largest stencil extent) | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| d_xi | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'i' direction | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| d_eta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'j' direction | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| d_zeta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'k' direction | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| coordHorizHalos | 0 | 1 | Mandatory | Switch to setup coordiante halos as | +| | | | | periodic=1 or gradient-following=0 | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| topoFile | N/A | N/A | Optional | A file containing topography (surface | +| | | | | elevation in meters ASL) | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| verticalDeformSwitch| 0 | 1 | Mandatory | Switch to use vertical coordinate deformation | +| | | | | 0=off, 1=on | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| verticalDeformFactor| 0.0 | 1.0 | Mandatory | Deformation factor (0.0=max compression; | +| | | | | 1.0=no compression) | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| verticalDeformQuadCoeff| -2.0 | 2.0 | Mandatory | Deformation factor (0.0=max compression; | +| | | | | 1.0=no compression) | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **TIME INTEGRATION** | ++====================+===========+===========+========================+===============================================+ +| timeMethod | 0 | 0 | Mandatory | Selector for time integration method. | +| | | | | [0=RK3-WS2002 (default)] | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Nt | 1 | INT_MAX | Mandatory | Number of timesteps to perform | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| dt | FLT_MIN | FLT_MAX | Mandatory | Timestep resolution in seconds | ++--------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| NtBatch | 1 | Nt | Mandatory | Number of timesteps to compute in batch | +| | | | | launch; must have NtBatch <= Nt | ++====================+===========+===========+========================+===============================================+ From 757c5b32bc914c32b960591b741ee134ec751c29 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 12:26:21 -0600 Subject: [PATCH 04/65] Per #91, attempt to fix table formatting for option 2 --- docs/parameters.rst | 177 ++++++++++++++++++++++---------------------- 1 file changed, 89 insertions(+), 88 deletions(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index 9e451b7..c5332c1 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -64,94 +64,95 @@ TIME INTEGRATION **FORMAT OPTION 2** -+====================+===========+===========+========================+===============================================+ -| **Name** | **Min** | **Max** | **Mandatory/Optional** | **Description** | -+====================+===========+===========+========================+===============================================+ -| **MPI AALES** | -+====================+===========+===========+========================+===============================================+ -| numProcsX | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | -| | | | | domain decomposition in X | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| numProcsY | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | -| | | | | domain decomposition in Y | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **CUDA AALES** | -+====================+===========+===========+========================+===============================================+ -| tBx | 1 | INT_MAX | Mandatory | Number of threads in x-dimension | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| tBy | 1 | INT_MAX | Mandatory | Number of threads in y-dimension | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| tBz | 1 | INT_MAX | Mandatory | Number of threads in z-dimension | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **IO** | -+====================+===========+===========+========================+===============================================+ -| inPath | N/A | N/A | Optional | Path where initial/restart file is read in | -| | | | | from | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| inFile | N/A | N/A | Optional | Name of the input file for coordinate system | -| | | | | and initial or restart conditions | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| outPath | N/A | N/A | Mandatory | Path where output files are to be written | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| outFileBase | N/A | N/A | Mandatory | Base name of the output file series as in | -| | | | | (outFileBase).element-in-series | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| frqOutput | 0 | INT_MAX | Mandatory | Frequency (in timesteps) at which to produce | -| | | | | output | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| ioOutputMode | 0 | 1 | Optional | 0: N-to-1 gather and write to a netcdf file; | -| | | | | 1:N-to-N writes of FastEddy binary files | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **GRID** | -+====================+===========+===========+========================+===============================================+ -| Nx | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | x (zonal) direction | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Ny | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | y (meridional) direction | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Nz | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | z (vertical) direction | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Nh | 0 | INT_MAX | Mandatory | Number of halo cells to be used (dependent | -| | | | | on largest stencil extent) | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| d_xi | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'i' direction | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| d_eta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'j' direction | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| d_zeta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'k' direction | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| coordHorizHalos | 0 | 1 | Mandatory | Switch to setup coordiante halos as | -| | | | | periodic=1 or gradient-following=0 | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| topoFile | N/A | N/A | Optional | A file containing topography (surface | -| | | | | elevation in meters ASL) | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| verticalDeformSwitch| 0 | 1 | Mandatory | Switch to use vertical coordinate deformation | -| | | | | 0=off, 1=on | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| verticalDeformFactor| 0.0 | 1.0 | Mandatory | Deformation factor (0.0=max compression; | -| | | | | 1.0=no compression) | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| verticalDeformQuadCoeff| -2.0 | 2.0 | Mandatory | Deformation factor (0.0=max compression; | -| | | | | 1.0=no compression) | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **TIME INTEGRATION** | -+====================+===========+===========+========================+===============================================+ -| timeMethod | 0 | 0 | Mandatory | Selector for time integration method. | -| | | | | [0=RK3-WS2002 (default)] | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Nt | 1 | INT_MAX | Mandatory | Number of timesteps to perform | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| dt | FLT_MIN | FLT_MAX | Mandatory | Timestep resolution in seconds | -+--------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| NtBatch | 1 | Nt | Mandatory | Number of timesteps to compute in batch | -| | | | | launch; must have NtBatch <= Nt | -+====================+===========+===========+========================+===============================================+ ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **Name** | **Min** | **Max** | **Mandatory/Optional** | **Description** | ++=========================+===========+===========+========================+===============================================+ +| **MPI AALES** | | | | | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| numProcsX | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | +| | | | | domain decomposition in X | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| numProcsY | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | +| | | | | domain decomposition in Y | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **CUDA AALES** | | | | | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| tBx | 1 | INT_MAX | Mandatory | Number of threads in x-dimension | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| tBy | 1 | INT_MAX | Mandatory | Number of threads in y-dimension | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| tBz | 1 | INT_MAX | Mandatory | Number of threads in z-dimension | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **IO** | | | | | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| inPath | N/A | N/A | Optional | Path where initial/restart file is read in | +| | | | | from | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| inFile | N/A | N/A | Optional | Name of the input file for coordinate system | +| | | | | and initial or restart conditions | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| outPath | N/A | N/A | Mandatory | Path where output files are to be written | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| outFileBase | N/A | N/A | Mandatory | Base name of the output file series as in | +| | | | | (outFileBase).element-in-series | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| frqOutput | 0 | INT_MAX | Mandatory | Frequency (in timesteps) at which to produce | +| | | | | output | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| ioOutputMode | 0 | 1 | Optional | 0: N-to-1 gather and write to a netcdf file; | +| | | | | 1:N-to-N writes of FastEddy binary files | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **GRID** | | | | | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Nx | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | x (zonal) direction | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Ny | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | y (meridional) direction | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Nz | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | +| | | | | z (vertical) direction | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Nh | 0 | INT_MAX | Mandatory | Number of halo cells to be used (dependent | +| | | | | on largest stencil extent) | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| d_xi | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'i' direction | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| d_eta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'j' direction | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| d_zeta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | +| | | | | 'k' direction | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| coordHorizHalos | 0 | 1 | Mandatory | Switch to setup coordiante halos as | +| | | | | periodic=1 or gradient-following=0 | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| topoFile | N/A | N/A | Optional | A file containing topography (surface | +| | | | | elevation in meters ASL) | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| verticalDeformSwitch | 0 | 1 | Mandatory | Switch to use vertical coordinate deformation | +| | | | | 0=off, 1=on | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| verticalDeformFactor | 0.0 | 1.0 | Mandatory | Deformation factor (0.0=max compression; | +| | | | | 1.0=no compression) | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| verticalDeformQuadCoeff | -2.0 | 2.0 | Mandatory | Deformation factor (0.0=max compression; | +| | | | | 1.0=no compression) | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| **TIME INTEGRATION** | | | | | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| timeMethod | 0 | 0 | Mandatory | Selector for time integration method. | +| | | | | [0=RK3-WS2002 (default)] | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| Nt | 1 | INT_MAX | Mandatory | Number of timesteps to perform | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| dt | FLT_MIN | FLT_MAX | Mandatory | Timestep resolution in seconds | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +| NtBatch | 1 | Nt | Mandatory | Number of timesteps to compute in batch | +| | | | | launch; must have NtBatch <= Nt | ++-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ + From d7a56fe1902c70cba7f94e55035f29606efde694 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 12:29:20 -0600 Subject: [PATCH 05/65] Per #91, attempt to fix header formatting for option 2 --- docs/parameters.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index c5332c1..e2b9f82 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -65,7 +65,8 @@ TIME INTEGRATION **FORMAT OPTION 2** +-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **Name** | **Min** | **Max** | **Mandatory/Optional** | **Description** | +| **Name** | **Min** | **Max** | **Mandatory** | **Description** | +| | | | **or Optional** | | +=========================+===========+===========+========================+===============================================+ | **MPI AALES** | | | | | +-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ From ac84cb7c34ecfbd4fd61f5ab6fb1a4ddc56e6539 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 12:31:54 -0600 Subject: [PATCH 06/65] Per #91, remove headers for tables since the names were the same as the table names. --- docs/parameters.rst | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index e2b9f82..e0e35d8 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -12,9 +12,6 @@ configuration and valid inputs for FastEddy simulations. **FORMAT OPTION 1** -MPI AALES -========= - .. csv-table:: MPI AALES :file: csv/mpi_aales.csv :header-rows: 1 @@ -22,9 +19,6 @@ MPI AALES :widths: 30, 18, 18, 20, 35 :class: longtable -CUDA AALES -========== - .. csv-table:: CUDA AALES :file: csv/cuda_aales.csv :header-rows: 1 @@ -32,9 +26,6 @@ CUDA AALES :widths: 30, 18, 18, 20, 35 :class: longtable -IO -=== - .. csv-table:: IO :file: csv/io.csv :header-rows: 1 @@ -42,9 +33,6 @@ IO :widths: 30, 18, 18, 20, 35 :class: longtable -GRID -==== - .. csv-table:: GRID :file: csv/grid.csv :header-rows: 1 @@ -52,9 +40,6 @@ GRID :widths: 30, 18, 18, 20, 35 :class: longtable -TIME INTEGRATION -================ - .. csv-table:: TIME INTEGRATION :file: csv/time_integration.csv :header-rows: 1 From ed8c19e21968859c84686c77d5531a48ade820bf Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 15:53:25 -0600 Subject: [PATCH 07/65] Per #91, renaming files, removing headers from all but femain, and adding to parameters --- docs/csv/{cuda_aales.csv => fecuda.csv} | 1 - docs/csv/{mpi_aales.csv => femain.csv} | 0 docs/csv/grid.csv | 1 - docs/csv/hydro_core_advection.csv | 1 - docs/csv/hydro_core_auxiliary_scalars.csv | 1 - docs/csv/hydro_core_base_state.csv | 1 - docs/csv/hydro_core_boundary_cond.csv | 1 - docs/csv/hydro_core_canopy.csv | 1 - docs/csv/hydro_core_cell_perturbation.csv | 1 - docs/csv/hydro_core_coriolis.csv | 1 - docs/csv/hydro_core_diffusion.csv | 1 - docs/csv/hydro_core_explicit_filters.csv | 1 - docs/csv/hydro_core_io_logging.csv | 1 - docs/csv/hydro_core_large_scale_forcings.csv | 1 - docs/csv/hydro_core_moisture.csv | 1 - .../csv/hydro_core_rayleigh_damping_layer.csv | 1 - docs/csv/hydro_core_surface_layer.csv | 1 - docs/csv/hydro_core_turbulence.csv | 1 - docs/csv/io.csv | 1 - docs/csv/time_integration.csv | 1 - docs/parameters.rst | 263 +++++++++++------- 21 files changed, 158 insertions(+), 124 deletions(-) rename docs/csv/{cuda_aales.csv => fecuda.csv} (78%) rename docs/csv/{mpi_aales.csv => femain.csv} (100%) diff --git a/docs/csv/cuda_aales.csv b/docs/csv/fecuda.csv similarity index 78% rename from docs/csv/cuda_aales.csv rename to docs/csv/fecuda.csv index 9464ee4..f4db708 100644 --- a/docs/csv/cuda_aales.csv +++ b/docs/csv/fecuda.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description tBx, 1, INT_MAX, Mandatory, Number of threads in x-dimension tBy, 1, INT_MAX, Mandatory, Number of threads in y-dimension tBz, 1, INT_MAX, Mandatory, Number of threads in z-dimension \ No newline at end of file diff --git a/docs/csv/mpi_aales.csv b/docs/csv/femain.csv similarity index 100% rename from docs/csv/mpi_aales.csv rename to docs/csv/femain.csv diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 99e6f83..bbdcbbb 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description Nx, 1, INT_MAX, Mandatory, Number of discretised domain elements in the x (zonal) direction Ny, 1, INT_MAX, Mandatory, Number of discretised domain elements in the y (meridional) direction Nz, 1, INT_MAX, Mandatory, Number of discretised domain elements in the z (vertical) direction diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv index 77641a3..c238d00 100644 --- a/docs/csv/hydro_core_advection.csv +++ b/docs/csv/hydro_core_advection.csv @@ -1,3 +1,2 @@ -Name, Min, Max, Mandatory or Optional, Description advectionSelector, 0, 6, Mandatory, Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 458323a..7ad31e8 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description NhydroAuxScalars, 0, MAX_AUXSC_SRC, Optional, Number of prognostic auxiliary scalar fields AuxScAdvSelector, 0, 6, Mandatory, Advection scheme for auxiliary scalar fields AuxScAdvSelector_b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv index 9941d65..287faa2 100644 --- a/docs/csv/hydro_core_base_state.csv +++ b/docs/csv/hydro_core_base_state.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description stabilityScheme, 0, 4, Mandatory, Scheme used to set hydrostatic, stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) temp_grnd, FLT_MIN, FLT_MAX, Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields pres_grnd, FLT_MIN, FLT_MAX, Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index fb30bb2..628f0db 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description hydroBCs, 1, 2, Mandatory, Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl ceilingAdvectionBC, 0, 1, Optional, Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC) hydroBndysFileBase, N/A, N/A, Optional, Base file name LAD BC set (hydroBCs=1) diff --git a/docs/csv/hydro_core_canopy.csv b/docs/csv/hydro_core_canopy.csv index c21dcb1..e5a6860 100644 --- a/docs/csv/hydro_core_canopy.csv +++ b/docs/csv/hydro_core_canopy.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description canopySelector, 0, 1, Optional, Canopy selector: 0=off; 1=on canopySkinOpt, 0, 1, Mandatory, Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on canopy_cd, 0.0, 1e+2, Mandatory, Non-dimensional canopy drag coefficient diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv index 47cfc55..4d164aa 100644 --- a/docs/csv/hydro_core_cell_perturbation.csv +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description cellpertSelector, 0, 1, Optional, CP method selector: 0=off; 1=on cellpert_sw2b, 0, 3, Mandatory, Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south cellpert_amp, 0.0, 20.0, Mandatory, Maximum amplitude for the potential temperature perturbations diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv index 9546576..8c4e094 100644 --- a/docs/csv/hydro_core_coriolis.csv +++ b/docs/csv/hydro_core_coriolis.csv @@ -1,3 +1,2 @@ -Name, Min, Max, Mandatory or Optional, Description coriolisSelector, 0, 2, Mandatory, Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical coriolisLatitude, -90.0, 90.0, Mandatory, Charactersitc latitude in degrees from equator of the LES domain \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv index d51d9ef..cf31cfb 100644 --- a/docs/csv/hydro_core_diffusion.csv +++ b/docs/csv/hydro_core_diffusion.csv @@ -1,3 +1,2 @@ -Name, Min, Max, Mandatory or Optional, Description diffusionSelector, 0, 1, Mandatory, Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity nu_0, 0, FLT_MAX, Mandatory, Constant diffusivity used when diffusionSelector=1 \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index 10405c3..2978729 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description filterSelector, 0, 1, Mandatory, Explicit filter selector: 0=off; 1=on filter_6thdiff_vert, 0, 1, Optional, Vertical 6th-order filter on w selector: 0=off; 1=on filter_6thdiff_vert_coeff, 0.0, 1.0, Mandatory, Vertical 6th-order filter w factor: 0.0=off; 1.0=full diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index 8c4c79f..5bd2585 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description hydroForcingWrite, 0, 1, Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on hydroSubGridWrite, 0, 1, Mandatory, Switch for dumping Tauij fields. 0=off; 1=on hydroForcingLog, 0, 1, Mandatory, Switch for logging Frhs min/max, etc. 0=off; 1=on diff --git a/docs/csv/hydro_core_large_scale_forcings.csv b/docs/csv/hydro_core_large_scale_forcings.csv index 1a1779c..1e6c9b1 100644 --- a/docs/csv/hydro_core_large_scale_forcings.csv +++ b/docs/csv/hydro_core_large_scale_forcings.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description lsfSelector, 0, 1, Mandatory, Large-scale forcings selector: 0=off; 1=on lsf_horMnSubTerms, 0, 1, Mandatory, Large-scale subsidence terms Switch 0=off 1=on lsf_freq, 1e-3, 1e+3, Mandatory, Large-scale forcing frequency (seconds) diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv index 6392d00..97878e1 100644 --- a/docs/csv/hydro_core_moisture.csv +++ b/docs/csv/hydro_core_moisture.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description moistureSelector, 0, 1, Mandatory, Moisture selector: 0=off; 1=on moistureNvars, 0, 2, Mandatory, Number of moisture species moistureAdvSelectorQv, 0, 6, Mandatory, Water vapor advection scheme selector diff --git a/docs/csv/hydro_core_rayleigh_damping_layer.csv b/docs/csv/hydro_core_rayleigh_damping_layer.csv index 74294d5..99942e8 100644 --- a/docs/csv/hydro_core_rayleigh_damping_layer.csv +++ b/docs/csv/hydro_core_rayleigh_damping_layer.csv @@ -1,3 +1,2 @@ -Name, Min, Max, Mandatory or Optional, Description dampingLayerSelector, 0, 1, Mandatory, Rayleigh Damping Layer selector dampingLayerDepth, 0.0, FLT_MAX, Mandatory, Rayleigh Damping Layer Depth diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index 218cabf..13530a0 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description surflayerSelector, 0, 3, Mandatory, Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr) surflayer_z0, 1e-12, 1e+0, Mandatory, Roughness length (momentum) when surflayerSelector > 0 surflayer_z0t, 1e-6, 1e+1, Mandatory, Roughness length (temperature) when surflayerSelector > 0 diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv index 6779a2c..2738838 100644 --- a/docs/csv/hydro_core_turbulence.csv +++ b/docs/csv/hydro_core_turbulence.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description turbulenceSelector, 0, 1, Mandatory, Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky TKESelector, 0, 2, Mandatory, Prognostic TKE selector: 0=None; 1=Prognostic TKEAdvSelector, 0, 6, Mandatory, SGSTKE advection selector diff --git a/docs/csv/io.csv b/docs/csv/io.csv index 6818b4a..a4a475a 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description inPath, N/A, N/A, Optional, Path where initial/restart file is read in from inFile, N/A, N/A, Optional, Name of the input file for coordinate system and initial or restart conditions outPath, N/A, N/A, Mandatory, Path where output files are to be written diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index 8ced187..7412197 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description timeMethod, 0, 0, Mandatory, Selector for time integration method. [0=RK3-WS2002 (default)] Nt, 1, INT_MAX, Mandatory, Number of timesteps to perform dt, FLT_MIN, FLT_MAX, Mandatory, Timestep resolution in seconds diff --git a/docs/parameters.rst b/docs/parameters.rst index e0e35d8..d5b397d 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -10,135 +10,188 @@ valid range where applicable, requirement status (required or optional), and a brief description. These definitions serve as a reference to ensure correct configuration and valid inputs for FastEddy simulations. -**FORMAT OPTION 1** -.. csv-table:: MPI AALES - :file: csv/mpi_aales.csv +FEMAIN +====== + +.. csv-table:: + :file: csv/femain.csv :header-rows: 1 :delim: , :widths: 30, 18, 18, 20, 35 :class: longtable - -.. csv-table:: CUDA AALES - :file: csv/cuda_aales.csv - :header-rows: 1 + +FECUDA +====== + +.. csv-table:: + :file: csv/fecuda.csv :delim: , :widths: 30, 18, 18, 20, 35 :class: longtable - -.. csv-table:: IO + +IO +=== + +.. csv-table:: :file: csv/io.csv - :header-rows: 1 :delim: , :widths: 30, 18, 18, 20, 35 :class: longtable -.. csv-table:: GRID +GRID +==== +.. csv-table:: :file: csv/grid.csv - :header-rows: 1 :delim: , :widths: 30, 18, 18, 20, 35 :class: longtable -.. csv-table:: TIME INTEGRATION +TIME INTEGRATION +================ + +.. csv-table:: :file: csv/time_integration.csv - :header-rows: 1 :delim: , :widths: 30, 18, 18, 20, 35 :class: longtable -**FORMAT OPTION 2** - -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **Name** | **Min** | **Max** | **Mandatory** | **Description** | -| | | | **or Optional** | | -+=========================+===========+===========+========================+===============================================+ -| **MPI AALES** | | | | | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| numProcsX | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | -| | | | | domain decomposition in X | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| numProcsY | 1 | INT_MAX | Mandatory | Number of cores to be used for horizontal | -| | | | | domain decomposition in Y | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **CUDA AALES** | | | | | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| tBx | 1 | INT_MAX | Mandatory | Number of threads in x-dimension | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| tBy | 1 | INT_MAX | Mandatory | Number of threads in y-dimension | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| tBz | 1 | INT_MAX | Mandatory | Number of threads in z-dimension | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **IO** | | | | | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| inPath | N/A | N/A | Optional | Path where initial/restart file is read in | -| | | | | from | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| inFile | N/A | N/A | Optional | Name of the input file for coordinate system | -| | | | | and initial or restart conditions | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| outPath | N/A | N/A | Mandatory | Path where output files are to be written | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| outFileBase | N/A | N/A | Mandatory | Base name of the output file series as in | -| | | | | (outFileBase).element-in-series | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| frqOutput | 0 | INT_MAX | Mandatory | Frequency (in timesteps) at which to produce | -| | | | | output | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| ioOutputMode | 0 | 1 | Optional | 0: N-to-1 gather and write to a netcdf file; | -| | | | | 1:N-to-N writes of FastEddy binary files | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **GRID** | | | | | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Nx | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | x (zonal) direction | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Ny | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | y (meridional) direction | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Nz | 1 | INT_MAX | Mandatory | Number of discretised domain elements in the | -| | | | | z (vertical) direction | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Nh | 0 | INT_MAX | Mandatory | Number of halo cells to be used (dependent | -| | | | | on largest stencil extent) | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| d_xi | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'i' direction | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| d_eta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'j' direction | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| d_zeta | FLT_MIN | FLT_MAX | Mandatory | Computational domain fixed resolution in the | -| | | | | 'k' direction | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| coordHorizHalos | 0 | 1 | Mandatory | Switch to setup coordiante halos as | -| | | | | periodic=1 or gradient-following=0 | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| topoFile | N/A | N/A | Optional | A file containing topography (surface | -| | | | | elevation in meters ASL) | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| verticalDeformSwitch | 0 | 1 | Mandatory | Switch to use vertical coordinate deformation | -| | | | | 0=off, 1=on | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| verticalDeformFactor | 0.0 | 1.0 | Mandatory | Deformation factor (0.0=max compression; | -| | | | | 1.0=no compression) | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| verticalDeformQuadCoeff | -2.0 | 2.0 | Mandatory | Deformation factor (0.0=max compression; | -| | | | | 1.0=no compression) | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| **TIME INTEGRATION** | | | | | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| timeMethod | 0 | 0 | Mandatory | Selector for time integration method. | -| | | | | [0=RK3-WS2002 (default)] | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| Nt | 1 | INT_MAX | Mandatory | Number of timesteps to perform | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| dt | FLT_MIN | FLT_MAX | Mandatory | Timestep resolution in seconds | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ -| NtBatch | 1 | Nt | Mandatory | Number of timesteps to compute in batch | -| | | | | launch; must have NtBatch <= Nt | -+-------------------------+-----------+-----------+------------------------+-----------------------------------------------+ +HYDRO CORE +========== + +BOUNDARY CONDITIONS +------------------- + +.. csv-table:: + :file: csv/hydro_core_boundary_cond.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + + +HYDRO_IO/LOGGING +---------------- + +.. csv-table:: + :file: csv/hydro_core_io_logging.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +ADVECTION +--------- +.. csv-table:: + :file: csv/hydro_core_advection.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable +MOISTURE +-------- +.. csv-table:: + :file: csv/hydro_core_moisture.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +CORIOLIS +-------- + +.. csv-table:: + :file: csv/hydro_core_coriolis.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +TURBULENCE +---------- + +.. csv-table:: + :file: csv/hydro_core_turbulence.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +CANOPY +------ + +.. csv-table:: + :file: csv/hydro_core_canopy.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +DIFFUSION +--------- + +.. csv-table:: + :file: csv/hydro_core_diffusion.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +AUXILIARY SCALARS AND SOURCES +----------------------------- + +.. csv-table:: + :file: csv/hydro_core_auxiliary_scalars.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +EXPLICIT FILTERS +---------------- + +.. csv-table:: + :file: csv/hydro_core_explicit_filters.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +RAYLEIGH DAMPING LAYER +---------------------- + +.. csv-table:: + :file: csv/hydro_core_rayleigh_damping_layer.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +SURFACE LAYER +------------- + +.. csv-table:: + :file: csv/hydro_core_surface_layer.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +CELL PERTURBATION METHOD +------------------------ + +.. csv-table:: + :file: csv/hydro_core_cell_perturbation.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +BASE-STATE +---------- + +.. csv-table:: + :file: csv/hydro_core_base_state.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable + +LARGE SCALE FORCINGS +-------------------- + +.. csv-table:: + :file: csv/hydro_core_large_scale_forcings.csv + :delim: , + :widths: 30, 18, 18, 20, 35 + :class: longtable From 708c73a5465aa5995cff10044279dca45060b6c3 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 15:57:12 -0600 Subject: [PATCH 08/65] Per #91, removed additional commas --- docs/csv/hydro_core_base_state.csv | 2 +- docs/csv/hydro_core_io_logging.csv | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv index 287faa2..17cddb4 100644 --- a/docs/csv/hydro_core_base_state.csv +++ b/docs/csv/hydro_core_base_state.csv @@ -1,4 +1,4 @@ -stabilityScheme, 0, 4, Mandatory, Scheme used to set hydrostatic, stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) +stabilityScheme, 0, 4, Mandatory, Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) temp_grnd, FLT_MIN, FLT_MAX, Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields pres_grnd, FLT_MIN, FLT_MAX, Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields zStableBottom, 0, FLT_MAX, Mandatory, Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2 diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index 5bd2585..c064823 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,4 +1,4 @@ hydroForcingWrite, 0, 1, Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on hydroSubGridWrite, 0, 1, Mandatory, Switch for dumping Tauij fields. 0=off; 1=on -hydroForcingLog, 0, 1, Mandatory, Switch for logging Frhs min/max, etc. 0=off; 1=on +hydroForcingLog, 0, 1, Mandatory, Switch for logging Frhs min/max etc. 0=off; 1=on From a922013f996b17815d8737bd073856a0c51db018 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 16:26:46 -0600 Subject: [PATCH 09/65] Per #91, adding a new column for defaults --- docs/_static/custom.css | 5 ++- docs/csv/fecuda.csv | 6 +-- docs/csv/femain.csv | 6 +-- docs/csv/grid.csv | 24 +++++------ docs/csv/hydro_core_advection.csv | 4 +- docs/csv/hydro_core_auxiliary_scalars.csv | 10 ++--- docs/csv/hydro_core_base_state.csv | 36 ++++++++--------- docs/csv/hydro_core_boundary_cond.csv | 12 +++--- docs/csv/hydro_core_canopy.csv | 8 ++-- docs/csv/hydro_core_cell_perturbation.csv | 22 +++++----- docs/csv/hydro_core_coriolis.csv | 4 +- docs/csv/hydro_core_diffusion.csv | 4 +- docs/csv/hydro_core_explicit_filters.csv | 6 +-- docs/csv/hydro_core_io_logging.csv | 6 +-- docs/csv/hydro_core_large_scale_forcings.csv | 36 ++++++++--------- docs/csv/hydro_core_moisture.csv | 20 +++++----- .../csv/hydro_core_rayleigh_damping_layer.csv | 4 +- docs/csv/hydro_core_surface_layer.csv | 34 ++++++++-------- docs/csv/hydro_core_turbulence.csv | 12 +++--- docs/csv/io.csv | 12 +++--- docs/csv/time_integration.csv | 8 ++-- docs/parameters.rst | 40 +++++++++---------- 22 files changed, 160 insertions(+), 159 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 35662cb..d743b23 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -23,6 +23,7 @@ .longtable td:nth-child(1) { width: 25% !important; } /* Name */ .longtable td:nth-child(2) { width: 10% !important; } /* Min */ .longtable td:nth-child(3) { width: 10% !important; } /* Max */ -.longtable td:nth-child(4) { width: 20% !important; } /* Mandatory/Optional */ -.longtable td:nth-child(5) { width: 35% !important; } /* Description */ +.longtable td:nth-child(4) { width: 10% !important; } /* Default */ +.longtable td:nth-child(5) { width: 20% !important; } /* Mandatory/Optional */ +.longtable td:nth-child(6) { width: 35% !important; } /* Description */ diff --git a/docs/csv/fecuda.csv b/docs/csv/fecuda.csv index f4db708..6e6d3e3 100644 --- a/docs/csv/fecuda.csv +++ b/docs/csv/fecuda.csv @@ -1,3 +1,3 @@ -tBx, 1, INT_MAX, Mandatory, Number of threads in x-dimension -tBy, 1, INT_MAX, Mandatory, Number of threads in y-dimension -tBz, 1, INT_MAX, Mandatory, Number of threads in z-dimension \ No newline at end of file +tBx, 1, INT_MAX, , Mandatory, Number of threads in x-dimension +tBy, 1, INT_MAX, , Mandatory, Number of threads in y-dimension +tBz, 1, INT_MAX, , Mandatory, Number of threads in z-dimension \ No newline at end of file diff --git a/docs/csv/femain.csv b/docs/csv/femain.csv index 87c2dac..919990f 100644 --- a/docs/csv/femain.csv +++ b/docs/csv/femain.csv @@ -1,3 +1,3 @@ -Name, Min, Max, Mandatory or Optional, Description -numProcsX, 1, INT_MAX, Mandatory, Number of cores to be used for horizontal domain decomposition in X -numProcsY, 1, INT_MAX, Mandatory, Number of cores to be used for horizontal domain decomposition in Y \ No newline at end of file +Name, Min, Max, Default, Mandatory or Optional, Description +numProcsX, 1, INT_MAX, , Mandatory, Number of cores to be used for horizontal domain decomposition in X +numProcsY, 1, INT_MAX, , Mandatory, Number of cores to be used for horizontal domain decomposition in Y \ No newline at end of file diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index bbdcbbb..4828aa7 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,12 +1,12 @@ -Nx, 1, INT_MAX, Mandatory, Number of discretised domain elements in the x (zonal) direction -Ny, 1, INT_MAX, Mandatory, Number of discretised domain elements in the y (meridional) direction -Nz, 1, INT_MAX, Mandatory, Number of discretised domain elements in the z (vertical) direction -Nh, 0, INT_MAX, Mandatory, Number of halo cells to be used (dependent on largest stencil extent) -d_xi, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the 'i' direction -d_eta, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the 'j' direction -d_zeta, FLT_MIN, FLT_MAX, Mandatory, Computational domain fixed resolution in the 'k' direction -coordHorizHalos, 0, 1, Mandatory, Switch to setup coordiante halos as periodic=1 or gradient-following=0 -topoFile, N/A, N/A, Optional, A file containing topography (surface elevation in meters ASL) -verticalDeformSwitch, 0, 1, Mandatory, Switch to use vertical coordinate deformation 0=off; 1=on -verticalDeformFactor, 0.0, 1.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) -verticalDeformQuadCoeff, -2.0, 2.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) \ No newline at end of file +Nx, 1, INT_MAX, , Mandatory, Number of discretised domain elements in the x (zonal) direction +Ny, 1, INT_MAX, , Mandatory, Number of discretised domain elements in the y (meridional) direction +Nz, 1, INT_MAX, , Mandatory, Number of discretised domain elements in the z (vertical) direction +Nh, 0, INT_MAX, , Mandatory, Number of halo cells to be used (dependent on largest stencil extent) +d_xi, FLT_MIN, FLT_MAX, , Mandatory, Computational domain fixed resolution in the 'i' direction +d_eta, FLT_MIN, FLT_MAX, , Mandatory, Computational domain fixed resolution in the 'j' direction +d_zeta, FLT_MIN, FLT_MAX, , Mandatory, Computational domain fixed resolution in the 'k' direction +coordHorizHalos, 0, 1, , Mandatory, Switch to setup coordiante halos as periodic=1 or gradient-following=0 +topoFile, N/A, N/A, , Optional, A file containing topography (surface elevation in meters ASL) +verticalDeformSwitch, 0, 1, , Mandatory, Switch to use vertical coordinate deformation 0=off; 1=on +verticalDeformFactor, 0.0, 1.0, , Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) +verticalDeformQuadCoeff, -2.0, 2.0, , Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) \ No newline at end of file diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv index c238d00..bfb3883 100644 --- a/docs/csv/hydro_core_advection.csv +++ b/docs/csv/hydro_core_advection.csv @@ -1,2 +1,2 @@ -advectionSelector, 0, 6, Mandatory, Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order -b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid \ No newline at end of file +advectionSelector, 0, 6, , Mandatory, Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order +b_hyb, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 7ad31e8..6b40bd9 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -1,5 +1,5 @@ -NhydroAuxScalars, 0, MAX_AUXSC_SRC, Optional, Number of prognostic auxiliary scalar fields -AuxScAdvSelector, 0, 6, Mandatory, Advection scheme for auxiliary scalar fields -AuxScAdvSelector_b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter -AuxScSGSturb, 0, 1, Mandatory, Selector to apply sub-grid scale diffusion to auxiliary scalar fields -srcAuxScFile, N/A, N/A, Optional, The path and filename to an Auxilliary Scalar Sources specification file \ No newline at end of file +NhydroAuxScalars, 0, MAX_AUXSC_SRC, , Optional, Number of prognostic auxiliary scalar fields +AuxScAdvSelector, 0, 6, , Mandatory, Advection scheme for auxiliary scalar fields +AuxScAdvSelector_b_hyb, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter +AuxScSGSturb, 0, 1, , Mandatory, Selector to apply sub-grid scale diffusion to auxiliary scalar fields +srcAuxScFile, N/A, N/A, , Optional, The path and filename to an Auxilliary Scalar Sources specification file \ No newline at end of file diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv index 17cddb4..cd77872 100644 --- a/docs/csv/hydro_core_base_state.csv +++ b/docs/csv/hydro_core_base_state.csv @@ -1,18 +1,18 @@ -stabilityScheme, 0, 4, Mandatory, Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) -temp_grnd, FLT_MIN, FLT_MAX, Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields -pres_grnd, FLT_MIN, FLT_MAX, Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields -zStableBottom, 0, FLT_MAX, Mandatory, Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2 -stableGradient, FLT_MIN, FLT_MAX, Mandatory, Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2 -zStableBottom2, 0, FLT_MAX, Mandatory, Height (m) of the second stable upper-layer when stabilityScheme = 2 -stableGradient2, FLT_MIN, FLT_MAX, Mandatory, Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2 -zStableBottom3, 0, FLT_MAX, Mandatory, Height (m) of the third stable upper-layer when stabilityScheme = 2 -stableGradient3, FLT_MIN, FLT_MAX, Mandatory, Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2 -thetaPerturbationSwitch, 0, 1, Mandatory, Switch to include initial theta perturbations: 0=off; 1=on -thetaHeight, 0.0, FLT_MAX, Mandatory, Height below which to include initial theta perturbations: (meters) -thetaAmplitude, 0.0, 2.0, Mandatory, Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K -U_g, -FLT_MAX, FLT_MAX, Mandatory, Zonal (West-East) component of the geostrophic wind (m/s) -V_g, -FLT_MAX, FLT_MAX, Mandatory, Meridional (South-North) component of the geostrophic wind (m/s) -z_Ug, 0.0, FLT_MAX, Mandatory, Height (m) above ground for linear geostrophic wind gradient (zonal component) -z_Vg, 0.0, FLT_MAX, Mandatory, Height (m) above ground for linear geostrophic wind gradient (meridional component) -Ug_grad, -1e2, 1e2, Mandatory, Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m) -Vg_grad, -1e2, 1e2, Mandatory, Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m) \ No newline at end of file +stabilityScheme, 0, 4, , Mandatory, Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) +temp_grnd, FLT_MIN, FLT_MAX, , Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields +pres_grnd, FLT_MIN, FLT_MAX, , Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields +zStableBottom, 0, FLT_MAX, , Mandatory, Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2 +stableGradient, FLT_MIN, FLT_MAX, , Mandatory, Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2 +zStableBottom2, 0, FLT_MAX, , Mandatory, Height (m) of the second stable upper-layer when stabilityScheme = 2 +stableGradient2, FLT_MIN, FLT_MAX, , Mandatory, Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2 +zStableBottom3, 0, FLT_MAX, , Mandatory, Height (m) of the third stable upper-layer when stabilityScheme = 2 +stableGradient3, FLT_MIN, FLT_MAX, , Mandatory, Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2 +thetaPerturbationSwitch, 0, 1, , Mandatory, Switch to include initial theta perturbations: 0=off; 1=on +thetaHeight, 0.0, FLT_MAX, , Mandatory, Height below which to include initial theta perturbations: (meters) +thetaAmplitude, 0.0, 2.0, , Mandatory, Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K +U_g, -FLT_MAX, FLT_MAX, , Mandatory, Zonal (West-East) component of the geostrophic wind (m/s) +V_g, -FLT_MAX, FLT_MAX, , Mandatory, Meridional (South-North) component of the geostrophic wind (m/s) +z_Ug, 0.0, FLT_MAX, , Mandatory, Height (m) above ground for linear geostrophic wind gradient (zonal component) +z_Vg, 0.0, FLT_MAX, , Mandatory, Height (m) above ground for linear geostrophic wind gradient (meridional component) +Ug_grad, -1e2, 1e2, , Mandatory, Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m) +Vg_grad, -1e2, 1e2, , Mandatory, Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m) \ No newline at end of file diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index 628f0db..c33866e 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,6 +1,6 @@ -hydroBCs, 1, 2, Mandatory, Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl -ceilingAdvectionBC, 0, 1, Optional, Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC) -hydroBndysFileBase, N/A, N/A, Optional, Base file name LAD BC set (hydroBCs=1) -hydroBndysFileStart, 0, 500000, Mandatory, Start counter value for LAD BC set files (hydroBCs=1) -hydroBndysFileEnd, 0, 500000, Mandatory, End counter value for LAD BC set files (hydroBCs=1) -dtBdyPlaneBCs, 0.0, 6e5, Mandatory, Delta in time (seconds) between BdyPlane sets +hydroBCs, 1, 2, , Mandatory, Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl +ceilingAdvectionBC, 0, 1, , Optional, Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC) +hydroBndysFileBase, N/A, N/A, , Optional, Base file name LAD BC set (hydroBCs=1) +hydroBndysFileStart, 0, 500000, , Mandatory, Start counter value for LAD BC set files (hydroBCs=1) +hydroBndysFileEnd, 0, 500000, , Mandatory, End counter value for LAD BC set files (hydroBCs=1) +dtBdyPlaneBCs, 0.0, 6e5, , Mandatory, Delta in time (seconds) between BdyPlane sets diff --git a/docs/csv/hydro_core_canopy.csv b/docs/csv/hydro_core_canopy.csv index e5a6860..e2c8546 100644 --- a/docs/csv/hydro_core_canopy.csv +++ b/docs/csv/hydro_core_canopy.csv @@ -1,4 +1,4 @@ -canopySelector, 0, 1, Optional, Canopy selector: 0=off; 1=on -canopySkinOpt, 0, 1, Mandatory, Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on -canopy_cd, 0.0, 1e+2, Mandatory, Non-dimensional canopy drag coefficient -canopy_lf, 0.0, 1e+2, Mandatory, Representative canopy element length scale +canopySelector, 0, 1, , Optional, Canopy selector: 0=off; 1=on +canopySkinOpt, 0, 1, , Mandatory, Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on +canopy_cd, 0.0, 1e+2, , Mandatory, Non-dimensional canopy drag coefficient +canopy_lf, 0.0, 1e+2, , Mandatory, Representative canopy element length scale diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv index 4d164aa..0964649 100644 --- a/docs/csv/hydro_core_cell_perturbation.csv +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -1,11 +1,11 @@ -cellpertSelector, 0, 1, Optional, CP method selector: 0=off; 1=on -cellpert_sw2b, 0, 3, Mandatory, Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south -cellpert_amp, 0.0, 20.0, Mandatory, Maximum amplitude for the potential temperature perturbations -cellpert_nts, 0, 1e+6, Optional, Number of time steps after which perturbations are seeded -cellpert_gppc, 0, 50, Mandatory, Number of grid points conforming the cell -cellpert_ndbc, 0, 10, Mandatory, Number of cells normal to domain lateral boundaries -cellpert_kbottom, 1, 10, Mandatory, Z-grid point where the perturbations start -cellpert_ktop, 0, 200, Mandatory, Z-grid point where the perturbations end -cellpert_tvcp, 0, 1, Mandatory, Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) -cellpert_eckert, 0.0, 10.0, Mandatory, Eckert number for the potential temperature perturbations (hydroBCs == 1) -cellpert_tsfact, 0.0, 10.0, Mandatory, Factor on the refreshing perturbation time scale (hydroBCs == 1) +cellpertSelector, 0, 1, , Optional, CP method selector: 0=off; 1=on +cellpert_sw2b, 0, 3, , Mandatory, Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south +cellpert_amp, 0.0, 20.0, , Mandatory, Maximum amplitude for the potential temperature perturbations +cellpert_nts, 0, 1e+6, , Optional, Number of time steps after which perturbations are seeded +cellpert_gppc, 0, 50, , Mandatory, Number of grid points conforming the cell +cellpert_ndbc, 0, 10, , Mandatory, Number of cells normal to domain lateral boundaries +cellpert_kbottom, 1, 10, , Mandatory, Z-grid point where the perturbations start +cellpert_ktop, 0, 200, , Mandatory, Z-grid point where the perturbations end +cellpert_tvcp, 0, 1, , Mandatory, Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) +cellpert_eckert, 0.0, 10.0, , Mandatory, Eckert number for the potential temperature perturbations (hydroBCs == 1) +cellpert_tsfact, 0.0, 10.0, , Mandatory, Factor on the refreshing perturbation time scale (hydroBCs == 1) diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv index 8c4e094..25d434f 100644 --- a/docs/csv/hydro_core_coriolis.csv +++ b/docs/csv/hydro_core_coriolis.csv @@ -1,2 +1,2 @@ -coriolisSelector, 0, 2, Mandatory, Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical -coriolisLatitude, -90.0, 90.0, Mandatory, Charactersitc latitude in degrees from equator of the LES domain \ No newline at end of file +coriolisSelector, 0, 2, , Mandatory, Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical +coriolisLatitude, -90.0, 90.0, , Mandatory, Charactersitc latitude in degrees from equator of the LES domain \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv index cf31cfb..7a3e111 100644 --- a/docs/csv/hydro_core_diffusion.csv +++ b/docs/csv/hydro_core_diffusion.csv @@ -1,2 +1,2 @@ -diffusionSelector, 0, 1, Mandatory, Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity -nu_0, 0, FLT_MAX, Mandatory, Constant diffusivity used when diffusionSelector=1 \ No newline at end of file +diffusionSelector, 0, 1, , Mandatory, Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity +nu_0, 0, FLT_MAX, , Mandatory, Constant diffusivity used when diffusionSelector=1 \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index 2978729..32bd1fa 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,3 +1,3 @@ -filterSelector, 0, 1, Mandatory, Explicit filter selector: 0=off; 1=on -filter_6thdiff_vert, 0, 1, Optional, Vertical 6th-order filter on w selector: 0=off; 1=on -filter_6thdiff_vert_coeff, 0.0, 1.0, Mandatory, Vertical 6th-order filter w factor: 0.0=off; 1.0=full +filterSelector, 0, 1, , Mandatory, Explicit filter selector: 0=off; 1=on +filter_6thdiff_vert, 0, 1, , Optional, Vertical 6th-order filter on w selector: 0=off; 1=on +filter_6thdiff_vert_coeff, 0.0, 1.0, , Mandatory, Vertical 6th-order filter w factor: 0.0=off; 1.0=full diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index c064823..d72b64a 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,4 +1,4 @@ -hydroForcingWrite, 0, 1, Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on -hydroSubGridWrite, 0, 1, Mandatory, Switch for dumping Tauij fields. 0=off; 1=on -hydroForcingLog, 0, 1, Mandatory, Switch for logging Frhs min/max etc. 0=off; 1=on +hydroForcingWrite, 0, 1, , Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on +hydroSubGridWrite, 0, 1, , Mandatory, Switch for dumping Tauij fields. 0=off; 1=on +hydroForcingLog, 0, 1, , Mandatory, Switch for logging Frhs min/max etc. 0=off; 1=on diff --git a/docs/csv/hydro_core_large_scale_forcings.csv b/docs/csv/hydro_core_large_scale_forcings.csv index 1e6c9b1..fce3914 100644 --- a/docs/csv/hydro_core_large_scale_forcings.csv +++ b/docs/csv/hydro_core_large_scale_forcings.csv @@ -1,18 +1,18 @@ -lsfSelector, 0, 1, Mandatory, Large-scale forcings selector: 0=off; 1=on -lsf_horMnSubTerms, 0, 1, Mandatory, Large-scale subsidence terms Switch 0=off 1=on -lsf_freq, 1e-3, 1e+3, Mandatory, Large-scale forcing frequency (seconds) -lsf_w_surf, -1e+4, 1e+4, Mandatory, Large-scale forcing to w at the surface -lsf_w_lev1, -1e+4, 1e+4, Mandatory, Large-scale forcing to w at the first specified level -lsf_w_lev2, -1e+4, 1e+4, Mandatory, Large-scale forcing to w at the second specified level -lsf_w_zlev1, 0.0, 1e+4, Mandatory, Large-scale forcing to w height 1 -lsf_w_zlev2, 0.0, 1e+4, Mandatory, Large-scale forcing to w height 2 -lsf_th_surf, -1e+4, 1e+4, Mandatory, Large-scale forcing to theta at the surface -lsf_th_lev1, -1e+4, 1e+4, Mandatory, Large-scale forcing to theta at the first specified level -lsf_th_lev2, -1e+4, 1e+4, Mandatory, Large-scale forcing to theta at the second specified level -lsf_th_zlev1, 0.0, 1e+4, Mandatory, Large-scale forcing to theta height 1 -lsf_th_zlev2, 0.0, 1e+4, Mandatory, Large-scale forcing to theta height 2 -lsf_qv_surf, -1e+4, 1e+4, Mandatory, Large-scale forcing to qv at the first specified level -lsf_qv_lev1, -1e+4, 1e+4, Mandatory, Large-scale forcing to qv at the first specified level -lsf_qv_lev2, -1e+4, 1e+4, Mandatory, Large-scale forcing to qv at the second specified level -lsf_qv_zlev1, 0.0, 1e+4, Mandatory, Large-scale forcing to qv height 1 -lsf_qv_zlev2, 0.0, 1e+4, Mandatory, Large-scale forcing to qv height 2 \ No newline at end of file +lsfSelector, 0, 1, , Mandatory, Large-scale forcings selector: 0=off; 1=on +lsf_horMnSubTerms, 0, 1, , Mandatory, Large-scale subsidence terms Switch 0=off 1=on +lsf_freq, 1e-3, 1e+3, , Mandatory, Large-scale forcing frequency (seconds) +lsf_w_surf, -1e+4, 1e+4, , Mandatory, Large-scale forcing to w at the surface +lsf_w_lev1, -1e+4, 1e+4, , Mandatory, Large-scale forcing to w at the first specified level +lsf_w_lev2, -1e+4, 1e+4, , Mandatory, Large-scale forcing to w at the second specified level +lsf_w_zlev1, 0.0, 1e+4, , Mandatory, Large-scale forcing to w height 1 +lsf_w_zlev2, 0.0, 1e+4, , Mandatory, Large-scale forcing to w height 2 +lsf_th_surf, -1e+4, 1e+4, , Mandatory, Large-scale forcing to theta at the surface +lsf_th_lev1, -1e+4, 1e+4, , Mandatory, Large-scale forcing to theta at the first specified level +lsf_th_lev2, -1e+4, 1e+4, , Mandatory, Large-scale forcing to theta at the second specified level +lsf_th_zlev1, 0.0, 1e+4, , Mandatory, Large-scale forcing to theta height 1 +lsf_th_zlev2, 0.0, 1e+4, , Mandatory, Large-scale forcing to theta height 2 +lsf_qv_surf, -1e+4, 1e+4, , Mandatory, Large-scale forcing to qv at the first specified level +lsf_qv_lev1, -1e+4, 1e+4, , Mandatory, Large-scale forcing to qv at the first specified level +lsf_qv_lev2, -1e+4, 1e+4, , Mandatory, Large-scale forcing to qv at the second specified level +lsf_qv_zlev1, 0.0, 1e+4, , Mandatory, Large-scale forcing to qv height 1 +lsf_qv_zlev2, 0.0, 1e+4, , Mandatory, Large-scale forcing to qv height 2 \ No newline at end of file diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv index 97878e1..90a4564 100644 --- a/docs/csv/hydro_core_moisture.csv +++ b/docs/csv/hydro_core_moisture.csv @@ -1,10 +1,10 @@ -moistureSelector, 0, 1, Mandatory, Moisture selector: 0=off; 1=on -moistureNvars, 0, 2, Mandatory, Number of moisture species -moistureAdvSelectorQv, 0, 6, Mandatory, Water vapor advection scheme selector -moistureAdvSelectorQv_b, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter for water vapor -moistureAdvSelectorQi, 0, 2, Mandatory, Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) -moistureSGSturb, 0, 1, Mandatory, Selector to apply sub-grid scale diffusion to moisture fields -moistureCond, 1, 4, Mandatory, Selector to apply condensation to mositure fields -moistureCondTscale, 1e-4, 1000.0, Mandatory, Relaxation time in seconds -moistureCondBasePres, 0, 1, Mandatory, Selector to use base pressure for microphysics -moistureMPcallTscale, 1e-4, 1000.0, Mandatory, Time scale for microphysics to be called +moistureSelector, 0, 1, , Mandatory, Moisture selector: 0=off; 1=on +moistureNvars, 0, 2, , Mandatory, Number of moisture species +moistureAdvSelectorQv, 0, 6, , Mandatory, Water vapor advection scheme selector +moistureAdvSelectorQv_b, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter for water vapor +moistureAdvSelectorQi, 0, 2, , Mandatory, Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) +moistureSGSturb, 0, 1, , Mandatory, Selector to apply sub-grid scale diffusion to moisture fields +moistureCond, 1, 4, , Mandatory, Selector to apply condensation to mositure fields +moistureCondTscale, 1e-4, 1000.0, , Mandatory, Relaxation time in seconds +moistureCondBasePres, 0, 1, , Mandatory, Selector to use base pressure for microphysics +moistureMPcallTscale, 1e-4, 1000.0, , Mandatory, Time scale for microphysics to be called diff --git a/docs/csv/hydro_core_rayleigh_damping_layer.csv b/docs/csv/hydro_core_rayleigh_damping_layer.csv index 99942e8..027c1a5 100644 --- a/docs/csv/hydro_core_rayleigh_damping_layer.csv +++ b/docs/csv/hydro_core_rayleigh_damping_layer.csv @@ -1,2 +1,2 @@ -dampingLayerSelector, 0, 1, Mandatory, Rayleigh Damping Layer selector -dampingLayerDepth, 0.0, FLT_MAX, Mandatory, Rayleigh Damping Layer Depth +dampingLayerSelector, 0, 1, , Mandatory, Rayleigh Damping Layer selector +dampingLayerDepth, 0.0, FLT_MAX, , Mandatory, Rayleigh Damping Layer Depth diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index 13530a0..d2e118f 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -1,17 +1,17 @@ -surflayerSelector, 0, 3, Mandatory, Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr) -surflayer_z0, 1e-12, 1e+0, Mandatory, Roughness length (momentum) when surflayerSelector > 0 -surflayer_z0t, 1e-6, 1e+1, Mandatory, Roughness length (temperature) when surflayerSelector > 0 -surflayer_z0tdyn, 0, 2, Optional, Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff -surflayer_wth, -5e+0, 5e+0, Mandatory, Kinematic sensible heat flux at the surface when surflayerSelector = 1 -surflayer_tr, -1e+1, 1e+1, Mandatory, Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling) -surflayer_wq, -5e+0, 5e+0, Mandatory, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 -surflayer_qr, -1e+1, 1e+1, Mandatory, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 -surflayer_idealsine, 0, 1, Mandatory, Selector for idealized sinusoidal surface heat flux or skin temperature forcing -surflayer_ideal_ts, 0, 1e+5, Mandatory, Start time in seconds for the idealized sinusoidal surface forcing -surflayer_ideal_te, 0, 1e+5, Mandatory, End time in seconds for the idealized sinusoidal surface forcing -surflayer_ideal_amp, 0, 1e+3, Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing -surflayer_ideal_qts, 0, 1e+5, Mandatory, Start time in seconds for the idealized sinusoidal surface forcing (qv) -surflayer_ideal_qte, 0, 1e+5, Mandatory, End time in seconds for the idealized sinusoidal surface forcing (qv) -surflayer_ideal_qamp, 0, 1e+3, Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing (qv) -surflayer_qskin_input, 0, 1, Optional, Selector for file input (restart) value for qskin under surflayerSelector == 2 -surflayer_offshore, 0, 1, Mandatory, Offshore selector: 0=off;1=on \ No newline at end of file +surflayerSelector, 0, 3, , Mandatory, Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr) +surflayer_z0, 1e-12, 1e+0, , Mandatory, Roughness length (momentum) when surflayerSelector > 0 +surflayer_z0t, 1e-6, 1e+1, , Mandatory, Roughness length (temperature) when surflayerSelector > 0 +surflayer_z0tdyn, 0, 2, , Optional, Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff +surflayer_wth, -5e+0, 5e+0, , Mandatory, Kinematic sensible heat flux at the surface when surflayerSelector = 1 +surflayer_tr, -1e+1, 1e+1, , Mandatory, Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling) +surflayer_wq, -5e+0, 5e+0, , Mandatory, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 +surflayer_qr, -1e+1, 1e+1, , Mandatory, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 +surflayer_idealsine, 0, 1, , Mandatory, Selector for idealized sinusoidal surface heat flux or skin temperature forcing +surflayer_ideal_ts, 0, 1e+5, , Mandatory, Start time in seconds for the idealized sinusoidal surface forcing +surflayer_ideal_te, 0, 1e+5, , Mandatory, End time in seconds for the idealized sinusoidal surface forcing +surflayer_ideal_amp, 0, 1e+3, , Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing +surflayer_ideal_qts, 0, 1e+5, , Mandatory, Start time in seconds for the idealized sinusoidal surface forcing (qv) +surflayer_ideal_qte, 0, 1e+5, , Mandatory, End time in seconds for the idealized sinusoidal surface forcing (qv) +surflayer_ideal_qamp, 0, 1e+3, , Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing (qv) +surflayer_qskin_input, 0, 1, , Optional, Selector for file input (restart) value for qskin under surflayerSelector == 2 +surflayer_offshore, 0, 1, , Mandatory, Offshore selector: 0=off;1=on \ No newline at end of file diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv index 2738838..886495b 100644 --- a/docs/csv/hydro_core_turbulence.csv +++ b/docs/csv/hydro_core_turbulence.csv @@ -1,6 +1,6 @@ -turbulenceSelector, 0, 1, Mandatory, Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky -TKESelector, 0, 2, Mandatory, Prognostic TKE selector: 0=None; 1=Prognostic -TKEAdvSelector, 0, 6, Mandatory, SGSTKE advection selector -TKEAdvSelector_b_hyb, 0.0, 1.0, Mandatory, Hybrid advection scheme parameter -c_s, 1e-6, 1e6, Mandatory, Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0 -c_k, 1e-6, 1e6, Mandatory, Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0 \ No newline at end of file +turbulenceSelector, 0, 1, , Mandatory, Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky +TKESelector, 0, 2, , Mandatory, Prognostic TKE selector: 0=None; 1=Prognostic +TKEAdvSelector, 0, 6, , Mandatory, SGSTKE advection selector +TKEAdvSelector_b_hyb, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter +c_s, 1e-6, 1e6, , Mandatory, Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0 +c_k, 1e-6, 1e6, , Mandatory, Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0 \ No newline at end of file diff --git a/docs/csv/io.csv b/docs/csv/io.csv index a4a475a..ede800a 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -1,6 +1,6 @@ -inPath, N/A, N/A, Optional, Path where initial/restart file is read in from -inFile, N/A, N/A, Optional, Name of the input file for coordinate system and initial or restart conditions -outPath, N/A, N/A, Mandatory, Path where output files are to be written -outFileBase, N/A, N/A, Mandatory, Base name of the output file series as in (outFileBase).element-in-series -frqOutput, 0, INT_MAX, Mandatory, Frequency (in timesteps) at which to produce output -ioOutputMode, 0, 1, Optional, 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files \ No newline at end of file +inPath, N/A, N/A, , Optional, Path where initial/restart file is read in from +inFile, N/A, N/A, , Optional, Name of the input file for coordinate system and initial or restart conditions +outPath, N/A, N/A, , Mandatory, Path where output files are to be written +outFileBase, N/A, N/A, , Mandatory, Base name of the output file series as in (outFileBase).element-in-series +frqOutput, 0, INT_MAX, , Mandatory, Frequency (in timesteps) at which to produce output +ioOutputMode, 0, 1, , Optional, 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files \ No newline at end of file diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index 7412197..12d9c41 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,4 @@ -timeMethod, 0, 0, Mandatory, Selector for time integration method. [0=RK3-WS2002 (default)] -Nt, 1, INT_MAX, Mandatory, Number of timesteps to perform -dt, FLT_MIN, FLT_MAX, Mandatory, Timestep resolution in seconds -NtBatch, 1, Nt, Mandatory, Number of timesteps to compute in batch launch; must have NtBatch <= Nt \ No newline at end of file +timeMethod, 0, 0, , Mandatory, Selector for time integration method. [0=RK3-WS2002 (default)] +Nt, 1, INT_MAX, , Mandatory, Number of timesteps to perform +dt, FLT_MIN, FLT_MAX, , Mandatory, Timestep resolution in seconds +NtBatch, 1, Nt, , Mandatory, Number of timesteps to compute in batch launch; must have NtBatch <= Nt \ No newline at end of file diff --git a/docs/parameters.rst b/docs/parameters.rst index d5b397d..6fade7a 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -18,7 +18,7 @@ FEMAIN :file: csv/femain.csv :header-rows: 1 :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable FECUDA @@ -27,7 +27,7 @@ FECUDA .. csv-table:: :file: csv/fecuda.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable IO @@ -36,7 +36,7 @@ IO .. csv-table:: :file: csv/io.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable GRID @@ -44,7 +44,7 @@ GRID .. csv-table:: :file: csv/grid.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable TIME INTEGRATION @@ -53,7 +53,7 @@ TIME INTEGRATION .. csv-table:: :file: csv/time_integration.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable HYDRO CORE @@ -65,7 +65,7 @@ BOUNDARY CONDITIONS .. csv-table:: :file: csv/hydro_core_boundary_cond.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable @@ -75,7 +75,7 @@ HYDRO_IO/LOGGING .. csv-table:: :file: csv/hydro_core_io_logging.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable @@ -85,7 +85,7 @@ ADVECTION .. csv-table:: :file: csv/hydro_core_advection.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable MOISTURE @@ -94,7 +94,7 @@ MOISTURE .. csv-table:: :file: csv/hydro_core_moisture.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable CORIOLIS @@ -103,7 +103,7 @@ CORIOLIS .. csv-table:: :file: csv/hydro_core_coriolis.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable TURBULENCE @@ -112,7 +112,7 @@ TURBULENCE .. csv-table:: :file: csv/hydro_core_turbulence.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable CANOPY @@ -121,7 +121,7 @@ CANOPY .. csv-table:: :file: csv/hydro_core_canopy.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable DIFFUSION @@ -130,7 +130,7 @@ DIFFUSION .. csv-table:: :file: csv/hydro_core_diffusion.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable AUXILIARY SCALARS AND SOURCES @@ -139,7 +139,7 @@ AUXILIARY SCALARS AND SOURCES .. csv-table:: :file: csv/hydro_core_auxiliary_scalars.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable EXPLICIT FILTERS @@ -148,7 +148,7 @@ EXPLICIT FILTERS .. csv-table:: :file: csv/hydro_core_explicit_filters.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable RAYLEIGH DAMPING LAYER @@ -157,7 +157,7 @@ RAYLEIGH DAMPING LAYER .. csv-table:: :file: csv/hydro_core_rayleigh_damping_layer.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable SURFACE LAYER @@ -166,7 +166,7 @@ SURFACE LAYER .. csv-table:: :file: csv/hydro_core_surface_layer.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable CELL PERTURBATION METHOD @@ -175,7 +175,7 @@ CELL PERTURBATION METHOD .. csv-table:: :file: csv/hydro_core_cell_perturbation.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable BASE-STATE @@ -184,7 +184,7 @@ BASE-STATE .. csv-table:: :file: csv/hydro_core_base_state.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable LARGE SCALE FORCINGS @@ -193,5 +193,5 @@ LARGE SCALE FORCINGS .. csv-table:: :file: csv/hydro_core_large_scale_forcings.csv :delim: , - :widths: 30, 18, 18, 20, 35 + :widths: 30, 18, 18, 18, 20, 35 :class: longtable From a3b1c9b2b99fac138627d6db1c9fc98814489ab0 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 16:32:19 -0600 Subject: [PATCH 10/65] Per #91, adjusting spacing --- docs/_static/custom.css | 10 +++++----- docs/parameters.rst | 40 ++++++++++++++++++++-------------------- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index d743b23..cb17870 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -20,10 +20,10 @@ width: 100% !important; } -.longtable td:nth-child(1) { width: 25% !important; } /* Name */ -.longtable td:nth-child(2) { width: 10% !important; } /* Min */ -.longtable td:nth-child(3) { width: 10% !important; } /* Max */ -.longtable td:nth-child(4) { width: 10% !important; } /* Default */ +.longtable td:nth-child(1) { width: 20% !important; } /* Name */ +.longtable td:nth-child(2) { width: 8% !important; } /* Min */ +.longtable td:nth-child(3) { width: 8% !important; } /* Max */ +.longtable td:nth-child(4) { width: 8% !important; } /* Default */ .longtable td:nth-child(5) { width: 20% !important; } /* Mandatory/Optional */ -.longtable td:nth-child(6) { width: 35% !important; } /* Description */ +.longtable td:nth-child(6) { width: 36% !important; } /* Description */ diff --git a/docs/parameters.rst b/docs/parameters.rst index 6fade7a..331b556 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -18,7 +18,7 @@ FEMAIN :file: csv/femain.csv :header-rows: 1 :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable FECUDA @@ -27,7 +27,7 @@ FECUDA .. csv-table:: :file: csv/fecuda.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable IO @@ -36,7 +36,7 @@ IO .. csv-table:: :file: csv/io.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable GRID @@ -44,7 +44,7 @@ GRID .. csv-table:: :file: csv/grid.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable TIME INTEGRATION @@ -53,7 +53,7 @@ TIME INTEGRATION .. csv-table:: :file: csv/time_integration.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable HYDRO CORE @@ -65,7 +65,7 @@ BOUNDARY CONDITIONS .. csv-table:: :file: csv/hydro_core_boundary_cond.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable @@ -75,7 +75,7 @@ HYDRO_IO/LOGGING .. csv-table:: :file: csv/hydro_core_io_logging.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable @@ -85,7 +85,7 @@ ADVECTION .. csv-table:: :file: csv/hydro_core_advection.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable MOISTURE @@ -94,7 +94,7 @@ MOISTURE .. csv-table:: :file: csv/hydro_core_moisture.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable CORIOLIS @@ -103,7 +103,7 @@ CORIOLIS .. csv-table:: :file: csv/hydro_core_coriolis.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable TURBULENCE @@ -112,7 +112,7 @@ TURBULENCE .. csv-table:: :file: csv/hydro_core_turbulence.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable CANOPY @@ -121,7 +121,7 @@ CANOPY .. csv-table:: :file: csv/hydro_core_canopy.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable DIFFUSION @@ -130,7 +130,7 @@ DIFFUSION .. csv-table:: :file: csv/hydro_core_diffusion.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable AUXILIARY SCALARS AND SOURCES @@ -139,7 +139,7 @@ AUXILIARY SCALARS AND SOURCES .. csv-table:: :file: csv/hydro_core_auxiliary_scalars.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable EXPLICIT FILTERS @@ -148,7 +148,7 @@ EXPLICIT FILTERS .. csv-table:: :file: csv/hydro_core_explicit_filters.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable RAYLEIGH DAMPING LAYER @@ -157,7 +157,7 @@ RAYLEIGH DAMPING LAYER .. csv-table:: :file: csv/hydro_core_rayleigh_damping_layer.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable SURFACE LAYER @@ -166,7 +166,7 @@ SURFACE LAYER .. csv-table:: :file: csv/hydro_core_surface_layer.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable CELL PERTURBATION METHOD @@ -175,7 +175,7 @@ CELL PERTURBATION METHOD .. csv-table:: :file: csv/hydro_core_cell_perturbation.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable BASE-STATE @@ -184,7 +184,7 @@ BASE-STATE .. csv-table:: :file: csv/hydro_core_base_state.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable LARGE SCALE FORCINGS @@ -193,5 +193,5 @@ LARGE SCALE FORCINGS .. csv-table:: :file: csv/hydro_core_large_scale_forcings.csv :delim: , - :widths: 30, 18, 18, 18, 20, 35 + :widths: 20, 8, 8, 8, 20, 36 :class: longtable From e88d1ce7371f61f17c33345616581e66cabf1319 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 16:36:08 -0600 Subject: [PATCH 11/65] Per #91, removing widths in favor of leaving them in custom.css file --- docs/parameters.rst | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index 331b556..6330ec9 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -18,7 +18,6 @@ FEMAIN :file: csv/femain.csv :header-rows: 1 :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable FECUDA @@ -27,7 +26,6 @@ FECUDA .. csv-table:: :file: csv/fecuda.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable IO @@ -36,7 +34,6 @@ IO .. csv-table:: :file: csv/io.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable GRID @@ -44,7 +41,6 @@ GRID .. csv-table:: :file: csv/grid.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable TIME INTEGRATION @@ -53,7 +49,6 @@ TIME INTEGRATION .. csv-table:: :file: csv/time_integration.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable HYDRO CORE @@ -65,7 +60,6 @@ BOUNDARY CONDITIONS .. csv-table:: :file: csv/hydro_core_boundary_cond.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable @@ -75,7 +69,6 @@ HYDRO_IO/LOGGING .. csv-table:: :file: csv/hydro_core_io_logging.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable @@ -85,7 +78,6 @@ ADVECTION .. csv-table:: :file: csv/hydro_core_advection.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable MOISTURE @@ -94,7 +86,6 @@ MOISTURE .. csv-table:: :file: csv/hydro_core_moisture.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable CORIOLIS @@ -103,7 +94,6 @@ CORIOLIS .. csv-table:: :file: csv/hydro_core_coriolis.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable TURBULENCE @@ -112,7 +102,6 @@ TURBULENCE .. csv-table:: :file: csv/hydro_core_turbulence.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable CANOPY @@ -121,7 +110,6 @@ CANOPY .. csv-table:: :file: csv/hydro_core_canopy.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable DIFFUSION @@ -130,7 +118,6 @@ DIFFUSION .. csv-table:: :file: csv/hydro_core_diffusion.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable AUXILIARY SCALARS AND SOURCES @@ -139,7 +126,6 @@ AUXILIARY SCALARS AND SOURCES .. csv-table:: :file: csv/hydro_core_auxiliary_scalars.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable EXPLICIT FILTERS @@ -148,7 +134,6 @@ EXPLICIT FILTERS .. csv-table:: :file: csv/hydro_core_explicit_filters.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable RAYLEIGH DAMPING LAYER @@ -157,7 +142,6 @@ RAYLEIGH DAMPING LAYER .. csv-table:: :file: csv/hydro_core_rayleigh_damping_layer.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable SURFACE LAYER @@ -166,7 +150,6 @@ SURFACE LAYER .. csv-table:: :file: csv/hydro_core_surface_layer.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable CELL PERTURBATION METHOD @@ -175,7 +158,6 @@ CELL PERTURBATION METHOD .. csv-table:: :file: csv/hydro_core_cell_perturbation.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable BASE-STATE @@ -184,7 +166,6 @@ BASE-STATE .. csv-table:: :file: csv/hydro_core_base_state.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable LARGE SCALE FORCINGS @@ -193,5 +174,4 @@ LARGE SCALE FORCINGS .. csv-table:: :file: csv/hydro_core_large_scale_forcings.csv :delim: , - :widths: 20, 8, 8, 8, 20, 36 :class: longtable From d418178c0d443a17735fa3bede2a141a2bc2ae69 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 16:42:43 -0600 Subject: [PATCH 12/65] Per #91, correcting femain to be fempi. --- docs/csv/{femain.csv => fempi.csv} | 0 docs/parameters.rst | 6 +++--- 2 files changed, 3 insertions(+), 3 deletions(-) rename docs/csv/{femain.csv => fempi.csv} (100%) diff --git a/docs/csv/femain.csv b/docs/csv/fempi.csv similarity index 100% rename from docs/csv/femain.csv rename to docs/csv/fempi.csv diff --git a/docs/parameters.rst b/docs/parameters.rst index 6330ec9..cba3630 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -11,11 +11,11 @@ brief description. These definitions serve as a reference to ensure correct configuration and valid inputs for FastEddy simulations. -FEMAIN -====== +FEMPI +===== .. csv-table:: - :file: csv/femain.csv + :file: csv/fempi.csv :header-rows: 1 :delim: , :class: longtable From e76937cd6bb2e4abe9d31af92ec1eab49e0537d8 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 15 Sep 2025 16:48:30 -0600 Subject: [PATCH 13/65] Per #91, header column name change to Requirement. --- docs/csv/fempi.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/fempi.csv b/docs/csv/fempi.csv index 919990f..5c47998 100644 --- a/docs/csv/fempi.csv +++ b/docs/csv/fempi.csv @@ -1,3 +1,3 @@ -Name, Min, Max, Default, Mandatory or Optional, Description +Name, Min, Max, Default, Requirement, Description numProcsX, 1, INT_MAX, , Mandatory, Number of cores to be used for horizontal domain decomposition in X numProcsY, 1, INT_MAX, , Mandatory, Number of cores to be used for horizontal domain decomposition in Y \ No newline at end of file From 21ac77616582e4ae97dc2f8b6f4f33d990597c72 Mon Sep 17 00:00:00 2001 From: jprestop Date: Wed, 17 Sep 2025 15:45:04 -0600 Subject: [PATCH 14/65] Per #91, updating to add defaults and conditional requirements --- docs/csv/grid.csv | 18 ++++---- docs/csv/hydro_core_advection.csv | 4 +- docs/csv/hydro_core_auxiliary_scalars.csv | 19 ++++++--- docs/csv/hydro_core_base_state.csv | 37 +++++++++-------- docs/csv/hydro_core_boundary_cond.csv | 12 +++--- docs/csv/hydro_core_canopy.csv | 8 ++-- docs/csv/hydro_core_cell_perturbation.csv | 22 +++++----- docs/csv/hydro_core_coriolis.csv | 4 +- docs/csv/hydro_core_diffusion.csv | 4 +- docs/csv/hydro_core_explicit_filters.csv | 9 ++-- docs/csv/hydro_core_io_logging.csv | 6 +-- docs/csv/hydro_core_large_scale_forcings.csv | 36 ++++++++-------- docs/csv/hydro_core_moisture.csv | 20 ++++----- .../csv/hydro_core_rayleigh_damping_layer.csv | 4 +- docs/csv/hydro_core_surface_layer.csv | 41 +++++++++++-------- docs/csv/hydro_core_turbulence.csv | 12 +++--- docs/csv/time_integration.csv | 8 ++-- 17 files changed, 142 insertions(+), 122 deletions(-) diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 4828aa7..0421dba 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,12 +1,12 @@ -Nx, 1, INT_MAX, , Mandatory, Number of discretised domain elements in the x (zonal) direction -Ny, 1, INT_MAX, , Mandatory, Number of discretised domain elements in the y (meridional) direction -Nz, 1, INT_MAX, , Mandatory, Number of discretised domain elements in the z (vertical) direction -Nh, 0, INT_MAX, , Mandatory, Number of halo cells to be used (dependent on largest stencil extent) -d_xi, FLT_MIN, FLT_MAX, , Mandatory, Computational domain fixed resolution in the 'i' direction -d_eta, FLT_MIN, FLT_MAX, , Mandatory, Computational domain fixed resolution in the 'j' direction -d_zeta, FLT_MIN, FLT_MAX, , Mandatory, Computational domain fixed resolution in the 'k' direction -coordHorizHalos, 0, 1, , Mandatory, Switch to setup coordiante halos as periodic=1 or gradient-following=0 +Nx, 1, INT_MAX, 122, Mandatory, Number of discretised domain elements in the x (zonal) direction +Ny, 1, INT_MAX, 122, Mandatory, Number of discretised domain elements in the y (meridional) direction +Nz, 1, INT_MAX, 122, Mandatory, Number of discretised domain elements in the z (vertical) direction +Nh, 0, INT_MAX, 3, Mandatory, Number of halo cells to be used (dependent on largest stencil extent) +d_xi, FLT_MIN, FLT_MAX, 10.0, Mandatory, Computational domain fixed resolution in the 'i' direction +d_eta, FLT_MIN, FLT_MAX, 10.0, Mandatory, Computational domain fixed resolution in the 'j' direction +d_zeta, FLT_MIN, FLT_MAX, 10.0, Mandatory, Computational domain fixed resolution in the 'k' direction +coordHorizHalos, 0, 1, 1, Mandatory, Switch to setup coordiante halos as periodic=1 or gradient-following=0 topoFile, N/A, N/A, , Optional, A file containing topography (surface elevation in meters ASL) verticalDeformSwitch, 0, 1, , Mandatory, Switch to use vertical coordinate deformation 0=off; 1=on verticalDeformFactor, 0.0, 1.0, , Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) -verticalDeformQuadCoeff, -2.0, 2.0, , Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) \ No newline at end of file +verticalDeformQuadCoeff, -2.0, 2.0, 0.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) \ No newline at end of file diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv index bfb3883..dbaf6f3 100644 --- a/docs/csv/hydro_core_advection.csv +++ b/docs/csv/hydro_core_advection.csv @@ -1,2 +1,2 @@ -advectionSelector, 0, 6, , Mandatory, Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order -b_hyb, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid \ No newline at end of file +advectionSelector, 0, 6, 0, Mandatory, Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order +b_hyb, 0.0, 1.0, 0.8, Mandatory, Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 6b40bd9..9c0c944 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -1,5 +1,14 @@ -NhydroAuxScalars, 0, MAX_AUXSC_SRC, , Optional, Number of prognostic auxiliary scalar fields -AuxScAdvSelector, 0, 6, , Mandatory, Advection scheme for auxiliary scalar fields -AuxScAdvSelector_b_hyb, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter -AuxScSGSturb, 0, 1, , Mandatory, Selector to apply sub-grid scale diffusion to auxiliary scalar fields -srcAuxScFile, N/A, N/A, , Optional, The path and filename to an Auxilliary Scalar Sources specification file \ No newline at end of file +NhydroAuxScalars, 0, MAX_AUXSC_SRC (20), 0, Optional, Number of prognostic auxiliary scalar fields +AuxScAdvSelector, 0, 6, 0, Cond-Mand, Advection scheme for auxiliary scalar fields (Cond-Mand if NhydroAuxScalars > 0) +AuxScAdvSelector_b_hyb, 0.0, 1.0, 0.0, Cond-Mand, Hybrid advection scheme parameter (Cond-Mand if NhydroAuxScalars > 0) +AuxScSGSturb, 0, 1, 0, Cond-Mand, Selector to apply sub-grid scale diffusion to auxiliary scalar fields (Cond-Mand if NhydroAuxScalars > 0) +srcAuxScFile, N/A, N/A, , Cond-Opt, The path and filename to an Auxilliary Scalar Sources specification file (Cond-Opt if NhydroAuxScalars > 0) +srcAuxScTemporalType, 0, 1, 0, Cond-Mand, Temporal characterization of source (0=instantaneous; 1=continuous) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScStartSeconds, 0, FLT_MAX, 0, Cond-Mand, Source start time in seconds (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScDurationSeconds, 0, FLT_MAX, 30, Cond-Mand, Source duration in seconds (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScGeometryType, 0, 0, 0, Cond-Mand, 0=point (single cell volume); 1=line (line of surface cells) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScMassSpecType, 0, 0, 0, Cond-Mand, Mass specification type 0=strict mass in kg; 1=mass source rate in kg/s (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScMassSpecValue, 0.0, FLT_MAX, 1.0, Cond-Mand, Mass specification value in kg or kg/s given by srcAuxScMassSpecType 0 or 1 (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScLocation_X, -FLT_MAX, FLT_MAX, 0.0, Cond-Mand, Source geometry centroid postion in x (west-east) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScLocation_Y, -FLT_MAX, FLT_MAX, 0.0, Cond-Mand, Source geometry centroid postion in y (south-north) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) +srcAuxScLocation_Z, -FLT_MAX, FLT_MAX, 0.0, Cond-Mand, Source geometry centroid postion in z (vertical above the surface) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) \ No newline at end of file diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv index cd77872..23f7f5b 100644 --- a/docs/csv/hydro_core_base_state.csv +++ b/docs/csv/hydro_core_base_state.csv @@ -1,18 +1,19 @@ -stabilityScheme, 0, 4, , Mandatory, Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) -temp_grnd, FLT_MIN, FLT_MAX, , Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields -pres_grnd, FLT_MIN, FLT_MAX, , Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields -zStableBottom, 0, FLT_MAX, , Mandatory, Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2 -stableGradient, FLT_MIN, FLT_MAX, , Mandatory, Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2 -zStableBottom2, 0, FLT_MAX, , Mandatory, Height (m) of the second stable upper-layer when stabilityScheme = 2 -stableGradient2, FLT_MIN, FLT_MAX, , Mandatory, Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2 -zStableBottom3, 0, FLT_MAX, , Mandatory, Height (m) of the third stable upper-layer when stabilityScheme = 2 -stableGradient3, FLT_MIN, FLT_MAX, , Mandatory, Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2 -thetaPerturbationSwitch, 0, 1, , Mandatory, Switch to include initial theta perturbations: 0=off; 1=on -thetaHeight, 0.0, FLT_MAX, , Mandatory, Height below which to include initial theta perturbations: (meters) -thetaAmplitude, 0.0, 2.0, , Mandatory, Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K -U_g, -FLT_MAX, FLT_MAX, , Mandatory, Zonal (West-East) component of the geostrophic wind (m/s) -V_g, -FLT_MAX, FLT_MAX, , Mandatory, Meridional (South-North) component of the geostrophic wind (m/s) -z_Ug, 0.0, FLT_MAX, , Mandatory, Height (m) above ground for linear geostrophic wind gradient (zonal component) -z_Vg, 0.0, FLT_MAX, , Mandatory, Height (m) above ground for linear geostrophic wind gradient (meridional component) -Ug_grad, -1e2, 1e2, , Mandatory, Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m) -Vg_grad, -1e2, 1e2, , Mandatory, Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m) \ No newline at end of file +stabilityScheme, 0, 4, 0, Mandatory, Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) +temp_grnd, FLT_MIN, FLT_MAX, 300.0, Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields +pres_grnd, FLT_MIN, FLT_MAX, 1.0e5, Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields +zStableBottom, 0, FLT_MAX, 1000.0, Mandatory, Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2 +stableGradient, FLT_MIN, FLT_MAX, 0.1, Mandatory, Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2 +zStableBottom2, 0, FLT_MAX, 1100.0, Mandatory, Height (m) of the second stable upper-layer when stabilityScheme = 2 +stableGradient2, FLT_MIN, FLT_MAX, 0.03, Mandatory, Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2 +zStableBottom3, 0, FLT_MAX, 1500.0, Mandatory, Height (m) of the third stable upper-layer when stabilityScheme = 2 +stableGradient3, FLT_MIN, FLT_MAX, 0.03, Mandatory, Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2 +thetaPerturbationSwitch, 0, 1, 0, Mandatory, Switch to include initial theta perturbations: 0=off; 1=on +thetaHeight, 0.0, FLT_MAX, 0.0, Mandatory, Height below which to include initial theta perturbations: (meters) +thetaAmplitude, 0.0, 2.0, 0.0, Mandatory, Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K +U_g, -FLT_MAX, FLT_MAX, 0.0, Mandatory, Zonal (West-East) component of the geostrophic wind (m/s) +V_g, -FLT_MAX, FLT_MAX, 0.0, Mandatory, Meridional (South-North) component of the geostrophic wind (m/s) +z_Ug, 0.0, FLT_MAX, 10000.0, Mandatory, Height (m) above ground for linear geostrophic wind gradient (zonal component) +z_Vg, 0.0, FLT_MAX, 10000.0, Mandatory, Height (m) above ground for linear geostrophic wind gradient (meridional component) +Ug_grad, -1e2, 1e2, 0.0, Mandatory, Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m) +Vg_grad, -1e2, 1e2, 0.0, Mandatory, Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m) +physics_oneRKonly, 0, 1, 1, Optional, Selector to apply physics RHS forcing only at the latest RK stage: 0=off; 1=on \ No newline at end of file diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index c33866e..5580597 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,6 +1,6 @@ -hydroBCs, 1, 2, , Mandatory, Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl -ceilingAdvectionBC, 0, 1, , Optional, Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC) -hydroBndysFileBase, N/A, N/A, , Optional, Base file name LAD BC set (hydroBCs=1) -hydroBndysFileStart, 0, 500000, , Mandatory, Start counter value for LAD BC set files (hydroBCs=1) -hydroBndysFileEnd, 0, 500000, , Mandatory, End counter value for LAD BC set files (hydroBCs=1) -dtBdyPlaneBCs, 0.0, 6e5, , Mandatory, Delta in time (seconds) between BdyPlane sets +hydroBCs, 1, 2, 2, Mandatory, Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl +ceilingAdvectionBC, 0, 1, 0, Optional, Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC) +hydroBndysFileBase, N/A, N/A, , Cond-Opt, Base file name LAD BC set (Cond-Opt if hydroBCs==1) +hydroBndysFileStart, 0, 500000, 0, Cond-Mand, Start counter value for LAD BC set files (Cond-Mand if hydroBCs==1) +hydroBndysFileEnd, 0, 500000, 0, Cond-Mand, End counter value for LAD BC set files (Cond-Mand if hydroBCs==1) +dtBdyPlaneBCs, 0.0, 6e5, 0.0, Cond-Mand, Delta in time (seconds) between BdyPlane sets (Cond-Mand if hydroBCs==1) diff --git a/docs/csv/hydro_core_canopy.csv b/docs/csv/hydro_core_canopy.csv index e2c8546..51fc91e 100644 --- a/docs/csv/hydro_core_canopy.csv +++ b/docs/csv/hydro_core_canopy.csv @@ -1,4 +1,4 @@ -canopySelector, 0, 1, , Optional, Canopy selector: 0=off; 1=on -canopySkinOpt, 0, 1, , Mandatory, Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on -canopy_cd, 0.0, 1e+2, , Mandatory, Non-dimensional canopy drag coefficient -canopy_lf, 0.0, 1e+2, , Mandatory, Representative canopy element length scale +canopySelector, 0, 1, 0, Optional, Canopy selector: 0=off; 1=on +canopySkinOpt, 0, 1, 0, Cond-Mand, Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on (Cond-Mandif canopySelector==1) +canopy_cd, 0.0, 1e+2, 0.15, Cond-Mand, Non-dimensional canopy drag coefficient (Cond-Mandif canopySelector==1) +canopy_lf, 0.0, 1e+2, 0.1, Cond-Mand, Representative canopy element length scale (Cond-Mandif canopySelector==1) diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv index 0964649..5681b9c 100644 --- a/docs/csv/hydro_core_cell_perturbation.csv +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -1,11 +1,11 @@ -cellpertSelector, 0, 1, , Optional, CP method selector: 0=off; 1=on -cellpert_sw2b, 0, 3, , Mandatory, Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south -cellpert_amp, 0.0, 20.0, , Mandatory, Maximum amplitude for the potential temperature perturbations -cellpert_nts, 0, 1e+6, , Optional, Number of time steps after which perturbations are seeded -cellpert_gppc, 0, 50, , Mandatory, Number of grid points conforming the cell -cellpert_ndbc, 0, 10, , Mandatory, Number of cells normal to domain lateral boundaries -cellpert_kbottom, 1, 10, , Mandatory, Z-grid point where the perturbations start -cellpert_ktop, 0, 200, , Mandatory, Z-grid point where the perturbations end -cellpert_tvcp, 0, 1, , Mandatory, Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) -cellpert_eckert, 0.0, 10.0, , Mandatory, Eckert number for the potential temperature perturbations (hydroBCs == 1) -cellpert_tsfact, 0.0, 10.0, , Mandatory, Factor on the refreshing perturbation time scale (hydroBCs == 1) +cellpertSelector, 0, 1, 0, Optional, CP method selector: 0=off; 1=on +cellpert_nts, 0, 1e+6, 500, Optional, Number of time steps after which perturbations are seeded +cellpert_sw2b, 0, 3, 0, Cond-Mand, Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south (Cond-Mand if cellpertSelector > 0) +cellpert_amp, 0.0, 20.0, 0.5, Cond-Mand, Maximum amplitude for the potential temperature perturbations (Cond-Mand if cellpertSelector > 0) +cellpert_gppc, 0, 50, 8, Cond-Mand, Number of grid points conforming the cell (Cond-Mand if cellpertSelector > 0) +cellpert_ndbc, 0, 10, 3, Cond-Mand, Number of cells normal to domain lateral boundaries (Cond-Mand if cellpertSelector > 0) +cellpert_kbottom, 1, 10, 1, Cond-Mand, Z-grid point where the perturbations start (Cond-Mand if cellpertSelector > 0) +cellpert_ktop, 0, 200, 20, Cond-Mand, Z-grid point where the perturbations end (Cond-Mand if cellpertSelector > 0) +cellpert_tvcp, 0, 1, 0, Cond-Mand, Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) (Cond-Mand if cellpertSelector > 0) +cellpert_eckert, 0.0, 10.0, 0.2, Cond-Mand, Eckert number for the potential temperature perturbations (hydroBCs==1) (Cond-Mand if cellpertSelector > 0) +cellpert_tsfact, 0.0, 10.0, 1.0, Cond-Mand, Factor on the refreshing perturbation time scale (hydroBCs==1) (Cond-Mand if cellpertSelector > 0) diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv index 25d434f..5128883 100644 --- a/docs/csv/hydro_core_coriolis.csv +++ b/docs/csv/hydro_core_coriolis.csv @@ -1,2 +1,2 @@ -coriolisSelector, 0, 2, , Mandatory, Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical -coriolisLatitude, -90.0, 90.0, , Mandatory, Charactersitc latitude in degrees from equator of the LES domain \ No newline at end of file +coriolisSelector, 0, 2, 0, Mandatory, Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical +coriolisLatitude, -90.0, 90.0, 54.0, Mandatory, Charactersitc latitude in degrees from equator of the LES domain \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv index 7a3e111..512fd43 100644 --- a/docs/csv/hydro_core_diffusion.csv +++ b/docs/csv/hydro_core_diffusion.csv @@ -1,2 +1,2 @@ -diffusionSelector, 0, 1, , Mandatory, Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity -nu_0, 0, FLT_MAX, , Mandatory, Constant diffusivity used when diffusionSelector=1 \ No newline at end of file +diffusionSelector, 0, 1, 0, Mandatory, Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity +nu_0, 0, FLT_MAX, 1.0, Mandatory, Constant diffusivity used when diffusionSelector=1 \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index 32bd1fa..98920a4 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,3 +1,6 @@ -filterSelector, 0, 1, , Mandatory, Explicit filter selector: 0=off; 1=on -filter_6thdiff_vert, 0, 1, , Optional, Vertical 6th-order filter on w selector: 0=off; 1=on -filter_6thdiff_vert_coeff, 0.0, 1.0, , Mandatory, Vertical 6th-order filter w factor: 0.0=off; 1.0=full +filterSelector, 0, 1, 0, Mandatory, Explicit filter selector: 0=off; 1=on +filter_6thdiff_vert, 0, 1, 0, Cond-Opt, Vertical 6th-order filter on w selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) +filter_6thdiff_hori, 0, 1, 0, Cond-Opt, Horizontal 6th-order filter on rho,theta,qv selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) +filter_6thdiff_vert_coeff, 0.0, 1.0, 0.03, Cond-Mand, Vertical 6th-order filter factor: 0.0=off; 1.0=full (Cond-Mand if filterSelector == 1 and filter_6thdiff_vert == 1) +filter_6thdiff_hori_coeff, 0.0, 1.0, 0.03, Cond-Mand, Horizontal 6th-order filter factor: 0.0=off; 1.0=full (Cond-Mand if filterSelector == 1 and filter_6thdiff_hori == 1) +filter_divdamp, 0, 1, 0, Cond-Opt, Divergence damping selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) \ No newline at end of file diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index d72b64a..5a4078c 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,4 +1,4 @@ -hydroForcingWrite, 0, 1, , Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on -hydroSubGridWrite, 0, 1, , Mandatory, Switch for dumping Tauij fields. 0=off; 1=on -hydroForcingLog, 0, 1, , Mandatory, Switch for logging Frhs min/max etc. 0=off; 1=on +hydroForcingWrite, 0, 1, 0, Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on +hydroSubGridWrite, 0, 1, 0, Mandatory, Switch for dumping Tauij fields. 0=off; 1=on +hydroForcingLog, 0, 1, 0, Mandatory, Switch for logging Frhs min/max etc. 0=off; 1=on diff --git a/docs/csv/hydro_core_large_scale_forcings.csv b/docs/csv/hydro_core_large_scale_forcings.csv index fce3914..10b722a 100644 --- a/docs/csv/hydro_core_large_scale_forcings.csv +++ b/docs/csv/hydro_core_large_scale_forcings.csv @@ -1,18 +1,18 @@ -lsfSelector, 0, 1, , Mandatory, Large-scale forcings selector: 0=off; 1=on -lsf_horMnSubTerms, 0, 1, , Mandatory, Large-scale subsidence terms Switch 0=off 1=on -lsf_freq, 1e-3, 1e+3, , Mandatory, Large-scale forcing frequency (seconds) -lsf_w_surf, -1e+4, 1e+4, , Mandatory, Large-scale forcing to w at the surface -lsf_w_lev1, -1e+4, 1e+4, , Mandatory, Large-scale forcing to w at the first specified level -lsf_w_lev2, -1e+4, 1e+4, , Mandatory, Large-scale forcing to w at the second specified level -lsf_w_zlev1, 0.0, 1e+4, , Mandatory, Large-scale forcing to w height 1 -lsf_w_zlev2, 0.0, 1e+4, , Mandatory, Large-scale forcing to w height 2 -lsf_th_surf, -1e+4, 1e+4, , Mandatory, Large-scale forcing to theta at the surface -lsf_th_lev1, -1e+4, 1e+4, , Mandatory, Large-scale forcing to theta at the first specified level -lsf_th_lev2, -1e+4, 1e+4, , Mandatory, Large-scale forcing to theta at the second specified level -lsf_th_zlev1, 0.0, 1e+4, , Mandatory, Large-scale forcing to theta height 1 -lsf_th_zlev2, 0.0, 1e+4, , Mandatory, Large-scale forcing to theta height 2 -lsf_qv_surf, -1e+4, 1e+4, , Mandatory, Large-scale forcing to qv at the first specified level -lsf_qv_lev1, -1e+4, 1e+4, , Mandatory, Large-scale forcing to qv at the first specified level -lsf_qv_lev2, -1e+4, 1e+4, , Mandatory, Large-scale forcing to qv at the second specified level -lsf_qv_zlev1, 0.0, 1e+4, , Mandatory, Large-scale forcing to qv height 1 -lsf_qv_zlev2, 0.0, 1e+4, , Mandatory, Large-scale forcing to qv height 2 \ No newline at end of file +lsfSelector, 0, 1, 0, Mandatory, Large-scale forcings selector: 0=off; 1=on +lsf_horMnSubTerms, 0, 1, 0, Cond-Mand, Large-scale subsidence terms Switch 0=off 1=on (Cond-Mand if lsfSelector > 0) +lsf_freq, 1e-3, 1e+3, 1.0, Cond-Mand, Large-scale forcing frequency (seconds) (Cond-Mand if lsfSelector > 0) +lsf_w_surf, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to w at the surface (Cond-Mand if lsfSelector > 0) +lsf_w_lev1, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to w at the first specified level (Cond-Mand if lsfSelector > 0) +lsf_w_lev2, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to w at the second specified level (Cond-Mand if lsfSelector > 0) +lsf_w_zlev1, 0.0, 1e+4, 100.0, Cond-Mand, Large-scale forcing to w height 1 (Cond-Mand if lsfSelector > 0) +lsf_w_zlev2, 0.0, 1e+4, 200.0, Cond-Mand, Large-scale forcing to w height 2 (Cond-Mand if lsfSelector > 0) +lsf_th_surf, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to theta at the surface (Cond-Mand if lsfSelector > 0) +lsf_th_lev1, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to theta at the first specified level (Cond-Mand if lsfSelector > 0) +lsf_th_lev2, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to theta at the second specified level (Cond-Mand if lsfSelector > 0) +lsf_th_zlev1, 0.0, 1e+4, 100.0, Cond-Mand, Large-scale forcing to theta height 1 (Cond-Mand if lsfSelector > 0) +lsf_th_zlev2, 0.0, 1e+4, 200.0, Cond-Mand, Large-scale forcing to theta height 2 (Cond-Mand if lsfSelector > 0) +lsf_qv_surf, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to qv at the first specified level (Cond-Mand if lsfSelector > 0) +lsf_qv_lev1, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to qv at the first specified level (Cond-Mand if lsfSelector > 0) +lsf_qv_lev2, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to qv at the second specified level (Cond-Mand if lsfSelector > 0) +lsf_qv_zlev1, 0.0, 1e+4, 100.0, Cond-Mand, Large-scale forcing to qv height 1 (Cond-Mand if lsfSelector > 0) +lsf_qv_zlev2, 0.0, 1e+4, 200.0, Cond-Mand, Large-scale forcing to qv height 2 (Cond-Mand if lsfSelector > 0) \ No newline at end of file diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv index 90a4564..4edaf79 100644 --- a/docs/csv/hydro_core_moisture.csv +++ b/docs/csv/hydro_core_moisture.csv @@ -1,10 +1,10 @@ -moistureSelector, 0, 1, , Mandatory, Moisture selector: 0=off; 1=on -moistureNvars, 0, 2, , Mandatory, Number of moisture species -moistureAdvSelectorQv, 0, 6, , Mandatory, Water vapor advection scheme selector -moistureAdvSelectorQv_b, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter for water vapor -moistureAdvSelectorQi, 0, 2, , Mandatory, Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) -moistureSGSturb, 0, 1, , Mandatory, Selector to apply sub-grid scale diffusion to moisture fields -moistureCond, 1, 4, , Mandatory, Selector to apply condensation to mositure fields -moistureCondTscale, 1e-4, 1000.0, , Mandatory, Relaxation time in seconds -moistureCondBasePres, 0, 1, , Mandatory, Selector to use base pressure for microphysics -moistureMPcallTscale, 1e-4, 1000.0, , Mandatory, Time scale for microphysics to be called +moistureSelector, 0, 1, 0, Mandatory, Moisture selector: 0=off; 1=on +moistureNvars, 0, 2, 0, Cond-Mand, Number of moisture species (Cond-Mand if moistureSelector==1) +moistureAdvSelectorQv, 0, 6, 0, Cond-Mand, Water vapor advection scheme selector (Cond-Mand if moistureSelector==1) +moistureAdvSelectorQv_b, 0.0, 1.0, 0.0, Cond-Mand, Hybrid advection scheme parameter for water vapor (Cond-Mand if moistureSelector==1) +moistureAdvSelectorQi, 0, 2, 0, Cond-Mand, Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) (Cond-Mand if moistureSelector==1) +moistureSGSturb, 0, 1, 0, Cond-Mand, Selector to apply sub-grid scale diffusion to moisture fields (Cond-Mand if moistureSelector==1) +moistureCond, 1, 4, 1, Cond-Mand, Selector to apply condensation to mositure fields (Cond-Mand if moistureSelector==1) +moistureCondTscale, 1e-4, 1000.0, 1.0, Cond-Mand, Relaxation time in seconds (Cond-Mand if moistureSelector==1) +moistureCondBasePres, 0, 1, 0, Cond-Mand, Selector to use base pressure for microphysics (Cond-Mand if moistureSelector==1) +moistureMPcallTscale, 1e-4, 1000.0, 1.0, Cond-Mand, Time scale for microphysics to be called (Cond-Mand if moistureSelector==1) diff --git a/docs/csv/hydro_core_rayleigh_damping_layer.csv b/docs/csv/hydro_core_rayleigh_damping_layer.csv index 027c1a5..b5e687b 100644 --- a/docs/csv/hydro_core_rayleigh_damping_layer.csv +++ b/docs/csv/hydro_core_rayleigh_damping_layer.csv @@ -1,2 +1,2 @@ -dampingLayerSelector, 0, 1, , Mandatory, Rayleigh Damping Layer selector -dampingLayerDepth, 0.0, FLT_MAX, , Mandatory, Rayleigh Damping Layer Depth +dampingLayerSelector, 0, 1, 0, Mandatory, Rayleigh Damping Layer selector +dampingLayerDepth, 0.0, FLT_MAX, 100.0, Mandatory, Rayleigh Damping Layer Depth diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index d2e118f..5d07ba5 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -1,17 +1,24 @@ -surflayerSelector, 0, 3, , Mandatory, Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr) -surflayer_z0, 1e-12, 1e+0, , Mandatory, Roughness length (momentum) when surflayerSelector > 0 -surflayer_z0t, 1e-6, 1e+1, , Mandatory, Roughness length (temperature) when surflayerSelector > 0 -surflayer_z0tdyn, 0, 2, , Optional, Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff -surflayer_wth, -5e+0, 5e+0, , Mandatory, Kinematic sensible heat flux at the surface when surflayerSelector = 1 -surflayer_tr, -1e+1, 1e+1, , Mandatory, Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling) -surflayer_wq, -5e+0, 5e+0, , Mandatory, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 -surflayer_qr, -1e+1, 1e+1, , Mandatory, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 -surflayer_idealsine, 0, 1, , Mandatory, Selector for idealized sinusoidal surface heat flux or skin temperature forcing -surflayer_ideal_ts, 0, 1e+5, , Mandatory, Start time in seconds for the idealized sinusoidal surface forcing -surflayer_ideal_te, 0, 1e+5, , Mandatory, End time in seconds for the idealized sinusoidal surface forcing -surflayer_ideal_amp, 0, 1e+3, , Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing -surflayer_ideal_qts, 0, 1e+5, , Mandatory, Start time in seconds for the idealized sinusoidal surface forcing (qv) -surflayer_ideal_qte, 0, 1e+5, , Mandatory, End time in seconds for the idealized sinusoidal surface forcing (qv) -surflayer_ideal_qamp, 0, 1e+3, , Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing (qv) -surflayer_qskin_input, 0, 1, , Optional, Selector for file input (restart) value for qskin under surflayerSelector == 2 -surflayer_offshore, 0, 1, , Mandatory, Offshore selector: 0=off;1=on \ No newline at end of file +surflayerSelector, 0, 3, 0, Mandatory, Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr) +surflayer_z0, 1e-12, 1e+0, 0.1, Mandatory, Roughness length (momentum) when surflayerSelector > 0 +surflayer_z0t, 1e-6, 1e+1, 0.1, Mandatory, Roughness length (temperature) when surflayerSelector > 0 +surflayer_z0tdyn, 0, 2, 1, Optional, Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff +surflayer_wth, -5e+0, 5e+0, 0.0, Mandatory, Kinematic sensible heat flux at the surface when surflayerSelector = 1 +surflayer_tr, -1e+1, 1e+1, 0.0, Mandatory, Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling) +surflayer_wq, -5e+0, 5e+0, 0.0, Mandatory, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 +surflayer_qr, -1e+1, 1e+1, 0.0, Mandatory, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 +surflayer_idealsine, 0, 1, 0, Mandatory, Selector for idealized sinusoidal surface heat flux or skin temperature forcing +surflayer_ideal_ts, 0, 1e+5, 0.0, Cond-Mand, Start time in seconds for the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) +surflayer_ideal_te, 0, 1e+5, 0.0, Cond-Mand, End time in seconds for the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) +surflayer_ideal_amp, 0, 1e+3, 0.1, Cond-Mand, Maximum amplitude of the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) +surflayer_ideal_qts, 0, 1e+5, 0.0, Mandatory, Start time in seconds for the idealized sinusoidal surface forcing (qv) +surflayer_ideal_qte, 0, 1e+5, 0.0, Mandatory, End time in seconds for the idealized sinusoidal surface forcing (qv) +surflayer_ideal_qamp, 0, 1e+3, 0.1, Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing (qv) +surflayer_qskin_input, 0, 1, 0, Optional, Selector for file input (restart) value for qskin under surflayerSelector == 2 +surflayer_offshore, 0, 1, 0, Mandatory, Offshore selector: 0=off;1=on +surflayer_offshore_visc, 0, 1, 1, Optional, Viscous term on z0m: 0=off; 1=on +surflayer_offshore_opt, 0, 5, 0, Cond-Mand, Offshore roughness parameterization: ==0 (Charnock); ==1 (Charnock with variable alpha); ==2 (Taylor & Yelland); ==3 (Donelan); ==4 (Drennan); ==5 (Porchetta) (Cond-Mand if surflayer_offshore > 0) +surflayer_offshore_dyn, 0, 1, 1, Cond-Opt, Selector to use parameterized ocean parameters: 0=off; 1=on (Cond-Opt if surflayer_offshore > 0) +surflayer_offshore_hs, 0, 1e+2, 0.0, Cond-Mand, Significant wave height (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2; 3; 4; or 5) +surflayer_offshore_lp, 0.1, 1e+3, 0.1, Cond-Mand, Peak wavelength (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2) +surflayer_offshore_cp, 0.1, 1e+2, 0.1, Cond-Mand, Wave phase speed (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 3; 4; or 5 +surflayer_offshore_theta, 0.0, 180.0, 0.0, Cond-Mand, Wave/wind angle (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 5 or surflayer_offshore > 0 and surflayer_offshore_dyn==1 and surflayer_offshore_opt == 5) \ No newline at end of file diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv index 886495b..cf7bc3b 100644 --- a/docs/csv/hydro_core_turbulence.csv +++ b/docs/csv/hydro_core_turbulence.csv @@ -1,6 +1,6 @@ -turbulenceSelector, 0, 1, , Mandatory, Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky -TKESelector, 0, 2, , Mandatory, Prognostic TKE selector: 0=None; 1=Prognostic -TKEAdvSelector, 0, 6, , Mandatory, SGSTKE advection selector -TKEAdvSelector_b_hyb, 0.0, 1.0, , Mandatory, Hybrid advection scheme parameter -c_s, 1e-6, 1e6, , Mandatory, Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0 -c_k, 1e-6, 1e6, , Mandatory, Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0 \ No newline at end of file +turbulenceSelector, 0, 1, 0, Mandatory, Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky +TKESelector, 0, 2, 0, Mandatory, Prognostic TKE selector: 0=None; 1=Prognostic +TKEAdvSelector, 0, 6, 0, Mandatory, SGSTKE advection selector +TKEAdvSelector_b_hyb, 0.0, 1.0, 0.0, Mandatory, Hybrid advection scheme parameter +c_s, 1e-6, 1e6, 0.18, Mandatory, Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0 +c_k, 1e-6, 1e6, 0.10, Mandatory, Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0 \ No newline at end of file diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index 12d9c41..7d625a3 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,4 @@ -timeMethod, 0, 0, , Mandatory, Selector for time integration method. [0=RK3-WS2002 (default)] -Nt, 1, INT_MAX, , Mandatory, Number of timesteps to perform -dt, FLT_MIN, FLT_MAX, , Mandatory, Timestep resolution in seconds -NtBatch, 1, Nt, , Mandatory, Number of timesteps to compute in batch launch; must have NtBatch <= Nt \ No newline at end of file +timeMethod, 0, 0, 0, Mandatory, Selector for time integration method. [0=RK3-WS2002 (default)] +Nt, 1, INT_MAX, 1000, Mandatory, Number of timesteps to perform +dt, FLT_MIN, FLT_MAX, 1.0, Mandatory, Timestep resolution in seconds +NtBatch, 1, Nt, 1, Mandatory, Number of timesteps to compute in batch launch; must have NtBatch <= Nt \ No newline at end of file From 55833d82665d678c1c5b697503ab992600e9e5b6 Mon Sep 17 00:00:00 2001 From: jprestop Date: Wed, 17 Sep 2025 16:05:12 -0600 Subject: [PATCH 15/65] Per #91, update top level description of parameters. --- docs/parameters.rst | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index cba3630..937b8e8 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -3,12 +3,24 @@ Parameters ********** This page defines the configurable parameters available in FastEddy\ :sup:`®`. -Parameters are organized into . +Parameters are organized into logical sets by model feature or model configuration component. -Each table provides the parameter name, -valid range where applicable, requirement status (required or optional), and a -brief description. These definitions serve as a reference to ensure correct -configuration and valid inputs for FastEddy simulations. +Each table provides the: + + * Parameter name + * Minimum value (if applicable) + * Maximum value (if applicable) + * Default value (if applicable) + * Requirement + + * Mandatory + * Optional + * Cond-Mand (Conditionally Mandatory, with the condition listed in the description) + * Cond-Opt (Conditionally Optional, with the condition listed in the description) + + * Description + +These definitions serve as a reference to ensure correct configuration and valid inputs for FastEddy simulations. FEMPI From 6b1d9798871ac289771e91c2eb1539bb0d79a4ef Mon Sep 17 00:00:00 2001 From: jprestop Date: Wed, 17 Sep 2025 16:11:12 -0600 Subject: [PATCH 16/65] Per #91, swapping commas for semicolons --- docs/csv/hydro_core_explicit_filters.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index 98920a4..63ee1f6 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,6 +1,6 @@ filterSelector, 0, 1, 0, Mandatory, Explicit filter selector: 0=off; 1=on filter_6thdiff_vert, 0, 1, 0, Cond-Opt, Vertical 6th-order filter on w selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) -filter_6thdiff_hori, 0, 1, 0, Cond-Opt, Horizontal 6th-order filter on rho,theta,qv selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) +filter_6thdiff_hori, 0, 1, 0, Cond-Opt, Horizontal 6th-order filter on rho; theta; qv selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) filter_6thdiff_vert_coeff, 0.0, 1.0, 0.03, Cond-Mand, Vertical 6th-order filter factor: 0.0=off; 1.0=full (Cond-Mand if filterSelector == 1 and filter_6thdiff_vert == 1) filter_6thdiff_hori_coeff, 0.0, 1.0, 0.03, Cond-Mand, Horizontal 6th-order filter factor: 0.0=off; 1.0=full (Cond-Mand if filterSelector == 1 and filter_6thdiff_hori == 1) filter_divdamp, 0, 1, 0, Cond-Opt, Divergence damping selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) \ No newline at end of file From 72146f5947e8377fd5bcb7645e34017a8e103361 Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 08:20:53 -0600 Subject: [PATCH 17/65] Per #91, updating some conditional values --- docs/csv/hydro_core_surface_layer.csv | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index 5d07ba5..3dbb3b5 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -4,16 +4,16 @@ surflayer_z0t, 1e-6, 1e+1, 0.1, Mandatory, Roughness length (temperature) when s surflayer_z0tdyn, 0, 2, 1, Optional, Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff surflayer_wth, -5e+0, 5e+0, 0.0, Mandatory, Kinematic sensible heat flux at the surface when surflayerSelector = 1 surflayer_tr, -1e+1, 1e+1, 0.0, Mandatory, Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling) -surflayer_wq, -5e+0, 5e+0, 0.0, Mandatory, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 -surflayer_qr, -1e+1, 1e+1, 0.0, Mandatory, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 +surflayer_wq, -5e+0, 5e+0, 0.0, Cond-Mand, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 (Cond-Mand if moistureSelector==1) +surflayer_qr, -1e+1, 1e+1, 0.0, Cond-Mand, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 (Cond-Mand if moistureSelector==1) surflayer_idealsine, 0, 1, 0, Mandatory, Selector for idealized sinusoidal surface heat flux or skin temperature forcing surflayer_ideal_ts, 0, 1e+5, 0.0, Cond-Mand, Start time in seconds for the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) surflayer_ideal_te, 0, 1e+5, 0.0, Cond-Mand, End time in seconds for the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) surflayer_ideal_amp, 0, 1e+3, 0.1, Cond-Mand, Maximum amplitude of the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) -surflayer_ideal_qts, 0, 1e+5, 0.0, Mandatory, Start time in seconds for the idealized sinusoidal surface forcing (qv) -surflayer_ideal_qte, 0, 1e+5, 0.0, Mandatory, End time in seconds for the idealized sinusoidal surface forcing (qv) -surflayer_ideal_qamp, 0, 1e+3, 0.1, Mandatory, Maximum amplitude of the idealized sinusoidal surface forcing (qv) -surflayer_qskin_input, 0, 1, 0, Optional, Selector for file input (restart) value for qskin under surflayerSelector == 2 +surflayer_ideal_qts, 0, 1e+5, 0.0, Cond-Mand, Start time in seconds for the idealized sinusoidal surface forcing (qv) (Cond-Mand if moistureSelector==1 and surflayer_idealsine > 0) +surflayer_ideal_qte, 0, 1e+5, 0.0, Cond-Mand, End time in seconds for the idealized sinusoidal surface forcing (qv) (Cond-Mand if moistureSelector==1 and surflayer_idealsine > 0) +surflayer_ideal_qamp, 0, 1e+3, 0.1, Cond-Mand, Maximum amplitude of the idealized sinusoidal surface forcing (qv) (Cond-Mand if moistureSelector==1 and surflayer_idealsine > 0) +surflayer_qskin_input, 0, 1, 0, Cond-Opt, Selector for file input (restart) value for qskin under surflayerSelector == 2 (Cond-Opt if moistureSelector==1) surflayer_offshore, 0, 1, 0, Mandatory, Offshore selector: 0=off;1=on surflayer_offshore_visc, 0, 1, 1, Optional, Viscous term on z0m: 0=off; 1=on surflayer_offshore_opt, 0, 5, 0, Cond-Mand, Offshore roughness parameterization: ==0 (Charnock); ==1 (Charnock with variable alpha); ==2 (Taylor & Yelland); ==3 (Donelan); ==4 (Drennan); ==5 (Porchetta) (Cond-Mand if surflayer_offshore > 0) From 12ec48c40e6cc4ddf5702ec86304a16e47ee3dbf Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 08:29:27 -0600 Subject: [PATCH 18/65] Per #91, trying new settings so that only the Description column will wrap --- docs/_static/custom.css | 54 +++++++++++++++++++++++++---------------- 1 file changed, 33 insertions(+), 21 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index cb17870..e538c6e 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,29 +1,41 @@ -/* Force CSV table width control */ -.wy-table-responsive table td, -.wy-table-responsive table th { - white-space: normal !important; - word-wrap: break-word !important; +/* Force longtable width control */ +.longtable table { + table-layout: auto !important; /* let columns respect widths + content */ + width: 100% !important; } -.wy-table-responsive { - overflow: visible !important; +/* Prevent wrapping in all columns by default */ +.longtable td, +.longtable th { + white-space: nowrap !important; /* keep text on one line */ + overflow: hidden; /* hide overflow if needed */ + text-overflow: ellipsis; /* optional "…" */ } -.wy-table-responsive table { - table-layout: fixed !important; - width: 100% !important; +/* Allow wrapping ONLY in the Description column */ +.longtable td:nth-child(6), +.longtable th:nth-child(6) { + white-space: normal !important; /* wrapping allowed */ + word-wrap: break-word !important; + overflow: visible !important; + text-overflow: unset !important; } -/* Specific fixes for parameter tables */ -.longtable table { - table-layout: fixed !important; - width: 100% !important; -} +/* Fixed widths for each column */ +.longtable td:nth-child(1), +.longtable th:nth-child(1) { width: 20% !important; } /* Name */ + +.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: 8% !important; } /* Max */ + +.longtable td:nth-child(4), +.longtable th:nth-child(4) { width: 8% !important; } /* Default */ -.longtable td:nth-child(1) { width: 20% !important; } /* Name */ -.longtable td:nth-child(2) { width: 8% !important; } /* Min */ -.longtable td:nth-child(3) { width: 8% !important; } /* Max */ -.longtable td:nth-child(4) { width: 8% !important; } /* Default */ -.longtable td:nth-child(5) { width: 20% !important; } /* Mandatory/Optional */ -.longtable td:nth-child(6) { width: 36% !important; } /* Description */ +.longtable td:nth-child(5), +.longtable th:nth-child(5) { width: 20% !important; } /* Mandatory/Optional */ +.longtable td:nth-child(6), +.longtable th:nth-child(6) { width: 36% !important; } /* Description */ From 210b1cb5a363ae1ec4ad1fe72042c3ca4d5424ee Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 08:46:26 -0600 Subject: [PATCH 19/65] Per #91, attempt to fix problem with table running off boundary --- docs/_static/custom.css | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index e538c6e..904bb65 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,6 +1,16 @@ -/* Force longtable width control */ +/* Force longtable width control - MUST use fixed layout for width control */ .longtable table { - table-layout: auto !important; /* let columns respect widths + content */ + 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; } @@ -8,11 +18,11 @@ .longtable td, .longtable th { white-space: nowrap !important; /* keep text on one line */ - overflow: hidden; /* hide overflow if needed */ - text-overflow: ellipsis; /* optional "…" */ + overflow: hidden !important; /* hide overflow if needed */ + text-overflow: ellipsis !important; /* show "…" for cut-off text */ } -/* Allow wrapping ONLY in the Description column */ +/* Allow wrapping ONLY in the Description column (6th column) */ .longtable td:nth-child(6), .longtable th:nth-child(6) { white-space: normal !important; /* wrapping allowed */ From f2078df5234a9db80b6466cafc55fb293db8bc9d Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 09:00:08 -0600 Subject: [PATCH 20/65] Per #91, modifying css for column widths --- docs/_static/custom.css | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 904bb65..f15538c 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -33,19 +33,19 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width: 20% !important; } /* Name */ +.longtable th:nth-child(1) { width:28% !important; } /* Name */ .longtable td:nth-child(2), -.longtable th:nth-child(2) { width: 8% !important; } /* Min */ +.longtable th:nth-child(2) { width: 14% !important; } /* Min */ .longtable td:nth-child(3), -.longtable th:nth-child(3) { width: 8% !important; } /* Max */ +.longtable th:nth-child(3) { width: 12% !important; } /* Max */ .longtable td:nth-child(4), .longtable th:nth-child(4) { width: 8% !important; } /* Default */ .longtable td:nth-child(5), -.longtable th:nth-child(5) { width: 20% !important; } /* Mandatory/Optional */ +.longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 36% !important; } /* Description */ +.longtable th:nth-child(6) { width: 20% !important; } /* Description */ From 9ed7ca22265d3b47a380bce5c0cffe75d47b73fd Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 10:39:03 -0600 Subject: [PATCH 21/65] Per #91, modifying css for column widths --- docs/_static/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index f15538c..cdbfb49 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -33,7 +33,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width:28% !important; } /* Name */ +.longtable th:nth-child(1) { width:29% !important; } /* Name */ .longtable td:nth-child(2), .longtable th:nth-child(2) { width: 14% !important; } /* Min */ @@ -48,4 +48,4 @@ .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 20% !important; } /* Description */ +.longtable th:nth-child(6) { width: 19% !important; } /* Description */ From af857a40ca04e6142077f2f27f72b8965bb1edf6 Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 10:46:48 -0600 Subject: [PATCH 22/65] Per #91, modifying css for column widths --- docs/_static/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index cdbfb49..4f2f63b 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -33,7 +33,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width:29% !important; } /* Name */ +.longtable th:nth-child(1) { width:30% !important; } /* Name */ .longtable td:nth-child(2), .longtable th:nth-child(2) { width: 14% !important; } /* Min */ @@ -48,4 +48,4 @@ .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 19% !important; } /* Description */ +.longtable th:nth-child(6) { width: 18% !important; } /* Description */ From 3e8099b7c43140bf25f9fa6f082d4cff01a0d77a Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 10:48:09 -0600 Subject: [PATCH 23/65] Per #91, modifying css for column widths --- docs/_static/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 4f2f63b..e2d6a4b 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -33,7 +33,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width:30% !important; } /* Name */ +.longtable th:nth-child(1) { width:31% !important; } /* Name */ .longtable td:nth-child(2), .longtable th:nth-child(2) { width: 14% !important; } /* Min */ @@ -48,4 +48,4 @@ .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 18% !important; } /* Description */ +.longtable th:nth-child(6) { width: 17% !important; } /* Description */ From 1f83647a62770d7a2ce640562a2b82c97966881a Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 13:49:26 -0600 Subject: [PATCH 24/65] Per #91, reduce padding --- docs/_static/custom.css | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index e2d6a4b..a8c1390 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -17,6 +17,7 @@ /* 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 */ From 124389695bf6e930b5ec4732f4c89faa0944127d Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 14:00:36 -0600 Subject: [PATCH 25/65] Per #91, modifying widths after padding changes --- docs/_static/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index a8c1390..ba14a47 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -34,7 +34,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width:31% !important; } /* Name */ +.longtable th:nth-child(1) { width:30% !important; } /* Name */ .longtable td:nth-child(2), .longtable th:nth-child(2) { width: 14% !important; } /* Min */ @@ -49,4 +49,4 @@ .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 17% !important; } /* Description */ +.longtable th:nth-child(6) { width: 18% !important; } /* Description */ From f7ce641f00d36f3c7e867247fcdc7498bff3695e Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 14:04:22 -0600 Subject: [PATCH 26/65] Per #91, modifying widths after padding changes --- docs/_static/custom.css | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index ba14a47..e01ba78 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -37,16 +37,16 @@ .longtable th:nth-child(1) { width:30% !important; } /* Name */ .longtable td:nth-child(2), -.longtable th:nth-child(2) { width: 14% !important; } /* Min */ +.longtable th:nth-child(2) { width: 12% !important; } /* Min */ .longtable td:nth-child(3), -.longtable th:nth-child(3) { width: 12% !important; } /* Max */ +.longtable th:nth-child(3) { width: 10% !important; } /* Max */ .longtable td:nth-child(4), -.longtable th:nth-child(4) { width: 8% !important; } /* Default */ +.longtable th:nth-child(4) { width: 6% !important; } /* Default */ .longtable td:nth-child(5), .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 18% !important; } /* Description */ +.longtable th:nth-child(6) { width: 34% !important; } /* Description */ From 53dff3dc224e459fa87a0f5cff92d3fe5578d296 Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 14:07:33 -0600 Subject: [PATCH 27/65] Per #91, modifying widths after padding changes --- docs/_static/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index e01ba78..edc1e6c 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -34,7 +34,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width:30% !important; } /* Name */ +.longtable th:nth-child(1) { width: 32% !important; } /* Name */ .longtable td:nth-child(2), .longtable th:nth-child(2) { width: 12% !important; } /* Min */ @@ -49,4 +49,4 @@ .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 34% !important; } /* Description */ +.longtable th:nth-child(6) { width: 32% !important; } /* Description */ From 6c3e59fe8078c9cd394a7d0e9782ddacee0f420d Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 18 Sep 2025 14:08:36 -0600 Subject: [PATCH 28/65] Per #91, modifying widths after padding changes --- docs/_static/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index edc1e6c..6ac1e71 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -34,7 +34,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width: 32% !important; } /* Name */ +.longtable th:nth-child(1) { width: 33% !important; } /* Name */ .longtable td:nth-child(2), .longtable th:nth-child(2) { width: 12% !important; } /* Min */ @@ -49,4 +49,4 @@ .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ .longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 32% !important; } /* Description */ +.longtable th:nth-child(6) { width: 31% !important; } /* Description */ From 6eb38ee5395574b1cf4c30700bdb7815084dac6d Mon Sep 17 00:00:00 2001 From: jprestop Date: Fri, 19 Sep 2025 10:42:49 -0600 Subject: [PATCH 29/65] Per #91, trying new format with combining name and description --- docs/_static/custom.css | 8 +- docs/csv/grid.csv | 24 ++--- docs/csv/hydro_core_moisture.csv | 20 ++--- docs/parameters.rst | 146 ------------------------------- 4 files changed, 27 insertions(+), 171 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 6ac1e71..65225ba 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -24,8 +24,8 @@ } /* Allow wrapping ONLY in the Description column (6th column) */ -.longtable td:nth-child(6), -.longtable th:nth-child(6) { +.longtable td:nth-child(1), +.longtable th:nth-child(1) { white-space: normal !important; /* wrapping allowed */ word-wrap: break-word !important; overflow: visible !important; @@ -34,7 +34,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width: 33% !important; } /* Name */ +.longtable th:nth-child(1) { width: 52% !important; } /* Name and Description*/ .longtable td:nth-child(2), .longtable th:nth-child(2) { width: 12% !important; } /* Min */ @@ -48,5 +48,7 @@ .longtable td:nth-child(5), .longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ +/* .longtable td:nth-child(6), .longtable th:nth-child(6) { width: 31% !important; } /* Description */ +*/ diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 0421dba..8c01fca 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,12 +1,12 @@ -Nx, 1, INT_MAX, 122, Mandatory, Number of discretised domain elements in the x (zonal) direction -Ny, 1, INT_MAX, 122, Mandatory, Number of discretised domain elements in the y (meridional) direction -Nz, 1, INT_MAX, 122, Mandatory, Number of discretised domain elements in the z (vertical) direction -Nh, 0, INT_MAX, 3, Mandatory, Number of halo cells to be used (dependent on largest stencil extent) -d_xi, FLT_MIN, FLT_MAX, 10.0, Mandatory, Computational domain fixed resolution in the 'i' direction -d_eta, FLT_MIN, FLT_MAX, 10.0, Mandatory, Computational domain fixed resolution in the 'j' direction -d_zeta, FLT_MIN, FLT_MAX, 10.0, Mandatory, Computational domain fixed resolution in the 'k' direction -coordHorizHalos, 0, 1, 1, Mandatory, Switch to setup coordiante halos as periodic=1 or gradient-following=0 -topoFile, N/A, N/A, , Optional, A file containing topography (surface elevation in meters ASL) -verticalDeformSwitch, 0, 1, , Mandatory, Switch to use vertical coordinate deformation 0=off; 1=on -verticalDeformFactor, 0.0, 1.0, , Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) -verticalDeformQuadCoeff, -2.0, 2.0, 0.0, Mandatory, Deformation factor (0.0=max compression; 1.0=no compression) \ No newline at end of file +**Nx:** Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 122, Mandatory +**Ny:** Number of discretised domain elements in the y (meridional) direction, 1, INT_MAX, 122, Mandatory +**Nz:** Number of discretised domain elements in the z (vertical) direction, 1, INT_MAX, 122, Mandatory +**Nh:** Number of halo cells to be used (dependent on largest stencil extent), 0, INT_MAX, 3, Mandatory +**d_xi:** Computational domain fixed resolution in the 'i' direction, FLT_MIN, FLT_MAX, 10.0, Mandatory +**d_eta:** Computational domain fixed resolution in the 'j' direction, FLT_MIN, FLT_MAX, 10.0, Mandatory +**d_zeta:** Computational domain fixed resolution in the 'k' direction, FLT_MIN, FLT_MAX, 10.0, Mandatory +**coordHorizHalos:** Switch to setup coordiante halos as periodic=1 or gradient-following=0, 0, 1, 1, Mandatory +**topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , Optional +**verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , Mandatory +**verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , Mandatory +**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, Mandatory \ No newline at end of file diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv index 4edaf79..827df85 100644 --- a/docs/csv/hydro_core_moisture.csv +++ b/docs/csv/hydro_core_moisture.csv @@ -1,10 +1,10 @@ -moistureSelector, 0, 1, 0, Mandatory, Moisture selector: 0=off; 1=on -moistureNvars, 0, 2, 0, Cond-Mand, Number of moisture species (Cond-Mand if moistureSelector==1) -moistureAdvSelectorQv, 0, 6, 0, Cond-Mand, Water vapor advection scheme selector (Cond-Mand if moistureSelector==1) -moistureAdvSelectorQv_b, 0.0, 1.0, 0.0, Cond-Mand, Hybrid advection scheme parameter for water vapor (Cond-Mand if moistureSelector==1) -moistureAdvSelectorQi, 0, 2, 0, Cond-Mand, Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) (Cond-Mand if moistureSelector==1) -moistureSGSturb, 0, 1, 0, Cond-Mand, Selector to apply sub-grid scale diffusion to moisture fields (Cond-Mand if moistureSelector==1) -moistureCond, 1, 4, 1, Cond-Mand, Selector to apply condensation to mositure fields (Cond-Mand if moistureSelector==1) -moistureCondTscale, 1e-4, 1000.0, 1.0, Cond-Mand, Relaxation time in seconds (Cond-Mand if moistureSelector==1) -moistureCondBasePres, 0, 1, 0, Cond-Mand, Selector to use base pressure for microphysics (Cond-Mand if moistureSelector==1) -moistureMPcallTscale, 1e-4, 1000.0, 1.0, Cond-Mand, Time scale for microphysics to be called (Cond-Mand if moistureSelector==1) +**moistureSelector:** Moisture selector: 0=off; 1=on, 0, 1, 0, Mandatory +**moistureNvars:** Number of moisture species *Cond-Mand if moistureSelector==1*, 0, 2, 0, Cond-Mand +**moistureAdvSelectorQv:** Water vapor advection scheme selector *Cond-Mand if moistureSelector==1*, 0, 6, 0, Cond-Mand +**moistureAdvSelectorQv_b:** Hybrid advection scheme parameter for water vapor *Cond-Mand if moistureSelector==1*, 0.0, 1.0, 0.0, Cond-Mand +**moistureAdvSelectorQi:** Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) *Cond-Mand if moistureSelector==1*, 0, 2, 0, Cond-Mand +**moistureSGSturb:** Selector to apply sub-grid scale diffusion to moisture fields *Cond-Mand if moistureSelector==1*, 0, 1, 0, Cond-Mand +**moistureCond:** Selector to apply condensation to mositure fields *Cond-Mand if moistureSelector==1*, 1, 4, 1, Cond-Mand +**moistureCondTscale:** Relaxation time in seconds *Cond-Mand if moistureSelector==1*, 1e-4, 1000.0, 1.0, Cond-Mand +**moistureCondBasePres:** Selector to use base pressure for microphysics *Cond-Mand if moistureSelector==1*, 0, 1, 0, Cond-Mand +**moistureMPcallTscale:** Time scale for microphysics to be called *Cond-Mand if moistureSelector==1*, 1e-4, 1000.0, 1.0, Cond-Mand diff --git a/docs/parameters.rst b/docs/parameters.rst index 937b8e8..3b69e21 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -23,31 +23,6 @@ Each table provides the: These definitions serve as a reference to ensure correct configuration and valid inputs for FastEddy simulations. -FEMPI -===== - -.. csv-table:: - :file: csv/fempi.csv - :header-rows: 1 - :delim: , - :class: longtable - -FECUDA -====== - -.. csv-table:: - :file: csv/fecuda.csv - :delim: , - :class: longtable - -IO -=== - -.. csv-table:: - :file: csv/io.csv - :delim: , - :class: longtable - GRID ==== .. csv-table:: @@ -55,43 +30,9 @@ GRID :delim: , :class: longtable -TIME INTEGRATION -================ - -.. csv-table:: - :file: csv/time_integration.csv - :delim: , - :class: longtable - HYDRO CORE ========== -BOUNDARY CONDITIONS -------------------- - -.. csv-table:: - :file: csv/hydro_core_boundary_cond.csv - :delim: , - :class: longtable - - -HYDRO_IO/LOGGING ----------------- - -.. csv-table:: - :file: csv/hydro_core_io_logging.csv - :delim: , - :class: longtable - - -ADVECTION ---------- - -.. csv-table:: - :file: csv/hydro_core_advection.csv - :delim: , - :class: longtable - MOISTURE -------- @@ -100,90 +41,3 @@ MOISTURE :delim: , :class: longtable -CORIOLIS --------- - -.. csv-table:: - :file: csv/hydro_core_coriolis.csv - :delim: , - :class: longtable - -TURBULENCE ----------- - -.. csv-table:: - :file: csv/hydro_core_turbulence.csv - :delim: , - :class: longtable - -CANOPY ------- - -.. csv-table:: - :file: csv/hydro_core_canopy.csv - :delim: , - :class: longtable - -DIFFUSION ---------- - -.. csv-table:: - :file: csv/hydro_core_diffusion.csv - :delim: , - :class: longtable - -AUXILIARY SCALARS AND SOURCES ------------------------------ - -.. csv-table:: - :file: csv/hydro_core_auxiliary_scalars.csv - :delim: , - :class: longtable - -EXPLICIT FILTERS ----------------- - -.. csv-table:: - :file: csv/hydro_core_explicit_filters.csv - :delim: , - :class: longtable - -RAYLEIGH DAMPING LAYER ----------------------- - -.. csv-table:: - :file: csv/hydro_core_rayleigh_damping_layer.csv - :delim: , - :class: longtable - -SURFACE LAYER -------------- - -.. csv-table:: - :file: csv/hydro_core_surface_layer.csv - :delim: , - :class: longtable - -CELL PERTURBATION METHOD ------------------------- - -.. csv-table:: - :file: csv/hydro_core_cell_perturbation.csv - :delim: , - :class: longtable - -BASE-STATE ----------- - -.. csv-table:: - :file: csv/hydro_core_base_state.csv - :delim: , - :class: longtable - -LARGE SCALE FORCINGS --------------------- - -.. csv-table:: - :file: csv/hydro_core_large_scale_forcings.csv - :delim: , - :class: longtable From daa9c058821dd5ab41297df9d6320f8e405b0872 Mon Sep 17 00:00:00 2001 From: jprestop Date: Fri, 19 Sep 2025 12:25:08 -0600 Subject: [PATCH 30/65] Per #91, modifying column widths --- docs/_static/custom.css | 10 +++++----- docs/csv/grid.csv | 23 ++++++++++++----------- docs/csv/hydro_core_moisture.csv | 20 ++++++++++---------- docs/parameters.rst | 12 +++++------- 4 files changed, 32 insertions(+), 33 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 65225ba..2b4e75f 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -34,19 +34,19 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width: 52% !important; } /* Name and Description*/ +.longtable th:nth-child(1) { width: 73% !important; } /* Name and Description*/ .longtable td:nth-child(2), -.longtable th:nth-child(2) { width: 12% !important; } /* Min */ +.longtable th:nth-child(2) { width: 10% !important; } /* Min */ .longtable td:nth-child(3), -.longtable th:nth-child(3) { width: 10% !important; } /* Max */ +.longtable th:nth-child(3) { width: 8% !important; } /* Max */ .longtable td:nth-child(4), -.longtable th:nth-child(4) { width: 6% !important; } /* Default */ +.longtable th:nth-child(4) { width: 5% !important; } /* Default */ .longtable td:nth-child(5), -.longtable th:nth-child(5) { width: 18% !important; } /* Mandatory/Optional */ +.longtable th:nth-child(5) { width: 4% !important; } /* Mandatory/Optional */ /* .longtable td:nth-child(6), diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 8c01fca..04ca37f 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,12 +1,13 @@ -**Nx:** Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 122, Mandatory -**Ny:** Number of discretised domain elements in the y (meridional) direction, 1, INT_MAX, 122, Mandatory -**Nz:** Number of discretised domain elements in the z (vertical) direction, 1, INT_MAX, 122, Mandatory -**Nh:** Number of halo cells to be used (dependent on largest stencil extent), 0, INT_MAX, 3, Mandatory -**d_xi:** Computational domain fixed resolution in the 'i' direction, FLT_MIN, FLT_MAX, 10.0, Mandatory -**d_eta:** Computational domain fixed resolution in the 'j' direction, FLT_MIN, FLT_MAX, 10.0, Mandatory -**d_zeta:** Computational domain fixed resolution in the 'k' direction, FLT_MIN, FLT_MAX, 10.0, Mandatory -**coordHorizHalos:** Switch to setup coordiante halos as periodic=1 or gradient-following=0, 0, 1, 1, Mandatory +**Nx:** Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 122, M +**Ny:** Number of discretised domain elements in the y (meridional) direction, 1, INT_MAX, 122, M +**Nz:** Number of discretised domain elements in the z (vertical) direction, 1, INT_MAX, 122, M +**Nh:** Number of halo cells to be used (dependent on largest stencil extent), 0, INT_MAX, 3, M +**d_xi:** Computational domain fixed resolution in the 'i' direction, FLT_MIN, FLT_MAX, 10.0, M +**d_eta:** Computational domain fixed resolution in the 'j' direction, FLT_MIN, FLT_MAX, 10.0, M +**d_zeta:** Computational domain fixed resolution in the 'k' direction, FLT_MIN, FLT_MAX, 10.0, M +**coordHorizHalos:** Switch to setup coordiante halos as periodic=1 or gradient-following=0, 0, 1, 1, M **topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , Optional -**verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , Mandatory -**verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , Mandatory -**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, Mandatory \ No newline at end of file +**verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , M +**verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , M +**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, M +**testValue:** Testing values for long min and defaults, -FLT_MAX, FLT_MAX, 10000.0, O \ No newline at end of file diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv index 827df85..9491f7a 100644 --- a/docs/csv/hydro_core_moisture.csv +++ b/docs/csv/hydro_core_moisture.csv @@ -1,10 +1,10 @@ -**moistureSelector:** Moisture selector: 0=off; 1=on, 0, 1, 0, Mandatory -**moistureNvars:** Number of moisture species *Cond-Mand if moistureSelector==1*, 0, 2, 0, Cond-Mand -**moistureAdvSelectorQv:** Water vapor advection scheme selector *Cond-Mand if moistureSelector==1*, 0, 6, 0, Cond-Mand -**moistureAdvSelectorQv_b:** Hybrid advection scheme parameter for water vapor *Cond-Mand if moistureSelector==1*, 0.0, 1.0, 0.0, Cond-Mand -**moistureAdvSelectorQi:** Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) *Cond-Mand if moistureSelector==1*, 0, 2, 0, Cond-Mand -**moistureSGSturb:** Selector to apply sub-grid scale diffusion to moisture fields *Cond-Mand if moistureSelector==1*, 0, 1, 0, Cond-Mand -**moistureCond:** Selector to apply condensation to mositure fields *Cond-Mand if moistureSelector==1*, 1, 4, 1, Cond-Mand -**moistureCondTscale:** Relaxation time in seconds *Cond-Mand if moistureSelector==1*, 1e-4, 1000.0, 1.0, Cond-Mand -**moistureCondBasePres:** Selector to use base pressure for microphysics *Cond-Mand if moistureSelector==1*, 0, 1, 0, Cond-Mand -**moistureMPcallTscale:** Time scale for microphysics to be called *Cond-Mand if moistureSelector==1*, 1e-4, 1000.0, 1.0, Cond-Mand +**moistureSelector:** Moisture selector: 0=off; 1=on, 0, 1, 0, M +**moistureNvars:** Number of moisture species *C-M if moistureSelector==1*, 0, 2, 0, C-M +**moistureAdvSelectorQv:** Water vapor advection scheme selector *C-M if moistureSelector==1*, 0, 6, 0, C-M +**moistureAdvSelectorQv_b:** Hybrid advection scheme parameter for water vapor *C-M if moistureSelector==1*, 0.0, 1.0, 0.0, C-M +**moistureAdvSelectorQi:** Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) *C-M if moistureSelector==1*, 0, 2, 0, C-M +**moistureSGSturb:** Selector to apply sub-grid scale diffusion to moisture fields *C-M if moistureSelector==1*, 0, 1, 0, C-M +**moistureCond:** Selector to apply condensation to mositure fields *C-M if moistureSelector==1*, 1, 4, 1, C-M +**moistureCondTscale:** Relaxation time in seconds *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M +**moistureCondBasePres:** Selector to use base pressure for microphysics *C-M if moistureSelector==1*, 0, 1, 0, C-M +**moistureMPcallTscale:** Time scale for microphysics to be called *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M diff --git a/docs/parameters.rst b/docs/parameters.rst index 3b69e21..bd8152c 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -7,18 +7,16 @@ Parameters are organized into logical sets by model feature or model configurati Each table provides the: - * Parameter name + * **Parameter name:** Description * Minimum value (if applicable) * Maximum value (if applicable) * Default value (if applicable) * Requirement - * Mandatory - * Optional - * Cond-Mand (Conditionally Mandatory, with the condition listed in the description) - * Cond-Opt (Conditionally Optional, with the condition listed in the description) - - * Description + * 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. From c2c21345d0dcfb3f07a1c78d7e50577dd09a3ba2 Mon Sep 17 00:00:00 2001 From: jprestop Date: Fri, 19 Sep 2025 12:27:13 -0600 Subject: [PATCH 31/65] Per #91, change Optional to O --- docs/csv/grid.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 04ca37f..688d39c 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -6,7 +6,7 @@ **d_eta:** Computational domain fixed resolution in the 'j' direction, FLT_MIN, FLT_MAX, 10.0, M **d_zeta:** Computational domain fixed resolution in the 'k' direction, FLT_MIN, FLT_MAX, 10.0, M **coordHorizHalos:** Switch to setup coordiante halos as periodic=1 or gradient-following=0, 0, 1, 1, M -**topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , Optional +**topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , O **verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , M **verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , M **verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, M From 13a50a325e84734fa03073af87b05cb2008ed013 Mon Sep 17 00:00:00 2001 From: jprestop Date: Fri, 19 Sep 2025 12:29:58 -0600 Subject: [PATCH 32/65] Per #91, modifying width values --- docs/_static/custom.css | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 2b4e75f..cfb2dd6 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -34,19 +34,19 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width: 73% !important; } /* Name and Description*/ +.longtable th:nth-child(1) { width: 80% !important; } /* Name and Description*/ .longtable td:nth-child(2), -.longtable th:nth-child(2) { width: 10% !important; } /* Min */ +.longtable th:nth-child(2) { width: 8% !important; } /* Min */ .longtable td:nth-child(3), -.longtable th:nth-child(3) { width: 8% !important; } /* Max */ +.longtable th:nth-child(3) { width: 6% !important; } /* Max */ .longtable td:nth-child(4), -.longtable th:nth-child(4) { width: 5% !important; } /* Default */ +.longtable th:nth-child(4) { width: 4% !important; } /* Default */ .longtable td:nth-child(5), -.longtable th:nth-child(5) { width: 4% !important; } /* Mandatory/Optional */ +.longtable th:nth-child(5) { width: 2% !important; } /* Mandatory/Optional */ /* .longtable td:nth-child(6), From f423f87e2bd75eecb2a4107abe33747d5d66fd74 Mon Sep 17 00:00:00 2001 From: jprestop Date: Fri, 19 Sep 2025 12:46:25 -0600 Subject: [PATCH 33/65] Per #91, continue to experiment with widths --- docs/_static/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index cfb2dd6..0a4b08e 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -34,7 +34,7 @@ /* Fixed widths for each column */ .longtable td:nth-child(1), -.longtable th:nth-child(1) { width: 80% !important; } /* Name and Description*/ +.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 */ @@ -46,7 +46,7 @@ .longtable th:nth-child(4) { width: 4% !important; } /* Default */ .longtable td:nth-child(5), -.longtable th:nth-child(5) { width: 2% !important; } /* Mandatory/Optional */ +.longtable th:nth-child(5) { width: 4% !important; } /* Mandatory/Optional */ /* .longtable td:nth-child(6), From 1a6a42ecb0169d0fb5dc98fa31eb8580c80dcbe8 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 22 Sep 2025 18:14:42 -0600 Subject: [PATCH 34/65] Per #91, updating files with new format --- docs/csv/fecuda.csv | 6 +- docs/csv/fempi.csv | 4 +- docs/csv/hydro_core_advection.csv | 4 +- docs/csv/hydro_core_auxiliary_scalars.csv | 28 ++-- docs/csv/hydro_core_base_state.csv | 38 ++--- docs/csv/hydro_core_boundary_cond.csv | 12 +- docs/csv/hydro_core_canopy.csv | 8 +- docs/csv/hydro_core_cell_perturbation.csv | 22 +-- docs/csv/hydro_core_coriolis.csv | 4 +- docs/csv/hydro_core_diffusion.csv | 4 +- docs/csv/hydro_core_explicit_filters.csv | 12 +- docs/csv/hydro_core_io_logging.csv | 6 +- docs/csv/hydro_core_large_scale_forcings.csv | 36 ++--- .../csv/hydro_core_rayleigh_damping_layer.csv | 4 +- docs/csv/hydro_core_surface_layer.csv | 48 +++--- docs/csv/hydro_core_turbulence.csv | 12 +- docs/csv/io.csv | 12 +- docs/csv/time_integration.csv | 8 +- docs/parameters.rst | 147 ++++++++++++++++++ 19 files changed, 281 insertions(+), 134 deletions(-) diff --git a/docs/csv/fecuda.csv b/docs/csv/fecuda.csv index 6e6d3e3..259ce80 100644 --- a/docs/csv/fecuda.csv +++ b/docs/csv/fecuda.csv @@ -1,3 +1,3 @@ -tBx, 1, INT_MAX, , Mandatory, Number of threads in x-dimension -tBy, 1, INT_MAX, , Mandatory, Number of threads in y-dimension -tBz, 1, INT_MAX, , Mandatory, Number of threads in z-dimension \ No newline at end of file +**tBx:** Number of threads in x-dimension, 1, INT_MAX, , M +**tBy:** Number of threads in y-dimension, 1, INT_MAX, , M +**tBz:** Number of threads in z-dimension, 1, INT_MAX, , M \ No newline at end of file diff --git a/docs/csv/fempi.csv b/docs/csv/fempi.csv index 5c47998..d08fb12 100644 --- a/docs/csv/fempi.csv +++ b/docs/csv/fempi.csv @@ -1,3 +1,3 @@ Name, Min, Max, Default, Requirement, Description -numProcsX, 1, INT_MAX, , Mandatory, Number of cores to be used for horizontal domain decomposition in X -numProcsY, 1, INT_MAX, , Mandatory, Number of cores to be used for horizontal domain decomposition in Y \ No newline at end of file +**numProcsX:** Number of cores to be used for horizontal domain decomposition in X, 1, INT_MAX, , M +**numProcsY:** Number of cores to be used for horizontal domain decomposition in Y, 1, INT_MAX, , M \ No newline at end of file diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv index dbaf6f3..547fd20 100644 --- a/docs/csv/hydro_core_advection.csv +++ b/docs/csv/hydro_core_advection.csv @@ -1,2 +1,2 @@ -advectionSelector, 0, 6, 0, Mandatory, Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order -b_hyb, 0.0, 1.0, 0.8, Mandatory, Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid \ No newline at end of file +**advectionSelector:** Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order, 0, 6, 0, M +**b_hyb:** Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid, 0.0, 1.0, 0.8, M \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 9c0c944..6a93072 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -1,14 +1,14 @@ -NhydroAuxScalars, 0, MAX_AUXSC_SRC (20), 0, Optional, Number of prognostic auxiliary scalar fields -AuxScAdvSelector, 0, 6, 0, Cond-Mand, Advection scheme for auxiliary scalar fields (Cond-Mand if NhydroAuxScalars > 0) -AuxScAdvSelector_b_hyb, 0.0, 1.0, 0.0, Cond-Mand, Hybrid advection scheme parameter (Cond-Mand if NhydroAuxScalars > 0) -AuxScSGSturb, 0, 1, 0, Cond-Mand, Selector to apply sub-grid scale diffusion to auxiliary scalar fields (Cond-Mand if NhydroAuxScalars > 0) -srcAuxScFile, N/A, N/A, , Cond-Opt, The path and filename to an Auxilliary Scalar Sources specification file (Cond-Opt if NhydroAuxScalars > 0) -srcAuxScTemporalType, 0, 1, 0, Cond-Mand, Temporal characterization of source (0=instantaneous; 1=continuous) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScStartSeconds, 0, FLT_MAX, 0, Cond-Mand, Source start time in seconds (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScDurationSeconds, 0, FLT_MAX, 30, Cond-Mand, Source duration in seconds (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScGeometryType, 0, 0, 0, Cond-Mand, 0=point (single cell volume); 1=line (line of surface cells) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScMassSpecType, 0, 0, 0, Cond-Mand, Mass specification type 0=strict mass in kg; 1=mass source rate in kg/s (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScMassSpecValue, 0.0, FLT_MAX, 1.0, Cond-Mand, Mass specification value in kg or kg/s given by srcAuxScMassSpecType 0 or 1 (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScLocation_X, -FLT_MAX, FLT_MAX, 0.0, Cond-Mand, Source geometry centroid postion in x (west-east) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScLocation_Y, -FLT_MAX, FLT_MAX, 0.0, Cond-Mand, Source geometry centroid postion in y (south-north) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) -srcAuxScLocation_Z, -FLT_MAX, FLT_MAX, 0.0, Cond-Mand, Source geometry centroid postion in z (vertical above the surface) (Cond-Mand if srcAuxScFile == NULL and NhydroAuxScalars == 1) \ No newline at end of file +**NhydroAuxScalars:** Number of prognostic auxiliary scalar fields, 0, MAX_AUXSC_SRC (20), 0, O +**AuxScAdvSelector:** Advection scheme for auxiliary scalar fields *C-M if NhydroAuxScalars > 0*, 0, 6, 0, C-M +**AuxScAdvSelector_b_hyb:** Hybrid advection scheme parameter *C-M if NhydroAuxScalars > 0*, 0.0, 1.0, 0.0, C-M +**AuxScSGSturb:** Selector to apply sub-grid scale diffusion to auxiliary scalar fields *C-M if NhydroAuxScalars > 0*, 0, 1, 0, C-M +**srcAuxScFile:** The path and filename to an Auxilliary Scalar Sources specification file *C-O if NhydroAuxScalars > 0*, N/A, N/A, , C-O +**srcAuxScTemporalType:** Temporal characterization of source (0=instantaneous; 1=continuous) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 1, 0, C-M +**srcAuxScStartSeconds:** Source start time in seconds *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, FLT_MAX, 0, C-M +**srcAuxScDurationSeconds:** Source duration in seconds *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, FLT_MAX, 30, C-M +**srcAuxScGeometryType:** 0=point (single cell volume); 1=line (line of surface cells) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 0, 0, C-M +**srcAuxScMassSpecType:** Mass specification type 0=strict mass in kg; 1=mass source rate in kg/s *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 0, 0, C-M +**srcAuxScMassSpecValue:** Mass specification value in kg or kg/s given by srcAuxScMassSpecType 0 or 1 *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0.0, FLT_MAX, 1.0, C-M +**srcAuxScLocation_X:** Source geometry centroid postion in x (west-east) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M +**srcAuxScLocation_Y:** Source geometry centroid postion in y (south-north) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M +**srcAuxScLocation_Z:** Source geometry centroid postion in z (vertical above the surface) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv index 23f7f5b..63ff390 100644 --- a/docs/csv/hydro_core_base_state.csv +++ b/docs/csv/hydro_core_base_state.csv @@ -1,19 +1,19 @@ -stabilityScheme, 0, 4, 0, Mandatory, Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta) -temp_grnd, FLT_MIN, FLT_MAX, 300.0, Mandatory, Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields -pres_grnd, FLT_MIN, FLT_MAX, 1.0e5, Mandatory, Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields -zStableBottom, 0, FLT_MAX, 1000.0, Mandatory, Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2 -stableGradient, FLT_MIN, FLT_MAX, 0.1, Mandatory, Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2 -zStableBottom2, 0, FLT_MAX, 1100.0, Mandatory, Height (m) of the second stable upper-layer when stabilityScheme = 2 -stableGradient2, FLT_MIN, FLT_MAX, 0.03, Mandatory, Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2 -zStableBottom3, 0, FLT_MAX, 1500.0, Mandatory, Height (m) of the third stable upper-layer when stabilityScheme = 2 -stableGradient3, FLT_MIN, FLT_MAX, 0.03, Mandatory, Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2 -thetaPerturbationSwitch, 0, 1, 0, Mandatory, Switch to include initial theta perturbations: 0=off; 1=on -thetaHeight, 0.0, FLT_MAX, 0.0, Mandatory, Height below which to include initial theta perturbations: (meters) -thetaAmplitude, 0.0, 2.0, 0.0, Mandatory, Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K -U_g, -FLT_MAX, FLT_MAX, 0.0, Mandatory, Zonal (West-East) component of the geostrophic wind (m/s) -V_g, -FLT_MAX, FLT_MAX, 0.0, Mandatory, Meridional (South-North) component of the geostrophic wind (m/s) -z_Ug, 0.0, FLT_MAX, 10000.0, Mandatory, Height (m) above ground for linear geostrophic wind gradient (zonal component) -z_Vg, 0.0, FLT_MAX, 10000.0, Mandatory, Height (m) above ground for linear geostrophic wind gradient (meridional component) -Ug_grad, -1e2, 1e2, 0.0, Mandatory, Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m) -Vg_grad, -1e2, 1e2, 0.0, Mandatory, Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m) -physics_oneRKonly, 0, 1, 1, Optional, Selector to apply physics RHS forcing only at the latest RK stage: 0=off; 1=on \ No newline at end of file +**stabilityScheme:** Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta), 0, 4, 0, M +**temp_grnd:** Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields, FLT_MIN, FLT_MAX, 300.0, M +**pres_grnd:** Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields, FLT_MIN, FLT_MAX, 1.0e5, M +**zStableBottom:** Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2, 0, FLT_MAX, 1000.0, M +**stableGradient:** Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2, FLT_MIN, FLT_MAX, 0.1, M +**zStableBottom2:** Height (m) of the second stable upper-layer when stabilityScheme = 2, 0, FLT_MAX, 1100.0, M +**stableGradient2:** Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2, FLT_MIN, FLT_MAX, 0.03, M +**zStableBottom3:** Height (m) of the third stable upper-layer when stabilityScheme = 2, 0, FLT_MAX, 1500.0, M +**stableGradient3:** Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2, FLT_MIN, FLT_MAX, 0.03, M +**thetaPerturbationSwitch:** Switch to include initial theta perturbations: 0=off; 1=on, 0, 1, 0, M +**thetaHeight:** Height below which to include initial theta perturbations: (meters), 0.0, FLT_MAX, 0.0, M +**thetaAmplitude:** Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K, 0.0, 2.0, 0.0, M +**U_g:** Zonal (West-East) component of the geostrophic wind (m/s), -FLT_MAX, FLT_MAX, 0.0, M +**V_g:** Meridional (South-North) component of the geostrophic wind (m/s), -FLT_MAX, FLT_MAX, 0.0, M +**z_Ug:** Height (m) above ground for linear geostrophic wind gradient (zonal component), 0.0, FLT_MAX, 10000.0, M +**z_Vg:** Height (m) above ground for linear geostrophic wind gradient (meridional component), 0.0, FLT_MAX, 10000.0, M +**Ug_grad:** Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m), -1e2, 1e2, 0.0, M +**Vg_grad:** Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m), -1e2, 1e2, 0.0, M +**physics_oneRKonly:** Selector to apply physics RHS forcing only at the latest RK stage: 0=off; 1=on, 0, 1, 1, O \ No newline at end of file diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index 5580597..6b96c44 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,6 +1,6 @@ -hydroBCs, 1, 2, 2, Mandatory, Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl -ceilingAdvectionBC, 0, 1, 0, Optional, Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC) -hydroBndysFileBase, N/A, N/A, , Cond-Opt, Base file name LAD BC set (Cond-Opt if hydroBCs==1) -hydroBndysFileStart, 0, 500000, 0, Cond-Mand, Start counter value for LAD BC set files (Cond-Mand if hydroBCs==1) -hydroBndysFileEnd, 0, 500000, 0, Cond-Mand, End counter value for LAD BC set files (Cond-Mand if hydroBCs==1) -dtBdyPlaneBCs, 0.0, 6e5, 0.0, Cond-Mand, Delta in time (seconds) between BdyPlane sets (Cond-Mand if hydroBCs==1) +**hydroBCs:** Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl, 1, 2, 2, M +**ceilingAdvectionBC:** Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC), 0, 1, 0, O +**hydroBndysFileBase:** Base file name LAD BC set *Cond-Opt if hydroBCs==1*, N/A, N/A, , C-O +**hydroBndysFileStart:** Start counter value for LAD BC set files *Cond-Mand if hydroBCs==1*, 0, 500000, 0, C-M +**hydroBndysFileEnd:** End counter value for LAD BC set files *Cond-Mand if hydroBCs==1*, 0, 500000, 0, C-M +**dtBdyPlaneBCs:** Delta in time (seconds) between BdyPlane sets *Cond-Mand if hydroBCs==1*, 0.0, 6e5, 0.0, C-M diff --git a/docs/csv/hydro_core_canopy.csv b/docs/csv/hydro_core_canopy.csv index 51fc91e..08c219c 100644 --- a/docs/csv/hydro_core_canopy.csv +++ b/docs/csv/hydro_core_canopy.csv @@ -1,4 +1,4 @@ -canopySelector, 0, 1, 0, Optional, Canopy selector: 0=off; 1=on -canopySkinOpt, 0, 1, 0, Cond-Mand, Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on (Cond-Mandif canopySelector==1) -canopy_cd, 0.0, 1e+2, 0.15, Cond-Mand, Non-dimensional canopy drag coefficient (Cond-Mandif canopySelector==1) -canopy_lf, 0.0, 1e+2, 0.1, Cond-Mand, Representative canopy element length scale (Cond-Mandif canopySelector==1) +**canopySelector:** Canopy selector: 0=off; 1=on, 0, 1, 0, O +**canopySkinOpt:** Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on *C-M if canopySelector==1*, 0, 1, 0, C-M +**canopy_cd:** Non-dimensional canopy drag coefficient *C-M if canopySelector==1*, 0.0, 1e+2, 0.15, C-M +**canopy_lf:** Representative canopy element length scale *C-M if canopySelector==1*, 0.0, 1e+2, 0.1, C-M diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv index 5681b9c..6fdc91e 100644 --- a/docs/csv/hydro_core_cell_perturbation.csv +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -1,11 +1,11 @@ -cellpertSelector, 0, 1, 0, Optional, CP method selector: 0=off; 1=on -cellpert_nts, 0, 1e+6, 500, Optional, Number of time steps after which perturbations are seeded -cellpert_sw2b, 0, 3, 0, Cond-Mand, Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south (Cond-Mand if cellpertSelector > 0) -cellpert_amp, 0.0, 20.0, 0.5, Cond-Mand, Maximum amplitude for the potential temperature perturbations (Cond-Mand if cellpertSelector > 0) -cellpert_gppc, 0, 50, 8, Cond-Mand, Number of grid points conforming the cell (Cond-Mand if cellpertSelector > 0) -cellpert_ndbc, 0, 10, 3, Cond-Mand, Number of cells normal to domain lateral boundaries (Cond-Mand if cellpertSelector > 0) -cellpert_kbottom, 1, 10, 1, Cond-Mand, Z-grid point where the perturbations start (Cond-Mand if cellpertSelector > 0) -cellpert_ktop, 0, 200, 20, Cond-Mand, Z-grid point where the perturbations end (Cond-Mand if cellpertSelector > 0) -cellpert_tvcp, 0, 1, 0, Cond-Mand, Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) (Cond-Mand if cellpertSelector > 0) -cellpert_eckert, 0.0, 10.0, 0.2, Cond-Mand, Eckert number for the potential temperature perturbations (hydroBCs==1) (Cond-Mand if cellpertSelector > 0) -cellpert_tsfact, 0.0, 10.0, 1.0, Cond-Mand, Factor on the refreshing perturbation time scale (hydroBCs==1) (Cond-Mand if cellpertSelector > 0) +**cellpertSelector:** CP method selector: 0=off; 1=on, 0, 1, 0, O +**ccellpert_nts:** Number of time steps after which perturbations are seeded, 0, 1e+6, 500, O +**ccellpert_sw2b:** Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south *C-M if cellpertSelector > 0*, 0, 3, 0, C-M +**ccellpert_amp:** Maximum amplitude for the potential temperature perturbations *C-M if cellpertSelector > 0*, 0.0, 20.0, 0.5, C-M +**ccellpert_gppc:** Number of grid points conforming the cell *C-M if cellpertSelector > 0*, 0, 50, 8, C-M +**ccellpert_ndbc:** Number of cells normal to domain lateral boundaries *C-M if cellpertSelector > 0*, 0, 10, 3, C-M +**ccellpert_kbottom:** Z-grid point where the perturbations start *C-M if cellpertSelector > 0*, 1, 10, 1, C-M +**ccellpert_ktop:** Z-grid point where the perturbations end *C-M if cellpertSelector > 0*, 0, 200, 20, C-M +**ccellpert_tvcp:** Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) *C-M if cellpertSelector > 0*, 0, 1, 0, C-M +**ccellpert_eckert:** Eckert number for the potential temperature perturbations (hydroBCs==1) *C-M if cellpertSelector > 0*, 0.0, 10.0, 0.2, C-M +**ccellpert_tsfact:** Factor on the refreshing perturbation time scale (hydroBCs==1) *C-M if cellpertSelector > 0*, 0.0, 10.0, 1.0, C-M diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv index 5128883..17501e9 100644 --- a/docs/csv/hydro_core_coriolis.csv +++ b/docs/csv/hydro_core_coriolis.csv @@ -1,2 +1,2 @@ -coriolisSelector, 0, 2, 0, Mandatory, Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical -coriolisLatitude, -90.0, 90.0, 54.0, Mandatory, Charactersitc latitude in degrees from equator of the LES domain \ No newline at end of file +**coriolisSelector:** Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical, 0, 2, 0, M +**coriolisLatitude:** Charactersitc latitude in degrees from equator of the LES domain, -90.0, 90.0, 54.0, M \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv index 512fd43..51e6b18 100644 --- a/docs/csv/hydro_core_diffusion.csv +++ b/docs/csv/hydro_core_diffusion.csv @@ -1,2 +1,2 @@ -diffusionSelector, 0, 1, 0, Mandatory, Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity -nu_0, 0, FLT_MAX, 1.0, Mandatory, Constant diffusivity used when diffusionSelector=1 \ No newline at end of file +**diffusionSelector:** Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity, 0, 1, 0, M +**nu_0:** Constant diffusivity used when diffusionSelector=1, 0, FLT_MAX, 1.0, M \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index 63ee1f6..34270ed 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,6 +1,6 @@ -filterSelector, 0, 1, 0, Mandatory, Explicit filter selector: 0=off; 1=on -filter_6thdiff_vert, 0, 1, 0, Cond-Opt, Vertical 6th-order filter on w selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) -filter_6thdiff_hori, 0, 1, 0, Cond-Opt, Horizontal 6th-order filter on rho; theta; qv selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) -filter_6thdiff_vert_coeff, 0.0, 1.0, 0.03, Cond-Mand, Vertical 6th-order filter factor: 0.0=off; 1.0=full (Cond-Mand if filterSelector == 1 and filter_6thdiff_vert == 1) -filter_6thdiff_hori_coeff, 0.0, 1.0, 0.03, Cond-Mand, Horizontal 6th-order filter factor: 0.0=off; 1.0=full (Cond-Mand if filterSelector == 1 and filter_6thdiff_hori == 1) -filter_divdamp, 0, 1, 0, Cond-Opt, Divergence damping selector: 0=off; 1=on (Cond-Opt if filterSelector == 1) \ No newline at end of file +**filterSelector:** Explicit filter selector: 0=off; 1=on, 0, 1, 0, M +**ffilter_6thdiff_vert:** Vertical 6th-order filter on w selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O +**ffilter_6thdiff_hori:** Horizontal 6th-order filter on rho; theta; qv selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O +**ffilter_6thdiff_vert_coeff:** Vertical 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_vert == 1*, 0.0, 1.0, 0.03, C-M +**ffilter_6thdiff_hori_coeff:** Horizontal 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_hori == 1*, 0.0, 1.0, 0.03, C-M +**ffilter_divdamp:** Divergence damping selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O \ No newline at end of file diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index 5a4078c..1f5c034 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,4 +1,4 @@ -hydroForcingWrite, 0, 1, 0, Mandatory, Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on -hydroSubGridWrite, 0, 1, 0, Mandatory, Switch for dumping Tauij fields. 0=off; 1=on -hydroForcingLog, 0, 1, 0, Mandatory, Switch for logging Frhs min/max etc. 0=off; 1=on +**hydroForcingWrite:** Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on, 0, 1, 0, M +**hydroSubGridWrite:** Switch for dumping SGS fields. 0=off; 1=on, 0, 1, 0, M +**hydroForcingLog:** Switch for logging Frhs min/max etc. 0=off; 1=on, 0, 1, 0, M diff --git a/docs/csv/hydro_core_large_scale_forcings.csv b/docs/csv/hydro_core_large_scale_forcings.csv index 10b722a..275c1e8 100644 --- a/docs/csv/hydro_core_large_scale_forcings.csv +++ b/docs/csv/hydro_core_large_scale_forcings.csv @@ -1,18 +1,18 @@ -lsfSelector, 0, 1, 0, Mandatory, Large-scale forcings selector: 0=off; 1=on -lsf_horMnSubTerms, 0, 1, 0, Cond-Mand, Large-scale subsidence terms Switch 0=off 1=on (Cond-Mand if lsfSelector > 0) -lsf_freq, 1e-3, 1e+3, 1.0, Cond-Mand, Large-scale forcing frequency (seconds) (Cond-Mand if lsfSelector > 0) -lsf_w_surf, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to w at the surface (Cond-Mand if lsfSelector > 0) -lsf_w_lev1, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to w at the first specified level (Cond-Mand if lsfSelector > 0) -lsf_w_lev2, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to w at the second specified level (Cond-Mand if lsfSelector > 0) -lsf_w_zlev1, 0.0, 1e+4, 100.0, Cond-Mand, Large-scale forcing to w height 1 (Cond-Mand if lsfSelector > 0) -lsf_w_zlev2, 0.0, 1e+4, 200.0, Cond-Mand, Large-scale forcing to w height 2 (Cond-Mand if lsfSelector > 0) -lsf_th_surf, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to theta at the surface (Cond-Mand if lsfSelector > 0) -lsf_th_lev1, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to theta at the first specified level (Cond-Mand if lsfSelector > 0) -lsf_th_lev2, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to theta at the second specified level (Cond-Mand if lsfSelector > 0) -lsf_th_zlev1, 0.0, 1e+4, 100.0, Cond-Mand, Large-scale forcing to theta height 1 (Cond-Mand if lsfSelector > 0) -lsf_th_zlev2, 0.0, 1e+4, 200.0, Cond-Mand, Large-scale forcing to theta height 2 (Cond-Mand if lsfSelector > 0) -lsf_qv_surf, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to qv at the first specified level (Cond-Mand if lsfSelector > 0) -lsf_qv_lev1, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to qv at the first specified level (Cond-Mand if lsfSelector > 0) -lsf_qv_lev2, -1e+4, 1e+4, 0.0, Cond-Mand, Large-scale forcing to qv at the second specified level (Cond-Mand if lsfSelector > 0) -lsf_qv_zlev1, 0.0, 1e+4, 100.0, Cond-Mand, Large-scale forcing to qv height 1 (Cond-Mand if lsfSelector > 0) -lsf_qv_zlev2, 0.0, 1e+4, 200.0, Cond-Mand, Large-scale forcing to qv height 2 (Cond-Mand if lsfSelector > 0) \ No newline at end of file +**lsfSelector:** Large-scale forcings selector: 0=off; 1=on, 0, 1, 0, M +**lsf_horMnSubTerms:** Large-scale subsidence terms Switch 0=off 1=on *C-M if lsfSelector > 0*, 0, 1, 0, C-M +**lsf_freq:** Large-scale forcing frequency (seconds) *C-M if lsfSelector > 0*, 1e-3, 1e+3, 1.0, C-M +**lsf_w_surf:** Large-scale forcing to w at the surface *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_w_lev1:** Large-scale forcing to w at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_w_lev2:** Large-scale forcing to w at the second specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_w_zlev1:** Large-scale forcing to w height 1 *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M +**lsf_w_zlev2:** Large-scale forcing to w height 2 *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M +**lsf_th_surf:** Large-scale forcing to theta at the surface *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_th_lev1:** Large-scale forcing to theta at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_th_lev2:** Large-scale forcing to theta at the second specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_th_zlev1:** Large-scale forcing to theta height 1 *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M +**lsf_th_zlev2:** Large-scale forcing to theta height 2 *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M +**lsf_qv_surf:** Large-scale forcing to qv at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_qv_lev1:** Large-scale forcing to qv at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_qv_lev2:** Large-scale forcing to qv at the second specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M +**lsf_qv_zlev1:** Large-scale forcing to qv height 1 *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M +**lsf_qv_zlev2:** Large-scale forcing to qv height 2 *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_rayleigh_damping_layer.csv b/docs/csv/hydro_core_rayleigh_damping_layer.csv index b5e687b..99e007c 100644 --- a/docs/csv/hydro_core_rayleigh_damping_layer.csv +++ b/docs/csv/hydro_core_rayleigh_damping_layer.csv @@ -1,2 +1,2 @@ -dampingLayerSelector, 0, 1, 0, Mandatory, Rayleigh Damping Layer selector -dampingLayerDepth, 0.0, FLT_MAX, 100.0, Mandatory, Rayleigh Damping Layer Depth +**dampingLayerSelector:** Rayleigh Damping Layer selector, 0, 1, 0, M +**dampingLayerDepth:** Rayleigh Damping Layer Depth, 0.0, FLT_MAX, 100.0, M diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index 3dbb3b5..1696552 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -1,24 +1,24 @@ -surflayerSelector, 0, 3, 0, Mandatory, Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr) -surflayer_z0, 1e-12, 1e+0, 0.1, Mandatory, Roughness length (momentum) when surflayerSelector > 0 -surflayer_z0t, 1e-6, 1e+1, 0.1, Mandatory, Roughness length (temperature) when surflayerSelector > 0 -surflayer_z0tdyn, 0, 2, 1, Optional, Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff -surflayer_wth, -5e+0, 5e+0, 0.0, Mandatory, Kinematic sensible heat flux at the surface when surflayerSelector = 1 -surflayer_tr, -1e+1, 1e+1, 0.0, Mandatory, Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling) -surflayer_wq, -5e+0, 5e+0, 0.0, Cond-Mand, Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 (Cond-Mand if moistureSelector==1) -surflayer_qr, -1e+1, 1e+1, 0.0, Cond-Mand, Water vapor rate (kg/kg h-1) when surflayerSelector = 2 (Cond-Mand if moistureSelector==1) -surflayer_idealsine, 0, 1, 0, Mandatory, Selector for idealized sinusoidal surface heat flux or skin temperature forcing -surflayer_ideal_ts, 0, 1e+5, 0.0, Cond-Mand, Start time in seconds for the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) -surflayer_ideal_te, 0, 1e+5, 0.0, Cond-Mand, End time in seconds for the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) -surflayer_ideal_amp, 0, 1e+3, 0.1, Cond-Mand, Maximum amplitude of the idealized sinusoidal surface forcing (Cond-Mand if surflayer_idealsine > 0) -surflayer_ideal_qts, 0, 1e+5, 0.0, Cond-Mand, Start time in seconds for the idealized sinusoidal surface forcing (qv) (Cond-Mand if moistureSelector==1 and surflayer_idealsine > 0) -surflayer_ideal_qte, 0, 1e+5, 0.0, Cond-Mand, End time in seconds for the idealized sinusoidal surface forcing (qv) (Cond-Mand if moistureSelector==1 and surflayer_idealsine > 0) -surflayer_ideal_qamp, 0, 1e+3, 0.1, Cond-Mand, Maximum amplitude of the idealized sinusoidal surface forcing (qv) (Cond-Mand if moistureSelector==1 and surflayer_idealsine > 0) -surflayer_qskin_input, 0, 1, 0, Cond-Opt, Selector for file input (restart) value for qskin under surflayerSelector == 2 (Cond-Opt if moistureSelector==1) -surflayer_offshore, 0, 1, 0, Mandatory, Offshore selector: 0=off;1=on -surflayer_offshore_visc, 0, 1, 1, Optional, Viscous term on z0m: 0=off; 1=on -surflayer_offshore_opt, 0, 5, 0, Cond-Mand, Offshore roughness parameterization: ==0 (Charnock); ==1 (Charnock with variable alpha); ==2 (Taylor & Yelland); ==3 (Donelan); ==4 (Drennan); ==5 (Porchetta) (Cond-Mand if surflayer_offshore > 0) -surflayer_offshore_dyn, 0, 1, 1, Cond-Opt, Selector to use parameterized ocean parameters: 0=off; 1=on (Cond-Opt if surflayer_offshore > 0) -surflayer_offshore_hs, 0, 1e+2, 0.0, Cond-Mand, Significant wave height (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2; 3; 4; or 5) -surflayer_offshore_lp, 0.1, 1e+3, 0.1, Cond-Mand, Peak wavelength (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2) -surflayer_offshore_cp, 0.1, 1e+2, 0.1, Cond-Mand, Wave phase speed (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 3; 4; or 5 -surflayer_offshore_theta, 0.0, 180.0, 0.0, Cond-Mand, Wave/wind angle (Cond-Mand if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 5 or surflayer_offshore > 0 and surflayer_offshore_dyn==1 and surflayer_offshore_opt == 5) \ No newline at end of file +**surflayerSelector:** Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr), 0, 3, 0, M +**ssurflayer_z0:** Roughness length (momentum) when surflayerSelector > 0, 1e-12, 1e+0, 0.1, M +**ssurflayer_z0t:** Roughness length (temperature) when surflayerSelector > 0, 1e-6, 1e+1, 0.1, M +**ssurflayer_z0tdyn:** Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff, 0, 2, 1, O +**ssurflayer_wth:** Kinematic sensible heat flux at the surface when surflayerSelector = 1, -5e+0, 5e+0, 0.0, M +**ssurflayer_tr:** Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling), -1e+1, 1e+1, 0.0, M +**ssurflayer_wq:** Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 *C-M if moistureSelector==1*, -5e+0, 5e+0, 0.0, C-M +**ssurflayer_qr:** Water vapor rate (kg/kg h-1) when surflayer Selector = 2 *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M +**ssurflayer_idealsine:** Selector for idealized sinusoidal surface heat flux or skin temperature forcing, 0, 1, 0, M +**ssurflayer_ideal_ts:** Start time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**ssurflayer_ideal_te:** End time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**ssurflayer_ideal_amp:** Maximum amplitude of the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M +**ssurflayer_ideal_qts:** Start time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**ssurflayer_ideal_qte:** End time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**ssurflayer_ideal_qamp:** Maximum amplitude of the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M +**ssurflayer_qskin_input:** Selector for file input (restart) value for qskin under surflayerSelector == 2 *C-O if moistureSelector==1*, 0, 1, 0, C-O +**ssurflayer_offshore:** Offshore selector: 0=off;1=on, 0, 1, 0, M +**ssurflayer_offshore_visc:** Viscous term on z0m: 0=off; 1=on, 0, 1, 1, O +**ssurflayer_offshore_opt:** Offshore roughness parameterization: ==0 (Charnock); ==1 (Charnock with variable alpha); ==2 (Taylor & Yelland); ==3 (Donelan); ==4 (Drennan); ==5 (Porchetta) *C-M if surflayer_offshore > 0*, 0, 5, 0, C-M +**ssurflayer_offshore_dyn:** Selector to use parameterized ocean parameters: 0=off; 1=on *C-O if surflayer_offshore > 0*, 0, 1, 1, C-O +**ssurflayer_offshore_hs:** Significant wave height *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2; 3; 4; or 5*, 0, 1e+2, 0.0, C-M +**ssurflayer_offshore_lp:** Peak wavelength *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2*, 0.1, 1e+3, 0.1, C-M +**ssurflayer_offshore_cp:** Wave phase speed *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 3; 4; or 5*, 0.1, 1e+2, 0.1, C-M +**ssurflayer_offshore_theta:** Wave/wind angle *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 5 or surflayer_offshore > 0 and surflayer_offshore_dyn==1 and surflayer_offshore_opt == 5*, 0.0, 180.0, 0.0, C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv index cf7bc3b..532c43e 100644 --- a/docs/csv/hydro_core_turbulence.csv +++ b/docs/csv/hydro_core_turbulence.csv @@ -1,6 +1,6 @@ -turbulenceSelector, 0, 1, 0, Mandatory, Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky -TKESelector, 0, 2, 0, Mandatory, Prognostic TKE selector: 0=None; 1=Prognostic -TKEAdvSelector, 0, 6, 0, Mandatory, SGSTKE advection selector -TKEAdvSelector_b_hyb, 0.0, 1.0, 0.0, Mandatory, Hybrid advection scheme parameter -c_s, 1e-6, 1e6, 0.18, Mandatory, Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0 -c_k, 1e-6, 1e6, 0.10, Mandatory, Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0 \ No newline at end of file +**turbulenceSelector:** Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky, 0, 1, 0, M +**TKESelector:** Prognostic TKE selector: 0=None; 1=Prognostic, 0, 2, 0, M +**TKEAdvSelector:** SGSTKE advection selector, 0, 6, 0, M +**TKEAdvSelector_b_hyb:** Hybrid advection scheme parameter, 0.0, 1.0, 0.0, M +**c_s:** Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0, 1e-6, 1e6, 0.18, M +**c_k:** Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0, 1e-6, 1e6, 0.10, M \ No newline at end of file diff --git a/docs/csv/io.csv b/docs/csv/io.csv index ede800a..530fe3f 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -1,6 +1,6 @@ -inPath, N/A, N/A, , Optional, Path where initial/restart file is read in from -inFile, N/A, N/A, , Optional, Name of the input file for coordinate system and initial or restart conditions -outPath, N/A, N/A, , Mandatory, Path where output files are to be written -outFileBase, N/A, N/A, , Mandatory, Base name of the output file series as in (outFileBase).element-in-series -frqOutput, 0, INT_MAX, , Mandatory, Frequency (in timesteps) at which to produce output -ioOutputMode, 0, 1, , Optional, 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files \ No newline at end of file +**inPath:** Path where initial/restart file is read in from, N/A, N/A, , O +**inFile:** Name of the input file for coordinate system and initial or restart conditions, N/A, N/A, , O +**outPath:** Path where output files are to be written, N/A, N/A, , M +**outFileBase:** Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M +**frqOutput:** Frequency (in timesteps) at which to produce output, 0, INT_MAX, , M +**ioOutputMode:** 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files, 0, 1, , O \ No newline at end of file diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index 7d625a3..18c9cd3 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,4 @@ -timeMethod, 0, 0, 0, Mandatory, Selector for time integration method. [0=RK3-WS2002 (default)] -Nt, 1, INT_MAX, 1000, Mandatory, Number of timesteps to perform -dt, FLT_MIN, FLT_MAX, 1.0, Mandatory, Timestep resolution in seconds -NtBatch, 1, Nt, 1, Mandatory, Number of timesteps to compute in batch launch; must have NtBatch <= Nt \ No newline at end of file +**timeMethod:** Selector for time integration method. [0=RK3-WS2002 (default)], 0, 0, 0, M +**Nt:** Number of timesteps to perform, 1, INT_MAX, 1000, M +**dt:** Timestep resolution in seconds, FLT_MIN, FLT_MAX, 1.0, M +**NtBatch:** Number of timesteps to compute in batch launch; must have NtBatch <= Nt, 1, Nt, 1, M \ No newline at end of file diff --git a/docs/parameters.rst b/docs/parameters.rst index bd8152c..3f104e2 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -20,7 +20,32 @@ Each table provides the: These definitions serve as a reference to ensure correct configuration and valid inputs for FastEddy simulations. +FEMPI +===== +.. csv-table:: + :file: csv/fempi.csv + :header-rows: 1 + :delim: , + :class: longtable + +FECUDA +====== + +.. csv-table:: + :file: csv/fecuda.csv + :delim: , + :class: longtable + +IO +=== + +.. csv-table:: + :file: csv/io.csv + :delim: , + :class: longtable + + GRID ==== .. csv-table:: @@ -28,9 +53,42 @@ GRID :delim: , :class: longtable +TIME INTEGRATION +================ + +.. csv-table:: + :file: csv/time_integration.csv + :delim: , + :class: longtable + + HYDRO CORE ========== +BOUNDARY CONDITIONS +------------------- + +.. csv-table:: + :file: csv/hydro_core_boundary_cond.csv + :delim: , + :class: longtable + +HYDRO_IO/LOGGING +---------------- + +.. csv-table:: + :file: csv/hydro_core_io_logging.csv + :delim: , + :class: longtable + +ADVECTION +--------- + +.. csv-table:: + :file: csv/hydro_core_advection.csv + :delim: , + :class: longtable + MOISTURE -------- @@ -39,3 +97,92 @@ MOISTURE :delim: , :class: longtable +CORIOLIS +-------- + +.. csv-table:: + :file: csv/hydro_core_coriolis.csv + :delim: , + :class: longtable + +TURBULENCE +---------- + +.. csv-table:: + :file: csv/hydro_core_turbulence.csv + :delim: , + :class: longtable + +CANOPY +------ + +.. csv-table:: + :file: csv/hydro_core_canopy.csv + :delim: , + :class: longtable + +DIFFUSION +--------- + +.. csv-table:: + :file: csv/hydro_core_diffusion.csv + :delim: , + :class: longtable + +AUXILIARY SCALARS AND SOURCES +----------------------------- + +.. csv-table:: + :file: csv/hydro_core_auxiliary_scalars.csv + :delim: , + :class: longtable + +EXPLICIT FILTERS +---------------- + +.. csv-table:: + :file: csv/hydro_core_explicit_filters.csv + :delim: , + :class: longtable + +RAYLEIGH DAMPING LAYER +---------------------- + +.. csv-table:: + :file: csv/hydro_core_rayleigh_damping_layer.csv + :delim: , + :class: longtable + +SURFACE LAYER +------------- + +.. csv-table:: + :file: csv/hydro_core_surface_layer.csv + :delim: , + :class: longtable + +CELL PERTURBATION METHOD +------------------------ + +.. csv-table:: + :file: csv/hydro_core_cell_perturbation.csv + :delim: , + :class: longtable + +BASE-STATE +---------- + +.. csv-table:: + :file: csv/hydro_core_base_state.csv + :delim: , + :class: longtable + +LARGE SCALE FORCINGS +-------------------- + +.. csv-table:: + :file: csv/hydro_core_large_scale_forcings.csv + :delim: , + :class: longtable + + From 628868c4ed1a48fb8726ec6a6fbca2a4cb136475 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 23 Sep 2025 07:55:31 -0600 Subject: [PATCH 35/65] Per #91, modifying header row in fempi.csv and page description. --- docs/csv/fempi.csv | 2 +- docs/parameters.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/csv/fempi.csv b/docs/csv/fempi.csv index d08fb12..a6c495c 100644 --- a/docs/csv/fempi.csv +++ b/docs/csv/fempi.csv @@ -1,3 +1,3 @@ -Name, Min, Max, Default, Requirement, Description +Parameter Name: Description, Min, Max, Default, Req. **numProcsX:** Number of cores to be used for horizontal domain decomposition in X, 1, INT_MAX, , M **numProcsY:** Number of cores to be used for horizontal domain decomposition in Y, 1, INT_MAX, , M \ No newline at end of file diff --git a/docs/parameters.rst b/docs/parameters.rst index 3f104e2..c86c81a 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -11,7 +11,7 @@ Each table provides the: * Minimum value (if applicable) * Maximum value (if applicable) * Default value (if applicable) - * Requirement + * Req. (Requirement) * M (Mandatory) * O (Optional) From c389e8763e89b04a8eb280dad3225638e7a37990 Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 2 Oct 2025 16:20:58 -0600 Subject: [PATCH 36/65] Per #91, adding GAD and urban parameters. --- docs/csv/extensions_gad.csv | 11 +++++++++++ docs/csv/hydro_core_io_logging.csv | 3 +-- docs/parameters.rst | 17 +++++++++++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 docs/csv/extensions_gad.csv diff --git a/docs/csv/extensions_gad.csv b/docs/csv/extensions_gad.csv new file mode 100644 index 0000000..4c0934a --- /dev/null +++ b/docs/csv/extensions_gad.csv @@ -0,0 +1,11 @@ +**GADSelector:** Generalized Actuator Disk Selector: 0=off; 1=on, 0, 1, 1, M +**turbineSpecsFile:** The path+filename to a turbine specifications file *Cond-Opt if GADSelector > 0*, N/A, N/A, , C-O +**GADoutputForces:** Flag to include GAD forces in the output: 0=off; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O +**GADofflineForces:** Flag to compute GAD forces in an offline mode: 0=of; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O +**GADaxialInduction:** Flag to compute axial induction factor: 0==off (uses prescribed GADaxialIndVal); 1==on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O +**GADaxialIndVal:** Prescribed constant axial induction factor when GADaxialInduction==1 *Cond-Opt if GADSelector > 0*, 0.0, 1.0, 0.02, C-O +**GADrefSwitch:** Switch to use reference windspeed: 0=off; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O +**GADrefU:** Prescribed constant reference hub-height windspeed *Cond-Opt if GADSelector > 0*, 0.0, 50.0, 0.0, C-O +**GADrefSampleWindow:** Sample duration over which to average per-timestep values (filtering out highest frequencies) *Cond-Opt if GADSelector > 0*, 1.0, 60.0, 10.0, C-O +**GADrefSeriesLength:** Number of sampling windows over which to average again for reference velocity magnitude and direction *Cond-Opt if GADSelector > 0*, 1, 360, 30, C-O +**GADForcingSwitch:** Switch to use the GADrefU-based or local windspeed in computing GAD forces: 0=local *Cond-Opt if GADSelector > 0*; 1=ref, 0, 1, 0, C-O diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index 1f5c034..b6641e1 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,4 +1,3 @@ **hydroForcingWrite:** Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on, 0, 1, 0, M **hydroSubGridWrite:** Switch for dumping SGS fields. 0=off; 1=on, 0, 1, 0, M -**hydroForcingLog:** Switch for logging Frhs min/max etc. 0=off; 1=on, 0, 1, 0, M - +**hydroForcingLog:** Switch for logging Frhs min/max etc. 0=off; 1=on, 0, 1, 0, M \ No newline at end of file diff --git a/docs/parameters.rst b/docs/parameters.rst index c86c81a..cefe863 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -185,4 +185,21 @@ LARGE SCALE FORCINGS :delim: , :class: longtable +EXTENSIONS +========== + +GAD +--- + +.. csv-table:: + :file: csv/extensions_gad.csv + :delim: , + :class: longtable + +URBAN +----- +.. csv-table:: + :file: csv/extensions_urban.csv + :delim: , + :class: longtable From 3f4b133f43dc7dd4064e2130224023fa0adff2fd Mon Sep 17 00:00:00 2001 From: jprestop Date: Thu, 2 Oct 2025 16:22:31 -0600 Subject: [PATCH 37/65] Per #91, adding urban parameters. --- docs/csv/extensions_urban.csv | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/csv/extensions_urban.csv diff --git a/docs/csv/extensions_urban.csv b/docs/csv/extensions_urban.csv new file mode 100644 index 0000000..1fea1e2 --- /dev/null +++ b/docs/csv/extensions_urban.csv @@ -0,0 +1,4 @@ +**urbanSelector:** Urban selector: 0=off; 1=on, 0, 2, , M +**cd_build:** c_d coefficient (m-1) used by the drag-based building formulation: -c_d|u_i|u_i *Cond-Mand if urbanSelector > 0*, 0.0; 1e+8, 100.0, C-M +**ct_build:** c_t coefficient (s-1) used by the drag-based building formulation: -c_t(rho*theta-rho_b*theta_b) & -c_t(rho-rho_b) *Cond-Mand if urbanSelector > 0*, 0.0, 1e+8, 0.0, C-M +**urban_heatRedis:** Selector to activate surface heat redistribution *Cond-Mand if urbanSelector > 0*, 0, 1, 0, C-M From 21cb4a16f9e3867124a8862495c31bac53f6bbeb Mon Sep 17 00:00:00 2001 From: jprestop Date: Fri, 3 Oct 2025 09:56:48 -0600 Subject: [PATCH 38/65] Per #91, updated parameters fields as directed --- docs/csv/extensions_gad.csv | 2 +- docs/csv/extensions_urban.csv | 8 ++-- docs/csv/hydro_core_advection.csv | 4 +- docs/csv/hydro_core_auxiliary_scalars.csv | 6 +-- docs/csv/hydro_core_cell_perturbation.csv | 20 ++++---- docs/csv/hydro_core_coriolis.csv | 2 +- docs/csv/hydro_core_diffusion.csv | 4 +- docs/csv/hydro_core_explicit_filters.csv | 2 +- docs/csv/hydro_core_io_logging.csv | 2 +- .../csv/hydro_core_rayleigh_damping_layer.csv | 4 +- docs/csv/hydro_core_surface_layer.csv | 48 +++++++++---------- docs/csv/hydro_core_turbulence.csv | 10 ++-- 12 files changed, 56 insertions(+), 56 deletions(-) diff --git a/docs/csv/extensions_gad.csv b/docs/csv/extensions_gad.csv index 4c0934a..211b01b 100644 --- a/docs/csv/extensions_gad.csv +++ b/docs/csv/extensions_gad.csv @@ -1,4 +1,4 @@ -**GADSelector:** Generalized Actuator Disk Selector: 0=off; 1=on, 0, 1, 1, M +**GADSelector:** Generalized Actuator Disk Selector: 0=off; 1=on, 0, 1, 0, O **turbineSpecsFile:** The path+filename to a turbine specifications file *Cond-Opt if GADSelector > 0*, N/A, N/A, , C-O **GADoutputForces:** Flag to include GAD forces in the output: 0=off; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O **GADofflineForces:** Flag to compute GAD forces in an offline mode: 0=of; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O diff --git a/docs/csv/extensions_urban.csv b/docs/csv/extensions_urban.csv index 1fea1e2..4b4d2ba 100644 --- a/docs/csv/extensions_urban.csv +++ b/docs/csv/extensions_urban.csv @@ -1,4 +1,4 @@ -**urbanSelector:** Urban selector: 0=off; 1=on, 0, 2, , M -**cd_build:** c_d coefficient (m-1) used by the drag-based building formulation: -c_d|u_i|u_i *Cond-Mand if urbanSelector > 0*, 0.0; 1e+8, 100.0, C-M -**ct_build:** c_t coefficient (s-1) used by the drag-based building formulation: -c_t(rho*theta-rho_b*theta_b) & -c_t(rho-rho_b) *Cond-Mand if urbanSelector > 0*, 0.0, 1e+8, 0.0, C-M -**urban_heatRedis:** Selector to activate surface heat redistribution *Cond-Mand if urbanSelector > 0*, 0, 1, 0, C-M +**urbanSelector:** Urban selector: 0=off; 1=on, 0, 2, 0, O +**cd_build:** c_d coefficient (m-1) used by the drag-based building formulation: -c_d|u_i|u_i *C-O if urbanSelector > 0*, 0.0, 1e+8, 100.0, C-O +**ct_build:** c_t coefficient (s-1) used by the drag-based building formulation: -c_t(rho*theta-rho_b*theta_b) & -c_t(rho-rho_b) *C-O if urbanSelector > 0*, 0.0, 1e+8, 10.0, C-O +**urban_heatRedis:** Selector to activate surface heat redistribution *C-O if urbanSelector > 0*, 0, 1, 0, C-O diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv index 547fd20..3745c28 100644 --- a/docs/csv/hydro_core_advection.csv +++ b/docs/csv/hydro_core_advection.csv @@ -1,2 +1,2 @@ -**advectionSelector:** Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order, 0, 6, 0, M -**b_hyb:** Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order cetered; 0.0 < b_hyb < 1.0 = hybrid, 0.0, 1.0, 0.8, M \ No newline at end of file +**advectionSelector:** Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order; 4=3rd-order WENO; 5=5th-order WENO; 6=2nd-order centered, 0, 6, 3, O +**b_hyb:** Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order centered; 0.0 < b_hyb < 1.0 = hybrid; *C-M if advectionSelector==2;3*, 0.0, 1.0, 0.8, O; C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 6a93072..06803f4 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -9,6 +9,6 @@ **srcAuxScGeometryType:** 0=point (single cell volume); 1=line (line of surface cells) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 0, 0, C-M **srcAuxScMassSpecType:** Mass specification type 0=strict mass in kg; 1=mass source rate in kg/s *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 0, 0, C-M **srcAuxScMassSpecValue:** Mass specification value in kg or kg/s given by srcAuxScMassSpecType 0 or 1 *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0.0, FLT_MAX, 1.0, C-M -**srcAuxScLocation_X:** Source geometry centroid postion in x (west-east) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M -**srcAuxScLocation_Y:** Source geometry centroid postion in y (south-north) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M -**srcAuxScLocation_Z:** Source geometry centroid postion in z (vertical above the surface) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M \ No newline at end of file +**srcAuxScLocation_X:** Source geometry centroid position in x (west-east) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M +**srcAuxScLocation_Y:** Source geometry centroid position in y (south-north) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M +**srcAuxScLocation_Z:** Source geometry centroid position in z (vertical above the surface) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv index 6fdc91e..a766446 100644 --- a/docs/csv/hydro_core_cell_perturbation.csv +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -1,11 +1,11 @@ **cellpertSelector:** CP method selector: 0=off; 1=on, 0, 1, 0, O -**ccellpert_nts:** Number of time steps after which perturbations are seeded, 0, 1e+6, 500, O -**ccellpert_sw2b:** Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south *C-M if cellpertSelector > 0*, 0, 3, 0, C-M -**ccellpert_amp:** Maximum amplitude for the potential temperature perturbations *C-M if cellpertSelector > 0*, 0.0, 20.0, 0.5, C-M -**ccellpert_gppc:** Number of grid points conforming the cell *C-M if cellpertSelector > 0*, 0, 50, 8, C-M -**ccellpert_ndbc:** Number of cells normal to domain lateral boundaries *C-M if cellpertSelector > 0*, 0, 10, 3, C-M -**ccellpert_kbottom:** Z-grid point where the perturbations start *C-M if cellpertSelector > 0*, 1, 10, 1, C-M -**ccellpert_ktop:** Z-grid point where the perturbations end *C-M if cellpertSelector > 0*, 0, 200, 20, C-M -**ccellpert_tvcp:** Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) *C-M if cellpertSelector > 0*, 0, 1, 0, C-M -**ccellpert_eckert:** Eckert number for the potential temperature perturbations (hydroBCs==1) *C-M if cellpertSelector > 0*, 0.0, 10.0, 0.2, C-M -**ccellpert_tsfact:** Factor on the refreshing perturbation time scale (hydroBCs==1) *C-M if cellpertSelector > 0*, 0.0, 10.0, 1.0, C-M +**cellpert_nts:** Number of time steps after which perturbations are seeded, 0, 1e+6, 500, O +**cellpert_sw2b:** Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south *C-O if cellpertSelector > 0*, 0, 3, 0, C-O +**cellpert_amp:** Maximum amplitude for the potential temperature perturbations *C-O if cellpertSelector > 0*, 0.0, 20.0, 0.5, C-O +**cellpert_gppc:** Number of grid points conforming the cell *C-O if cellpertSelector > 0*, 0, 50, 8, C-O +**cellpert_ndbc:** Number of cells normal to domain lateral boundaries *C-O if cellpertSelector > 0*, 0, 10, 3, C-O +**cellpert_kbottom:** Z-grid point where the perturbations start *C-O if cellpertSelector > 0*, 1, 10, 1, C-O +**cellpert_ktop:** Z-grid point where the perturbations end *C-O if cellpertSelector > 0*, 0, 200, 20, C-O +**cellpert_tvcp:** Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) *C-O if cellpertSelector > 0*, 0, 1, 0, C-O +**cellpert_eckert:** Eckert number for the potential temperature perturbations (hydroBCs==1) *C-O if cellpertSelector > 0*, 0.0, 10.0, 0.2, C-O +**cellpert_tsfact:** Factor on the refreshing perturbation time scale (hydroBCs==1) *C-O if cellpertSelector > 0*, 0.0, 10.0, 1.0, C-O diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv index 17501e9..d57297e 100644 --- a/docs/csv/hydro_core_coriolis.csv +++ b/docs/csv/hydro_core_coriolis.csv @@ -1,2 +1,2 @@ **coriolisSelector:** Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical, 0, 2, 0, M -**coriolisLatitude:** Charactersitc latitude in degrees from equator of the LES domain, -90.0, 90.0, 54.0, M \ No newline at end of file +**coriolisLatitude:** Characteristic latitude in degrees from equator of the LES domain, -90.0, 90.0, 54.0, M \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv index 51e6b18..ec87035 100644 --- a/docs/csv/hydro_core_diffusion.csv +++ b/docs/csv/hydro_core_diffusion.csv @@ -1,2 +1,2 @@ -**diffusionSelector:** Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity, 0, 1, 0, M -**nu_0:** Constant diffusivity used when diffusionSelector=1, 0, FLT_MAX, 1.0, M \ No newline at end of file +**diffusionSelector:** Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity, 0, 1, 0, O +**nu_0:** Constant diffusivity used when diffusionSelector=1, 0, FLT_MAX, 1.0, O \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index 34270ed..bb0ea01 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,4 +1,4 @@ -**filterSelector:** Explicit filter selector: 0=off; 1=on, 0, 1, 0, M +**filterSelector:** Explicit filter selector: 0=off; 1=on, 0, 1, 0, O **ffilter_6thdiff_vert:** Vertical 6th-order filter on w selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O **ffilter_6thdiff_hori:** Horizontal 6th-order filter on rho; theta; qv selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O **ffilter_6thdiff_vert_coeff:** Vertical 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_vert == 1*, 0.0, 1.0, 0.03, C-M diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index b6641e1..8c8fdfe 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,3 +1,3 @@ -**hydroForcingWrite:** Switch for dumping hydroFldsFrhs for prognositic fields. 0=off; 1=on, 0, 1, 0, M +**hydroForcingWrite:** Switch for dumping hydroFldsFrhs for prognostic fields. 0=off; 1=on, 0, 1, 0, O **hydroSubGridWrite:** Switch for dumping SGS fields. 0=off; 1=on, 0, 1, 0, M **hydroForcingLog:** Switch for logging Frhs min/max etc. 0=off; 1=on, 0, 1, 0, M \ No newline at end of file diff --git a/docs/csv/hydro_core_rayleigh_damping_layer.csv b/docs/csv/hydro_core_rayleigh_damping_layer.csv index 99e007c..f9b3751 100644 --- a/docs/csv/hydro_core_rayleigh_damping_layer.csv +++ b/docs/csv/hydro_core_rayleigh_damping_layer.csv @@ -1,2 +1,2 @@ -**dampingLayerSelector:** Rayleigh Damping Layer selector, 0, 1, 0, M -**dampingLayerDepth:** Rayleigh Damping Layer Depth, 0.0, FLT_MAX, 100.0, M +**dampingLayerSelector:** Rayleigh Damping Layer selector, 0, 1, 0, O +**dampingLayerDepth:** Rayleigh Damping Layer Depth; *C-O if dampingLayerSelector==1*, 0.0, FLT_MAX, 100.0, C-O diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index 1696552..a2543aa 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -1,24 +1,24 @@ -**surflayerSelector:** Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=sking temperature rate (surflayer_tr), 0, 3, 0, M -**ssurflayer_z0:** Roughness length (momentum) when surflayerSelector > 0, 1e-12, 1e+0, 0.1, M -**ssurflayer_z0t:** Roughness length (temperature) when surflayerSelector > 0, 1e-6, 1e+1, 0.1, M -**ssurflayer_z0tdyn:** Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff, 0, 2, 1, O -**ssurflayer_wth:** Kinematic sensible heat flux at the surface when surflayerSelector = 1, -5e+0, 5e+0, 0.0, M -**ssurflayer_tr:** Temperature rate at the surface when surflayerSelector = 2 (>0 for warming; <0 for cooling), -1e+1, 1e+1, 0.0, M -**ssurflayer_wq:** Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 *C-M if moistureSelector==1*, -5e+0, 5e+0, 0.0, C-M -**ssurflayer_qr:** Water vapor rate (kg/kg h-1) when surflayer Selector = 2 *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M -**ssurflayer_idealsine:** Selector for idealized sinusoidal surface heat flux or skin temperature forcing, 0, 1, 0, M -**ssurflayer_ideal_ts:** Start time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**ssurflayer_ideal_te:** End time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**ssurflayer_ideal_amp:** Maximum amplitude of the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M -**ssurflayer_ideal_qts:** Start time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**ssurflayer_ideal_qte:** End time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**ssurflayer_ideal_qamp:** Maximum amplitude of the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M -**ssurflayer_qskin_input:** Selector for file input (restart) value for qskin under surflayerSelector == 2 *C-O if moistureSelector==1*, 0, 1, 0, C-O -**ssurflayer_offshore:** Offshore selector: 0=off;1=on, 0, 1, 0, M -**ssurflayer_offshore_visc:** Viscous term on z0m: 0=off; 1=on, 0, 1, 1, O -**ssurflayer_offshore_opt:** Offshore roughness parameterization: ==0 (Charnock); ==1 (Charnock with variable alpha); ==2 (Taylor & Yelland); ==3 (Donelan); ==4 (Drennan); ==5 (Porchetta) *C-M if surflayer_offshore > 0*, 0, 5, 0, C-M -**ssurflayer_offshore_dyn:** Selector to use parameterized ocean parameters: 0=off; 1=on *C-O if surflayer_offshore > 0*, 0, 1, 1, C-O -**ssurflayer_offshore_hs:** Significant wave height *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2; 3; 4; or 5*, 0, 1e+2, 0.0, C-M -**ssurflayer_offshore_lp:** Peak wavelength *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2*, 0.1, 1e+3, 0.1, C-M -**ssurflayer_offshore_cp:** Wave phase speed *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 3; 4; or 5*, 0.1, 1e+2, 0.1, C-M -**ssurflayer_offshore_theta:** Wave/wind angle *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 5 or surflayer_offshore > 0 and surflayer_offshore_dyn==1 and surflayer_offshore_opt == 5*, 0.0, 180.0, 0.0, C-M \ No newline at end of file +**surflayerSelector:** Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=skin temperature rate (surflayer_tr), 0, 3, 0, M +**surflayer_z0:** Roughness length (momentum) when surflayerSelector > 0, 1e-12, 1e+0, 0.1, M +**surflayer_z0t:** Roughness length (temperature) when surflayerSelector > 0, 1e-6, 1e+1, 0.1, M +**surflayer_z0tdyn:** Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff, 0, 2, 1, O +**surflayer_wth:** Kinematic sensible heat flux at the surface *C-M if surflayerSelector==1*, -5e+0, 5e+0, 0.0, C-M +**surflayer_tr:** Temperature rate at the surface *C-M if surflayerSelector==2* (>0 for warming; <0 for cooling), -1e+1, 1e+1, 0.0, C-M +**surflayer_wq:** Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 *C-M if moistureSelector==1*, -5e+0, 5e+0, 0.0, C-M +**surflayer_qr:** Water vapor rate (kg/kg h-1) when surflayer Selector = 2 *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M +**surflayer_idealsine:** Selector for idealized sinusoidal surface heat flux or skin temperature forcing, 0, 1, 0, O +**surflayer_ideal_ts:** Start time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_te:** End time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_amp:** Maximum amplitude of the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M +**surflayer_ideal_qts:** Start time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_qte:** End time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_qamp:** Maximum amplitude of the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M +**surflayer_qskin_input:** Selector for file input (restart) value for qskin under surflayerSelector == 2 *C-O if moistureSelector==1*, 0, 1, 0, C-O +**surflayer_offshore:** Offshore selector: 0=off;1=on, 0, 1, 1, O +**surflayer_offshore_visc:** Viscous term on z0m: 0=off; 1=on, 0, 1, 1, O +**surflayer_offshore_opt:** Offshore roughness parameterization: ==0 (Charnock); ==1 (Charnock with variable alpha); ==2 (Taylor & Yelland); ==3 (Donelan); ==4 (Drennan); ==5 (Porchetta) *C-M if surflayer_offshore > 0*, 0, 5, 4, O +**surflayer_offshore_dyn:** Selector to use parameterized ocean parameters: 0=off; 1=on *C-O if surflayer_offshore > 0*, 0, 1, 1, C-O +**surflayer_offshore_hs:** Significant wave height *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2; 3; 4; or 5*, 0, 1e+2, 0.0, C-M +**surflayer_offshore_lp:** Peak wavelength *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2*, 0.1, 1e+3, 0.1, C-M +**surflayer_offshore_cp:** Wave phase speed *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 3; 4; or 5*, 0.1, 1e+2, 0.1, C-M +**surflayer_offshore_theta:** Wave/wind angle *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 5 or surflayer_offshore > 0 and surflayer_offshore_dyn==1 and surflayer_offshore_opt == 5*, 0.0, 180.0, 0.0, C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv index 532c43e..3872258 100644 --- a/docs/csv/hydro_core_turbulence.csv +++ b/docs/csv/hydro_core_turbulence.csv @@ -1,6 +1,6 @@ **turbulenceSelector:** Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky, 0, 1, 0, M -**TKESelector:** Prognostic TKE selector: 0=None; 1=Prognostic, 0, 2, 0, M -**TKEAdvSelector:** SGSTKE advection selector, 0, 6, 0, M -**TKEAdvSelector_b_hyb:** Hybrid advection scheme parameter, 0.0, 1.0, 0.0, M -**c_s:** Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0, 1e-6, 1e6, 0.18, M -**c_k:** Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0, 1e-6, 1e6, 0.10, M \ No newline at end of file +**TKESelector:** Prognostic TKE selector: 0=None; 1=Prognostic; 2=requires canopySelector=1, 0, 2, 1, O +**TKEAdvSelector:** SGSTKE advection selector, 0, 6, 0, O +**TKEAdvSelector_b_hyb:** Hybrid advection scheme parameter, 0.0, 1.0, 0.0, O +**c_s:** Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0, 1e-6, 1e6, 0.18, O +**c_k:** Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0, 1e-6, 1e6, 0.10, O \ No newline at end of file From a155aefde63450a5301c1fee01418b416f87c789 Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 6 Oct 2025 09:23:55 -0600 Subject: [PATCH 39/65] Per #91, updating urbanSelector --- docs/csv/extensions_urban.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/extensions_urban.csv b/docs/csv/extensions_urban.csv index 4b4d2ba..402e556 100644 --- a/docs/csv/extensions_urban.csv +++ b/docs/csv/extensions_urban.csv @@ -1,4 +1,4 @@ -**urbanSelector:** Urban selector: 0=off; 1=on, 0, 2, 0, O +**urbanSelector:** Urban selector: 0=off; 1=on with no thermal contribution; 2=on, with thermal relaxation towards base state, 0, 2, 0, O **cd_build:** c_d coefficient (m-1) used by the drag-based building formulation: -c_d|u_i|u_i *C-O if urbanSelector > 0*, 0.0, 1e+8, 100.0, C-O **ct_build:** c_t coefficient (s-1) used by the drag-based building formulation: -c_t(rho*theta-rho_b*theta_b) & -c_t(rho-rho_b) *C-O if urbanSelector > 0*, 0.0, 1e+8, 10.0, C-O **urban_heatRedis:** Selector to activate surface heat redistribution *C-O if urbanSelector > 0*, 0, 1, 0, C-O From 9c5612a47352cffbf381ba3ce603720cb28696bb Mon Sep 17 00:00:00 2001 From: jprestop Date: Mon, 6 Oct 2025 09:27:00 -0600 Subject: [PATCH 40/65] Per #91, remove extra comma --- docs/csv/extensions_urban.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/extensions_urban.csv b/docs/csv/extensions_urban.csv index 402e556..60388c1 100644 --- a/docs/csv/extensions_urban.csv +++ b/docs/csv/extensions_urban.csv @@ -1,4 +1,4 @@ -**urbanSelector:** Urban selector: 0=off; 1=on with no thermal contribution; 2=on, with thermal relaxation towards base state, 0, 2, 0, O +**urbanSelector:** Urban selector: 0=off; 1=on with no thermal contribution; 2=on with thermal relaxation towards base state, 0, 2, 0, O **cd_build:** c_d coefficient (m-1) used by the drag-based building formulation: -c_d|u_i|u_i *C-O if urbanSelector > 0*, 0.0, 1e+8, 100.0, C-O **ct_build:** c_t coefficient (s-1) used by the drag-based building formulation: -c_t(rho*theta-rho_b*theta_b) & -c_t(rho-rho_b) *C-O if urbanSelector > 0*, 0.0, 1e+8, 10.0, C-O **urban_heatRedis:** Selector to activate surface heat redistribution *C-O if urbanSelector > 0*, 0, 1, 0, C-O From 1ba6f4f44b3bc9ae1317ea0161648ea49f90fadb Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 7 Oct 2025 10:28:10 -0600 Subject: [PATCH 41/65] Per #91, making updates per suggestions from Jeremy and other fixes as well --- docs/csv/extensions_gad.csv | 20 ++++++++++---------- docs/csv/grid.csv | 5 ++--- docs/csv/hydro_core_auxiliary_scalars.csv | 2 +- docs/csv/hydro_core_boundary_cond.csv | 8 ++++---- docs/csv/hydro_core_explicit_filters.csv | 10 +++++----- docs/csv/hydro_core_moisture.csv | 2 +- docs/csv/time_integration.csv | 2 +- 7 files changed, 24 insertions(+), 25 deletions(-) diff --git a/docs/csv/extensions_gad.csv b/docs/csv/extensions_gad.csv index 211b01b..739d9fe 100644 --- a/docs/csv/extensions_gad.csv +++ b/docs/csv/extensions_gad.csv @@ -1,11 +1,11 @@ **GADSelector:** Generalized Actuator Disk Selector: 0=off; 1=on, 0, 1, 0, O -**turbineSpecsFile:** The path+filename to a turbine specifications file *Cond-Opt if GADSelector > 0*, N/A, N/A, , C-O -**GADoutputForces:** Flag to include GAD forces in the output: 0=off; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O -**GADofflineForces:** Flag to compute GAD forces in an offline mode: 0=of; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O -**GADaxialInduction:** Flag to compute axial induction factor: 0==off (uses prescribed GADaxialIndVal); 1==on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O -**GADaxialIndVal:** Prescribed constant axial induction factor when GADaxialInduction==1 *Cond-Opt if GADSelector > 0*, 0.0, 1.0, 0.02, C-O -**GADrefSwitch:** Switch to use reference windspeed: 0=off; 1=on *Cond-Opt if GADSelector > 0*, 0, 1, 0, C-O -**GADrefU:** Prescribed constant reference hub-height windspeed *Cond-Opt if GADSelector > 0*, 0.0, 50.0, 0.0, C-O -**GADrefSampleWindow:** Sample duration over which to average per-timestep values (filtering out highest frequencies) *Cond-Opt if GADSelector > 0*, 1.0, 60.0, 10.0, C-O -**GADrefSeriesLength:** Number of sampling windows over which to average again for reference velocity magnitude and direction *Cond-Opt if GADSelector > 0*, 1, 360, 30, C-O -**GADForcingSwitch:** Switch to use the GADrefU-based or local windspeed in computing GAD forces: 0=local *Cond-Opt if GADSelector > 0*; 1=ref, 0, 1, 0, C-O +**turbineSpecsFile:** The path+filename to a turbine specifications file *C-O if GADSelector > 0*, N/A, N/A, , C-O +**GADoutputForces:** Flag to include GAD forces in the output: 0=off; 1=on *C-O if GADSelector > 0*, 0, 1, 0, C-O +**GADofflineForces:** Flag to compute GAD forces in an offline mode: 0=of; 1=on *C-O if GADSelector > 0*, 0, 1, 0, C-O +**GADaxialInduction:** Flag to compute axial induction factor: 0==off (uses prescribed GADaxialIndVal); 1==on *C-O if GADSelector > 0*, 0, 1, 0, C-O +**GADaxialIndVal:** Prescribed constant axial induction factor when GADaxialInduction==1 *C-O if GADSelector > 0*, 0.0, 1.0, 0.02, C-O +**GADrefSwitch:** Switch to use reference windspeed: 0=off; 1=on *C-O if GADSelector > 0*, 0, 1, 0, C-O +**GADrefU:** Prescribed constant reference hub-height windspeed *C-O if GADSelector > 0*, 0.0, 50.0, 0.0, C-O +**GADrefSampleWindow:** Sample duration over which to average per-timestep values (filtering out highest frequencies) *C-O if GADSelector > 0*, 1.0, 60.0, 10.0, C-O +**GADrefSeriesLength:** Number of sampling windows over which to average again for reference velocity magnitude and direction *C-O if GADSelector > 0*, 1, 360, 30, C-O +**GADForcingSwitch:** Switch to use the GADrefU-based or local windspeed in computing GAD forces: 0=local *C-O if GADSelector > 0*; 1=ref, 0, 1, 0, C-O diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 688d39c..d9612d0 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -5,9 +5,8 @@ **d_xi:** Computational domain fixed resolution in the 'i' direction, FLT_MIN, FLT_MAX, 10.0, M **d_eta:** Computational domain fixed resolution in the 'j' direction, FLT_MIN, FLT_MAX, 10.0, M **d_zeta:** Computational domain fixed resolution in the 'k' direction, FLT_MIN, FLT_MAX, 10.0, M -**coordHorizHalos:** Switch to setup coordiante halos as periodic=1 or gradient-following=0, 0, 1, 1, M +**coordHorizHalos:** Switch to setup coordinate halos as periodic=1 or gradient-following=0, 0, 1, 1, M **topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , O **verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , M **verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , M -**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, M -**testValue:** Testing values for long min and defaults, -FLT_MAX, FLT_MAX, 10000.0, O \ No newline at end of file +**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, M \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 06803f4..b29345b 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -1,4 +1,4 @@ -**NhydroAuxScalars:** Number of prognostic auxiliary scalar fields, 0, MAX_AUXSC_SRC (20), 0, O +**NhydroAuxScalars:** Number of prognostic auxiliary scalar fields, 0, 256, 0, O **AuxScAdvSelector:** Advection scheme for auxiliary scalar fields *C-M if NhydroAuxScalars > 0*, 0, 6, 0, C-M **AuxScAdvSelector_b_hyb:** Hybrid advection scheme parameter *C-M if NhydroAuxScalars > 0*, 0.0, 1.0, 0.0, C-M **AuxScSGSturb:** Selector to apply sub-grid scale diffusion to auxiliary scalar fields *C-M if NhydroAuxScalars > 0*, 0, 1, 0, C-M diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index 6b96c44..14fdd55 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,6 +1,6 @@ **hydroBCs:** Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl, 1, 2, 2, M **ceilingAdvectionBC:** Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC), 0, 1, 0, O -**hydroBndysFileBase:** Base file name LAD BC set *Cond-Opt if hydroBCs==1*, N/A, N/A, , C-O -**hydroBndysFileStart:** Start counter value for LAD BC set files *Cond-Mand if hydroBCs==1*, 0, 500000, 0, C-M -**hydroBndysFileEnd:** End counter value for LAD BC set files *Cond-Mand if hydroBCs==1*, 0, 500000, 0, C-M -**dtBdyPlaneBCs:** Delta in time (seconds) between BdyPlane sets *Cond-Mand if hydroBCs==1*, 0.0, 6e5, 0.0, C-M +**hydroBndysFileBase:** Base file name LAD BC set *C-M if hydroBCs==1*, N/A, N/A, , C-M +**hydroBndysFileStart:** Start counter value for LAD BC set files *C-M if hydroBCs==1*, 0, 500000, 0, C-M +**hydroBndysFileEnd:** End counter value for LAD BC set files *C-M if hydroBCs==1*, 0, 500000, 0, C-M +**dtBdyPlaneBCs:** Delta in time (seconds) between BdyPlane sets *C-M if hydroBCs==1*, 0.0, 6e5, 0.0, C-M diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index bb0ea01..f7d94a1 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,6 +1,6 @@ **filterSelector:** Explicit filter selector: 0=off; 1=on, 0, 1, 0, O -**ffilter_6thdiff_vert:** Vertical 6th-order filter on w selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O -**ffilter_6thdiff_hori:** Horizontal 6th-order filter on rho; theta; qv selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O -**ffilter_6thdiff_vert_coeff:** Vertical 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_vert == 1*, 0.0, 1.0, 0.03, C-M -**ffilter_6thdiff_hori_coeff:** Horizontal 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_hori == 1*, 0.0, 1.0, 0.03, C-M -**ffilter_divdamp:** Divergence damping selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O \ No newline at end of file +**filter_6thdiff_vert:** Vertical 6th-order filter on w selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O +**filter_6thdiff_hori:** Horizontal 6th-order filter on rho; theta; qv selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O +**filter_6thdiff_vert_coeff:** Vertical 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_vert == 1*, 0.0, 1.0, 0.03, C-M +**filter_6thdiff_hori_coeff:** Horizontal 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_hori == 1*, 0.0, 1.0, 0.03, C-M +**filter_divdamp:** Divergence damping selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O \ No newline at end of file diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv index 9491f7a..b3b1482 100644 --- a/docs/csv/hydro_core_moisture.csv +++ b/docs/csv/hydro_core_moisture.csv @@ -4,7 +4,7 @@ **moistureAdvSelectorQv_b:** Hybrid advection scheme parameter for water vapor *C-M if moistureSelector==1*, 0.0, 1.0, 0.0, C-M **moistureAdvSelectorQi:** Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) *C-M if moistureSelector==1*, 0, 2, 0, C-M **moistureSGSturb:** Selector to apply sub-grid scale diffusion to moisture fields *C-M if moistureSelector==1*, 0, 1, 0, C-M -**moistureCond:** Selector to apply condensation to mositure fields *C-M if moistureSelector==1*, 1, 4, 1, C-M +**moistureCond:** Selector to apply condensation to moisture fields *C-M if moistureSelector==1*, 1, 4, 1, C-M **moistureCondTscale:** Relaxation time in seconds *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M **moistureCondBasePres:** Selector to use base pressure for microphysics *C-M if moistureSelector==1*, 0, 1, 0, C-M **moistureMPcallTscale:** Time scale for microphysics to be called *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index 18c9cd3..1b62e35 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,4 @@ -**timeMethod:** Selector for time integration method. [0=RK3-WS2002 (default)], 0, 0, 0, M +**timeMethod:** Selector for time integration method. [0=RK3-WS2002 (default)], 0, 0, 0, O **Nt:** Number of timesteps to perform, 1, INT_MAX, 1000, M **dt:** Timestep resolution in seconds, FLT_MIN, FLT_MAX, 1.0, M **NtBatch:** Number of timesteps to compute in batch launch; must have NtBatch <= Nt, 1, Nt, 1, M \ No newline at end of file From 440d1b24526ec85e75b792291c19050867ad8f5f Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Fri, 10 Oct 2025 20:42:09 -0600 Subject: [PATCH 42/65] Per #91, updated Nx to the correct default value of 128 --- docs/csv/grid.csv | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index d9612d0..b0511cf 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,4 +1,4 @@ -**Nx:** Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 122, M +**Nx:** Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 128, M **Ny:** Number of discretised domain elements in the y (meridional) direction, 1, INT_MAX, 122, M **Nz:** Number of discretised domain elements in the z (vertical) direction, 1, INT_MAX, 122, M **Nh:** Number of halo cells to be used (dependent on largest stencil extent), 0, INT_MAX, 3, M @@ -9,4 +9,4 @@ **topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , O **verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , M **verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , M -**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, M \ No newline at end of file +**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, M From 0c6c7199f66155017cbb8f874c38f82356dc12a1 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 11:26:53 -0600 Subject: [PATCH 43/65] Per #91, renaming Parameters Reference Guide --- docs/parameters.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index cefe863..906bf09 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -1,6 +1,6 @@ -********** -Parameters -********** +************************** +Parameters Reference Guide +************************** This page defines the configurable parameters available in FastEddy\ :sup:`®`. Parameters are organized into logical sets by model feature or model configuration component. From 00e5f573940225adb4b6ec3b1f1e361312cda7bd Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 11:31:39 -0600 Subject: [PATCH 44/65] Per #91, adding default values of 1. --- docs/csv/fempi.csv | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/csv/fempi.csv b/docs/csv/fempi.csv index a6c495c..021c43e 100644 --- a/docs/csv/fempi.csv +++ b/docs/csv/fempi.csv @@ -1,3 +1,3 @@ Parameter Name: Description, Min, Max, Default, Req. -**numProcsX:** Number of cores to be used for horizontal domain decomposition in X, 1, INT_MAX, , M -**numProcsY:** Number of cores to be used for horizontal domain decomposition in Y, 1, INT_MAX, , M \ No newline at end of file +**numProcsX:** Number of cores to be used for horizontal domain decomposition in X, 1, INT_MAX, 1, M +**numProcsY:** Number of cores to be used for horizontal domain decomposition in Y, 1, INT_MAX, 1, M \ No newline at end of file From 884a454bcd7c08008863e4db72097063ae7e0154 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 11:33:32 -0600 Subject: [PATCH 45/65] Per #91, adding a default value of 0 for ioOutputMode --- docs/csv/io.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/io.csv b/docs/csv/io.csv index 530fe3f..6e05b8f 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -3,4 +3,4 @@ **outPath:** Path where output files are to be written, N/A, N/A, , M **outFileBase:** Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M **frqOutput:** Frequency (in timesteps) at which to produce output, 0, INT_MAX, , M -**ioOutputMode:** 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files, 0, 1, , O \ No newline at end of file +**ioOutputMode:** 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file From 11f52df70793375fceff2fef1ec430ce7b1a66f9 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 11:37:43 -0600 Subject: [PATCH 46/65] Per #91, added --- docs/csv/time_integration.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index 1b62e35..ca98bbf 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,4 @@ **timeMethod:** Selector for time integration method. [0=RK3-WS2002 (default)], 0, 0, 0, O **Nt:** Number of timesteps to perform, 1, INT_MAX, 1000, M **dt:** Timestep resolution in seconds, FLT_MIN, FLT_MAX, 1.0, M -**NtBatch:** Number of timesteps to compute in batch launch; must have NtBatch <= Nt, 1, Nt, 1, M \ No newline at end of file +**NtBatch:** Number of timesteps to compute in batch launch; must have NtBatch <= Nt; should be equal to or a factor of frqOutput, 1, Nt, 1, M \ No newline at end of file From 9151c3c69c9bfbd1f5d5721abefb9f82d243c526 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 11:42:22 -0600 Subject: [PATCH 47/65] Per #91, updated definition of verticalDeformQuadCoeff to be Quadratic term coefficient in the deformtion scheme --- docs/csv/grid.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index d9612d0..375393d 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -9,4 +9,4 @@ **topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , O **verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , M **verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , M -**verticalDeformQuadCoeff:** Deformation factor (0.0=max compression; 1.0=no compression), -2.0, 2.0, 0.0, M \ No newline at end of file +**verticalDeformQuadCoeff:** Quadratic term coefficient in the deformtion scheme, -2.0, 2.0, 0.0, M \ No newline at end of file From 7bb41c4780d065b4457cb0995752a0cd8537417f Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 11:45:51 -0600 Subject: [PATCH 48/65] Per #91, changed language from 'dumping' to 'writing output of'for hydroForcingWrite and hydroSubGridWrite --- docs/csv/hydro_core_io_logging.csv | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index 8c8fdfe..40f6684 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,3 +1,3 @@ -**hydroForcingWrite:** Switch for dumping hydroFldsFrhs for prognostic fields. 0=off; 1=on, 0, 1, 0, O -**hydroSubGridWrite:** Switch for dumping SGS fields. 0=off; 1=on, 0, 1, 0, M +**hydroForcingWrite:** Switch for writing output of hydroFldsFrhs for prognostic fields. 0=off; 1=on, 0, 1, 0, O +**hydroSubGridWrite:** Switch for writing output of SGS fields. 0=off; 1=on, 0, 1, 0, M **hydroForcingLog:** Switch for logging Frhs min/max etc. 0=off; 1=on, 0, 1, 0, M \ No newline at end of file From ce1b946646d21bf477d1eeab41542599f4e139c1 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 12:05:41 -0600 Subject: [PATCH 49/65] Per #91, added '; should be an even multiple of NtBatch' to the description of frqOutput --- docs/csv/io.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/io.csv b/docs/csv/io.csv index 6e05b8f..ce88de8 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -2,5 +2,5 @@ **inFile:** Name of the input file for coordinate system and initial or restart conditions, N/A, N/A, , O **outPath:** Path where output files are to be written, N/A, N/A, , M **outFileBase:** Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M -**frqOutput:** Frequency (in timesteps) at which to produce output, 0, INT_MAX, , M +**frqOutput:** Frequency (in timesteps) at which to produce output; should be an even multiple of NtBatch, 0, INT_MAX, , M **ioOutputMode:** 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file From d5184779924225a576d85f2141e42af3a62fbda4 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 12:10:52 -0600 Subject: [PATCH 50/65] Per #91, testing out line breaks --- docs/csv/io.csv | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/csv/io.csv b/docs/csv/io.csv index ce88de8..3e6b74f 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -1,6 +1,6 @@ -**inPath:** Path where initial/restart file is read in from, N/A, N/A, , O -**inFile:** Name of the input file for coordinate system and initial or restart conditions, N/A, N/A, , O -**outPath:** Path where output files are to be written, N/A, N/A, , M -**outFileBase:** Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M -**frqOutput:** Frequency (in timesteps) at which to produce output; should be an even multiple of NtBatch, 0, INT_MAX, , M -**ioOutputMode:** 0: N-to-1 gather and write to a netcdf file; 1:N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file +**inPath:** |br| Path where initial/restart file is read in from, N/A, N/A, , O +**inFile:** |br| Name of the input file for coordinate system and initial or restart conditions, N/A, N/A, , O +**outPath:** |br| Path where output files are to be written, N/A, N/A, , M +**outFileBase:** |br| Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M +**frqOutput:** |br| Frequency (in timesteps) at which to produce output; should be an even multiple of NtBatch, 0, INT_MAX, , M +**ioOutputMode:** |br|0: N-to-1 gather and write to a netcdf file; |br|1:N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file From 6dc333b158749cb906d19ec0387518d329d5a1c4 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 12:11:07 -0600 Subject: [PATCH 51/65] Per #91, testing out line breaks --- docs/parameters.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/parameters.rst b/docs/parameters.rst index 906bf09..3746052 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -2,6 +2,10 @@ Parameters Reference Guide ************************** +.. |br| raw:: html + +
+ This page defines the configurable parameters available in FastEddy\ :sup:`®`. Parameters are organized into logical sets by model feature or model configuration component. From 2b84e0439e8af20fe001af0e82fc048e0cc22aa0 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 12:13:01 -0600 Subject: [PATCH 52/65] Per #91, adding a space after '|br|' --- docs/csv/io.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/io.csv b/docs/csv/io.csv index 3e6b74f..080f8c9 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -3,4 +3,4 @@ **outPath:** |br| Path where output files are to be written, N/A, N/A, , M **outFileBase:** |br| Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M **frqOutput:** |br| Frequency (in timesteps) at which to produce output; should be an even multiple of NtBatch, 0, INT_MAX, , M -**ioOutputMode:** |br|0: N-to-1 gather and write to a netcdf file; |br|1:N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file +**ioOutputMode:** |br| 0: N-to-1 gather and write to a netcdf file; |br| 1:N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file From 461118bc297fa1963071f308baf1ac8ca7b83390 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 12:20:19 -0600 Subject: [PATCH 53/65] Per #91, adding space for consistent formatting --- docs/csv/io.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/io.csv b/docs/csv/io.csv index 080f8c9..ed85dc6 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -3,4 +3,4 @@ **outPath:** |br| Path where output files are to be written, N/A, N/A, , M **outFileBase:** |br| Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M **frqOutput:** |br| Frequency (in timesteps) at which to produce output; should be an even multiple of NtBatch, 0, INT_MAX, , M -**ioOutputMode:** |br| 0: N-to-1 gather and write to a netcdf file; |br| 1:N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file +**ioOutputMode:** |br| 0: N-to-1 gather and write to a netcdf file; |br| 1: N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file From 7f15bec7e8d4fd727fc2a0fb1ad9deef73c5d317 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 12:21:19 -0600 Subject: [PATCH 54/65] Modifying URL for intersphinx_mapping to resolve error --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 7e838df..f27f5e9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 From b0f385ba7827060883441ed0a859e0926ff2f15f Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 13:15:04 -0600 Subject: [PATCH 55/65] Per #91, adding breaks in the descriptions for cleaner formatting --- docs/csv/extensions_gad.csv | 22 ++++----- docs/csv/extensions_urban.csv | 8 ++-- docs/csv/fecuda.csv | 6 +-- docs/csv/fempi.csv | 4 +- docs/csv/grid.csv | 24 +++++----- docs/csv/hydro_core_advection.csv | 4 +- docs/csv/hydro_core_auxiliary_scalars.csv | 28 +++++------ docs/csv/hydro_core_base_state.csv | 38 +++++++-------- docs/csv/hydro_core_boundary_cond.csv | 12 ++--- docs/csv/hydro_core_canopy.csv | 8 ++-- docs/csv/hydro_core_cell_perturbation.csv | 22 ++++----- docs/csv/hydro_core_coriolis.csv | 4 +- docs/csv/hydro_core_diffusion.csv | 4 +- docs/csv/hydro_core_explicit_filters.csv | 12 ++--- docs/csv/hydro_core_io_logging.csv | 6 +-- docs/csv/hydro_core_large_scale_forcings.csv | 36 +++++++------- docs/csv/hydro_core_moisture.csv | 20 ++++---- .../csv/hydro_core_rayleigh_damping_layer.csv | 4 +- docs/csv/hydro_core_surface_layer.csv | 48 +++++++++---------- docs/csv/hydro_core_turbulence.csv | 12 ++--- docs/csv/time_integration.csv | 8 ++-- 21 files changed, 165 insertions(+), 165 deletions(-) diff --git a/docs/csv/extensions_gad.csv b/docs/csv/extensions_gad.csv index 739d9fe..b1904b2 100644 --- a/docs/csv/extensions_gad.csv +++ b/docs/csv/extensions_gad.csv @@ -1,11 +1,11 @@ -**GADSelector:** Generalized Actuator Disk Selector: 0=off; 1=on, 0, 1, 0, O -**turbineSpecsFile:** The path+filename to a turbine specifications file *C-O if GADSelector > 0*, N/A, N/A, , C-O -**GADoutputForces:** Flag to include GAD forces in the output: 0=off; 1=on *C-O if GADSelector > 0*, 0, 1, 0, C-O -**GADofflineForces:** Flag to compute GAD forces in an offline mode: 0=of; 1=on *C-O if GADSelector > 0*, 0, 1, 0, C-O -**GADaxialInduction:** Flag to compute axial induction factor: 0==off (uses prescribed GADaxialIndVal); 1==on *C-O if GADSelector > 0*, 0, 1, 0, C-O -**GADaxialIndVal:** Prescribed constant axial induction factor when GADaxialInduction==1 *C-O if GADSelector > 0*, 0.0, 1.0, 0.02, C-O -**GADrefSwitch:** Switch to use reference windspeed: 0=off; 1=on *C-O if GADSelector > 0*, 0, 1, 0, C-O -**GADrefU:** Prescribed constant reference hub-height windspeed *C-O if GADSelector > 0*, 0.0, 50.0, 0.0, C-O -**GADrefSampleWindow:** Sample duration over which to average per-timestep values (filtering out highest frequencies) *C-O if GADSelector > 0*, 1.0, 60.0, 10.0, C-O -**GADrefSeriesLength:** Number of sampling windows over which to average again for reference velocity magnitude and direction *C-O if GADSelector > 0*, 1, 360, 30, C-O -**GADForcingSwitch:** Switch to use the GADrefU-based or local windspeed in computing GAD forces: 0=local *C-O if GADSelector > 0*; 1=ref, 0, 1, 0, C-O +**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 diff --git a/docs/csv/extensions_urban.csv b/docs/csv/extensions_urban.csv index 60388c1..02b9a7f 100644 --- a/docs/csv/extensions_urban.csv +++ b/docs/csv/extensions_urban.csv @@ -1,4 +1,4 @@ -**urbanSelector:** Urban selector: 0=off; 1=on with no thermal contribution; 2=on with thermal relaxation towards base state, 0, 2, 0, O -**cd_build:** c_d coefficient (m-1) used by the drag-based building formulation: -c_d|u_i|u_i *C-O if urbanSelector > 0*, 0.0, 1e+8, 100.0, C-O -**ct_build:** c_t coefficient (s-1) used by the drag-based building formulation: -c_t(rho*theta-rho_b*theta_b) & -c_t(rho-rho_b) *C-O if urbanSelector > 0*, 0.0, 1e+8, 10.0, C-O -**urban_heatRedis:** Selector to activate surface heat redistribution *C-O if urbanSelector > 0*, 0, 1, 0, C-O +**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 diff --git a/docs/csv/fecuda.csv b/docs/csv/fecuda.csv index 259ce80..65e2818 100644 --- a/docs/csv/fecuda.csv +++ b/docs/csv/fecuda.csv @@ -1,3 +1,3 @@ -**tBx:** Number of threads in x-dimension, 1, INT_MAX, , M -**tBy:** Number of threads in y-dimension, 1, INT_MAX, , M -**tBz:** Number of threads in z-dimension, 1, INT_MAX, , M \ No newline at end of file +**tBx:** |br| Number of threads in x-dimension, 1, INT_MAX, , M +**tBy:** |br| Number of threads in y-dimension, 1, INT_MAX, , M +**tBz:** |br| Number of threads in z-dimension, 1, INT_MAX, , M \ No newline at end of file diff --git a/docs/csv/fempi.csv b/docs/csv/fempi.csv index 021c43e..b715d85 100644 --- a/docs/csv/fempi.csv +++ b/docs/csv/fempi.csv @@ -1,3 +1,3 @@ Parameter Name: Description, Min, Max, Default, Req. -**numProcsX:** Number of cores to be used for horizontal domain decomposition in X, 1, INT_MAX, 1, M -**numProcsY:** Number of cores to be used for horizontal domain decomposition in Y, 1, INT_MAX, 1, M \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 4e33c1b..9b23ddb 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,12 +1,12 @@ -**Nx:** Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 128, M -**Ny:** Number of discretised domain elements in the y (meridional) direction, 1, INT_MAX, 122, M -**Nz:** Number of discretised domain elements in the z (vertical) direction, 1, INT_MAX, 122, M -**Nh:** Number of halo cells to be used (dependent on largest stencil extent), 0, INT_MAX, 3, M -**d_xi:** Computational domain fixed resolution in the 'i' direction, FLT_MIN, FLT_MAX, 10.0, M -**d_eta:** Computational domain fixed resolution in the 'j' direction, FLT_MIN, FLT_MAX, 10.0, M -**d_zeta:** Computational domain fixed resolution in the 'k' direction, FLT_MIN, FLT_MAX, 10.0, M -**coordHorizHalos:** Switch to setup coordinate halos as periodic=1 or gradient-following=0, 0, 1, 1, M -**topoFile:** A file containing topography (surface elevation in meters ASL), N/A, N/A, , O -**verticalDeformSwitch:** Switch to use vertical coordinate deformation 0=off; 1=on, 0, 1, , M -**verticalDeformFactor:** Deformation factor (0.0=max compression; 1.0=no compression), 0.0, 1.0, , M -**verticalDeformQuadCoeff:** Quadratic term coefficient in the deformtion scheme, -2.0, 2.0, 0.0, M +**Nx:** |br| Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 128, M +**Ny:** |br| Number of discretised domain elements in the y (meridional) direction, 1, INT_MAX, 122, M +**Nz:** |br| Number of discretised domain elements in the z (vertical) direction, 1, INT_MAX, 122, M +**Nh:** |br| Number of halo cells to be used (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 (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; 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 diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv index 3745c28..5a99c2d 100644 --- a/docs/csv/hydro_core_advection.csv +++ b/docs/csv/hydro_core_advection.csv @@ -1,2 +1,2 @@ -**advectionSelector:** Advection scheme selector: 0=1st-order upwind; 1=3rd-order QUICK; 2=hybrid 3rd-4th order; 3=hybrid 5th-6th order; 4=3rd-order WENO; 5=5th-order WENO; 6=2nd-order centered, 0, 6, 3, O -**b_hyb:** Hybrid advection scheme parameter: 0.0=lower-order upwind; 1.0=higher-order centered; 0.0 < b_hyb < 1.0 = hybrid; *C-M if advectionSelector==2;3*, 0.0, 1.0, 0.8, O; C-M \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index b29345b..9cd34d7 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -1,14 +1,14 @@ -**NhydroAuxScalars:** Number of prognostic auxiliary scalar fields, 0, 256, 0, O -**AuxScAdvSelector:** Advection scheme for auxiliary scalar fields *C-M if NhydroAuxScalars > 0*, 0, 6, 0, C-M -**AuxScAdvSelector_b_hyb:** Hybrid advection scheme parameter *C-M if NhydroAuxScalars > 0*, 0.0, 1.0, 0.0, C-M -**AuxScSGSturb:** Selector to apply sub-grid scale diffusion to auxiliary scalar fields *C-M if NhydroAuxScalars > 0*, 0, 1, 0, C-M -**srcAuxScFile:** The path and filename to an Auxilliary Scalar Sources specification file *C-O if NhydroAuxScalars > 0*, N/A, N/A, , C-O -**srcAuxScTemporalType:** Temporal characterization of source (0=instantaneous; 1=continuous) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 1, 0, C-M -**srcAuxScStartSeconds:** Source start time in seconds *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, FLT_MAX, 0, C-M -**srcAuxScDurationSeconds:** Source duration in seconds *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, FLT_MAX, 30, C-M -**srcAuxScGeometryType:** 0=point (single cell volume); 1=line (line of surface cells) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 0, 0, C-M -**srcAuxScMassSpecType:** Mass specification type 0=strict mass in kg; 1=mass source rate in kg/s *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, 0, 0, C-M -**srcAuxScMassSpecValue:** Mass specification value in kg or kg/s given by srcAuxScMassSpecType 0 or 1 *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0.0, FLT_MAX, 1.0, C-M -**srcAuxScLocation_X:** Source geometry centroid position in x (west-east) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M -**srcAuxScLocation_Y:** Source geometry centroid position in y (south-north) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M -**srcAuxScLocation_Z:** Source geometry centroid position in z (vertical above the surface) *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M \ No newline at end of file +**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 NhydroAuxScalars == 1*, 0, 1, 0, C-M +**srcAuxScStartSeconds:** |br| Source start time in seconds |br| *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, FLT_MAX, 0, C-M +**srcAuxScDurationSeconds:** |br| Source duration in seconds |br| *C-M if srcAuxScFile == NULL and 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 NhydroAuxScalars == 1*, 0, 0, 0, C-M +**srcAuxScMassSpecType:** |br| Mass specification type 0=strict mass in kg; 1=mass source rate in kg/s |br| *C-M if srcAuxScFile == NULL and 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 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 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 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 NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv index 63ff390..2d1ff4a 100644 --- a/docs/csv/hydro_core_base_state.csv +++ b/docs/csv/hydro_core_base_state.csv @@ -1,19 +1,19 @@ -**stabilityScheme:** Scheme used to set hydrostatic stability-dependent Base-State EOS fields (0=none; 1=profile; 2=linear in theta), 0, 4, 0, M -**temp_grnd:** Air Temperature (K) at the ground used to set hydrostatic Base-State EOS fields, FLT_MIN, FLT_MAX, 300.0, M -**pres_grnd:** Pressure (Pa) at the ground used to set hydrostatic Base-State EOS fields, FLT_MIN, FLT_MAX, 1.0e5, M -**zStableBottom:** Height (m) of the first stable upper-layer when stabilityScheme = 1 or 2, 0, FLT_MAX, 1000.0, M -**stableGradient:** Vertical gradient (K/m) of the first stable upper-layer when stabilityScheme = 1 or 2, FLT_MIN, FLT_MAX, 0.1, M -**zStableBottom2:** Height (m) of the second stable upper-layer when stabilityScheme = 2, 0, FLT_MAX, 1100.0, M -**stableGradient2:** Vertical gradient (K/m) of the second stable upper-layer when stabilityScheme = 2, FLT_MIN, FLT_MAX, 0.03, M -**zStableBottom3:** Height (m) of the third stable upper-layer when stabilityScheme = 2, 0, FLT_MAX, 1500.0, M -**stableGradient3:** Vertical gradient (K/m) of the third stable upper-layer when stabilityScheme = 2, FLT_MIN, FLT_MAX, 0.03, M -**thetaPerturbationSwitch:** Switch to include initial theta perturbations: 0=off; 1=on, 0, 1, 0, M -**thetaHeight:** Height below which to include initial theta perturbations: (meters), 0.0, FLT_MAX, 0.0, M -**thetaAmplitude:** Maximum amplitude for theta perturbations: thetaAmplitude*[-1;+1] K, 0.0, 2.0, 0.0, M -**U_g:** Zonal (West-East) component of the geostrophic wind (m/s), -FLT_MAX, FLT_MAX, 0.0, M -**V_g:** Meridional (South-North) component of the geostrophic wind (m/s), -FLT_MAX, FLT_MAX, 0.0, M -**z_Ug:** Height (m) above ground for linear geostrophic wind gradient (zonal component), 0.0, FLT_MAX, 10000.0, M -**z_Vg:** Height (m) above ground for linear geostrophic wind gradient (meridional component), 0.0, FLT_MAX, 10000.0, M -**Ug_grad:** Geostrophic wind gradient for U component; U_g gradient above z_Ug (ms-1/m), -1e2, 1e2, 0.0, M -**Vg_grad:** Geostrophic wind gradient for V component; V_g gradient above z_Vg (ms-1/m), -1e2, 1e2, 0.0, M -**physics_oneRKonly:** Selector to apply physics RHS forcing only at the latest RK stage: 0=off; 1=on, 0, 1, 1, O \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index 14fdd55..cad1a6f 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,6 +1,6 @@ -**hydroBCs:** Selector for hydro BC set. 1=Dirichlet lateral ceiling and surface boundary conditions (Limited Area Domain--LAD); 2=periodicHorizVerticalAbl, 1, 2, 2, M -**ceilingAdvectionBC:** Selector for normal advection at the domain ceiling (0=zero-valued w-BC; 1=non-zero w-BC), 0, 1, 0, O -**hydroBndysFileBase:** Base file name LAD BC set *C-M if hydroBCs==1*, N/A, N/A, , C-M -**hydroBndysFileStart:** Start counter value for LAD BC set files *C-M if hydroBCs==1*, 0, 500000, 0, C-M -**hydroBndysFileEnd:** End counter value for LAD BC set files *C-M if hydroBCs==1*, 0, 500000, 0, C-M -**dtBdyPlaneBCs:** Delta in time (seconds) between BdyPlane sets *C-M if hydroBCs==1*, 0.0, 6e5, 0.0, C-M +**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; 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 diff --git a/docs/csv/hydro_core_canopy.csv b/docs/csv/hydro_core_canopy.csv index 08c219c..867a63b 100644 --- a/docs/csv/hydro_core_canopy.csv +++ b/docs/csv/hydro_core_canopy.csv @@ -1,4 +1,4 @@ -**canopySelector:** Canopy selector: 0=off; 1=on, 0, 1, 0, O -**canopySkinOpt:** Canopy selector to use additional skin friction effect on drag coefficient: 0=off; 1=on *C-M if canopySelector==1*, 0, 1, 0, C-M -**canopy_cd:** Non-dimensional canopy drag coefficient *C-M if canopySelector==1*, 0.0, 1e+2, 0.15, C-M -**canopy_lf:** Representative canopy element length scale *C-M if canopySelector==1*, 0.0, 1e+2, 0.1, C-M +**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 diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv index a766446..c4a0fca 100644 --- a/docs/csv/hydro_core_cell_perturbation.csv +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -1,11 +1,11 @@ -**cellpertSelector:** CP method selector: 0=off; 1=on, 0, 1, 0, O -**cellpert_nts:** Number of time steps after which perturbations are seeded, 0, 1e+6, 500, O -**cellpert_sw2b:** Only south and west bnds perturbed (for idealized cases): 0=off; 1=south & west; 2=south *C-O if cellpertSelector > 0*, 0, 3, 0, C-O -**cellpert_amp:** Maximum amplitude for the potential temperature perturbations *C-O if cellpertSelector > 0*, 0.0, 20.0, 0.5, C-O -**cellpert_gppc:** Number of grid points conforming the cell *C-O if cellpertSelector > 0*, 0, 50, 8, C-O -**cellpert_ndbc:** Number of cells normal to domain lateral boundaries *C-O if cellpertSelector > 0*, 0, 10, 3, C-O -**cellpert_kbottom:** Z-grid point where the perturbations start *C-O if cellpertSelector > 0*, 1, 10, 1, C-O -**cellpert_ktop:** Z-grid point where the perturbations end *C-O if cellpertSelector > 0*, 0, 200, 20, C-O -**cellpert_tvcp:** Time-varying CP method selector: 0=off; 1=on (hydroBCs==1) *C-O if cellpertSelector > 0*, 0, 1, 0, C-O -**cellpert_eckert:** Eckert number for the potential temperature perturbations (hydroBCs==1) *C-O if cellpertSelector > 0*, 0.0, 10.0, 0.2, C-O -**cellpert_tsfact:** Factor on the refreshing perturbation time scale (hydroBCs==1) *C-O if cellpertSelector > 0*, 0.0, 10.0, 1.0, C-O +**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 diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv index d57297e..57f1dc9 100644 --- a/docs/csv/hydro_core_coriolis.csv +++ b/docs/csv/hydro_core_coriolis.csv @@ -1,2 +1,2 @@ -**coriolisSelector:** Coriolis Force selector: 0=None; 1=Horizontal-only; 2=Horizontal & Vertical, 0, 2, 0, M -**coriolisLatitude:** Characteristic latitude in degrees from equator of the LES domain, -90.0, 90.0, 54.0, M \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv index ec87035..df0971c 100644 --- a/docs/csv/hydro_core_diffusion.csv +++ b/docs/csv/hydro_core_diffusion.csv @@ -1,2 +1,2 @@ -**diffusionSelector:** Diffusion term-type selector: 0=none; 1=constant; 2=scalar turbulent-diffusivity, 0, 1, 0, O -**nu_0:** Constant diffusivity used when diffusionSelector=1, 0, FLT_MAX, 1.0, O \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index f7d94a1..4707ca7 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,6 +1,6 @@ -**filterSelector:** Explicit filter selector: 0=off; 1=on, 0, 1, 0, O -**filter_6thdiff_vert:** Vertical 6th-order filter on w selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O -**filter_6thdiff_hori:** Horizontal 6th-order filter on rho; theta; qv selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O -**filter_6thdiff_vert_coeff:** Vertical 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_vert == 1*, 0.0, 1.0, 0.03, C-M -**filter_6thdiff_hori_coeff:** Horizontal 6th-order filter factor: 0.0=off; 1.0=full *C-M if filterSelector == 1 and filter_6thdiff_hori == 1*, 0.0, 1.0, 0.03, C-M -**filter_divdamp:** Divergence damping selector: 0=off; 1=on *C-O if filterSelector == 1*, 0, 1, 0, C-O \ No newline at end of file +**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 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 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 \ No newline at end of file diff --git a/docs/csv/hydro_core_io_logging.csv b/docs/csv/hydro_core_io_logging.csv index 40f6684..b27d1da 100644 --- a/docs/csv/hydro_core_io_logging.csv +++ b/docs/csv/hydro_core_io_logging.csv @@ -1,3 +1,3 @@ -**hydroForcingWrite:** Switch for writing output of hydroFldsFrhs for prognostic fields. 0=off; 1=on, 0, 1, 0, O -**hydroSubGridWrite:** Switch for writing output of SGS fields. 0=off; 1=on, 0, 1, 0, M -**hydroForcingLog:** Switch for logging Frhs min/max etc. 0=off; 1=on, 0, 1, 0, M \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_large_scale_forcings.csv b/docs/csv/hydro_core_large_scale_forcings.csv index 275c1e8..7422461 100644 --- a/docs/csv/hydro_core_large_scale_forcings.csv +++ b/docs/csv/hydro_core_large_scale_forcings.csv @@ -1,18 +1,18 @@ -**lsfSelector:** Large-scale forcings selector: 0=off; 1=on, 0, 1, 0, M -**lsf_horMnSubTerms:** Large-scale subsidence terms Switch 0=off 1=on *C-M if lsfSelector > 0*, 0, 1, 0, C-M -**lsf_freq:** Large-scale forcing frequency (seconds) *C-M if lsfSelector > 0*, 1e-3, 1e+3, 1.0, C-M -**lsf_w_surf:** Large-scale forcing to w at the surface *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_w_lev1:** Large-scale forcing to w at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_w_lev2:** Large-scale forcing to w at the second specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_w_zlev1:** Large-scale forcing to w height 1 *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M -**lsf_w_zlev2:** Large-scale forcing to w height 2 *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M -**lsf_th_surf:** Large-scale forcing to theta at the surface *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_th_lev1:** Large-scale forcing to theta at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_th_lev2:** Large-scale forcing to theta at the second specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_th_zlev1:** Large-scale forcing to theta height 1 *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M -**lsf_th_zlev2:** Large-scale forcing to theta height 2 *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M -**lsf_qv_surf:** Large-scale forcing to qv at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_qv_lev1:** Large-scale forcing to qv at the first specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_qv_lev2:** Large-scale forcing to qv at the second specified level *C-M if lsfSelector > 0*, -1e+4, 1e+4, 0.0, C-M -**lsf_qv_zlev1:** Large-scale forcing to qv height 1 *C-M if lsfSelector > 0*, 0.0, 1e+4, 100.0, C-M -**lsf_qv_zlev2:** Large-scale forcing to qv height 2 *C-M if lsfSelector > 0*, 0.0, 1e+4, 200.0, C-M \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_moisture.csv b/docs/csv/hydro_core_moisture.csv index b3b1482..69cc01b 100644 --- a/docs/csv/hydro_core_moisture.csv +++ b/docs/csv/hydro_core_moisture.csv @@ -1,10 +1,10 @@ -**moistureSelector:** Moisture selector: 0=off; 1=on, 0, 1, 0, M -**moistureNvars:** Number of moisture species *C-M if moistureSelector==1*, 0, 2, 0, C-M -**moistureAdvSelectorQv:** Water vapor advection scheme selector *C-M if moistureSelector==1*, 0, 6, 0, C-M -**moistureAdvSelectorQv_b:** Hybrid advection scheme parameter for water vapor *C-M if moistureSelector==1*, 0.0, 1.0, 0.0, C-M -**moistureAdvSelectorQi:** Moisture advection scheme selector for non-qv fields (non-oscillatory schemes) *C-M if moistureSelector==1*, 0, 2, 0, C-M -**moistureSGSturb:** Selector to apply sub-grid scale diffusion to moisture fields *C-M if moistureSelector==1*, 0, 1, 0, C-M -**moistureCond:** Selector to apply condensation to moisture fields *C-M if moistureSelector==1*, 1, 4, 1, C-M -**moistureCondTscale:** Relaxation time in seconds *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M -**moistureCondBasePres:** Selector to use base pressure for microphysics *C-M if moistureSelector==1*, 0, 1, 0, C-M -**moistureMPcallTscale:** Time scale for microphysics to be called *C-M if moistureSelector==1*, 1e-4, 1000.0, 1.0, C-M +**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 diff --git a/docs/csv/hydro_core_rayleigh_damping_layer.csv b/docs/csv/hydro_core_rayleigh_damping_layer.csv index f9b3751..fd8b745 100644 --- a/docs/csv/hydro_core_rayleigh_damping_layer.csv +++ b/docs/csv/hydro_core_rayleigh_damping_layer.csv @@ -1,2 +1,2 @@ -**dampingLayerSelector:** Rayleigh Damping Layer selector, 0, 1, 0, O -**dampingLayerDepth:** Rayleigh Damping Layer Depth; *C-O if dampingLayerSelector==1*, 0.0, FLT_MAX, 100.0, C-O +**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 diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index a2543aa..99d57aa 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -1,24 +1,24 @@ -**surflayerSelector:** Monin-Obukhov surface layer selector: 0=off; 1=surface kinematic heat flux (surflayer_wth); 2=skin temperature rate (surflayer_tr), 0, 3, 0, M -**surflayer_z0:** Roughness length (momentum) when surflayerSelector > 0, 1e-12, 1e+0, 0.1, M -**surflayer_z0t:** Roughness length (temperature) when surflayerSelector > 0, 1e-6, 1e+1, 0.1, M -**surflayer_z0tdyn:** Dynamic z0t calculation following Zilitinkevich (1995) approach: 0= off 1= constant Zilitinkevich coeff 2=variable Zilitinkevich coeff, 0, 2, 1, O -**surflayer_wth:** Kinematic sensible heat flux at the surface *C-M if surflayerSelector==1*, -5e+0, 5e+0, 0.0, C-M -**surflayer_tr:** Temperature rate at the surface *C-M if surflayerSelector==2* (>0 for warming; <0 for cooling), -1e+1, 1e+1, 0.0, C-M -**surflayer_wq:** Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 *C-M if moistureSelector==1*, -5e+0, 5e+0, 0.0, C-M -**surflayer_qr:** Water vapor rate (kg/kg h-1) when surflayer Selector = 2 *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M -**surflayer_idealsine:** Selector for idealized sinusoidal surface heat flux or skin temperature forcing, 0, 1, 0, O -**surflayer_ideal_ts:** Start time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**surflayer_ideal_te:** End time in seconds for the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**surflayer_ideal_amp:** Maximum amplitude of the idealized sinusoidal surface forcing *C-M if surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M -**surflayer_ideal_qts:** Start time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**surflayer_ideal_qte:** End time in seconds for the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**surflayer_ideal_qamp:** Maximum amplitude of the idealized sinusoidal surface forcing (qv) *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M -**surflayer_qskin_input:** Selector for file input (restart) value for qskin under surflayerSelector == 2 *C-O if moistureSelector==1*, 0, 1, 0, C-O -**surflayer_offshore:** Offshore selector: 0=off;1=on, 0, 1, 1, O -**surflayer_offshore_visc:** Viscous term on z0m: 0=off; 1=on, 0, 1, 1, O -**surflayer_offshore_opt:** Offshore roughness parameterization: ==0 (Charnock); ==1 (Charnock with variable alpha); ==2 (Taylor & Yelland); ==3 (Donelan); ==4 (Drennan); ==5 (Porchetta) *C-M if surflayer_offshore > 0*, 0, 5, 4, O -**surflayer_offshore_dyn:** Selector to use parameterized ocean parameters: 0=off; 1=on *C-O if surflayer_offshore > 0*, 0, 1, 1, C-O -**surflayer_offshore_hs:** Significant wave height *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2; 3; 4; or 5*, 0, 1e+2, 0.0, C-M -**surflayer_offshore_lp:** Peak wavelength *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 2*, 0.1, 1e+3, 0.1, C-M -**surflayer_offshore_cp:** Wave phase speed *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 3; 4; or 5*, 0.1, 1e+2, 0.1, C-M -**surflayer_offshore_theta:** Wave/wind angle *C-M if surflayer_offshore > 0 and surflayer_offshore_dyn == 0 and surflayer_offshore_opt == 5 or surflayer_offshore > 0 and surflayer_offshore_dyn==1 and surflayer_offshore_opt == 5*, 0.0, 180.0, 0.0, C-M \ No newline at end of file +**surflayerSelector:** |br| Monin-Obukhov surface layer selector: |br| 0=off; |br| 1=surface kinematic heat flux (surflayer_wth); |br| 2=skin temperature rate (surflayer_tr), 0, 3, 0, M +**surflayer_z0:** |br| Roughness length (momentum) when surflayerSelector > 0, 1e-12, 1e+0, 0.1, M +**surflayer_z0t:** |br| Roughness length (temperature) when surflayerSelector > 0, 1e-6, 1e+1, 0.1, M +**surflayer_z0tdyn:** |br| Dynamic z0t calculation following Zilitinkevich (1995) approach: |br| 0=off |br| 1=constant Zilitinkevich coeff |br| 2=variable Zilitinkevich coeff, 0, 2, 1, O +**surflayer_wth:** |br| Kinematic sensible heat flux at the surface |br| *C-M if surflayerSelector==1*, -5e+0, 5e+0, 0.0, C-M +**surflayer_tr:** |br| Temperature rate at the surface |br| *C-M if surflayerSelector==2* |br| (>0 for warming; <0 for cooling), -1e+1, 1e+1, 0.0, C-M +**surflayer_wq:** |br| Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 |br| *C-M if moistureSelector==1*, -5e+0, 5e+0, 0.0, C-M +**surflayer_qr:** |br| Water vapor rate (kg/kg h-1) when surflayer Selector = 2 |br| *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M +**surflayer_idealsine:** |br| Selector for idealized sinusoidal surface heat flux or skin temperature forcing, 0, 1, 0, O +**surflayer_ideal_ts:** |br| Start time in seconds for the idealized sinusoidal surface forcing |br| *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_te:** |br| End time in seconds for the idealized sinusoidal surface forcing |br| *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_amp:** |br| Maximum amplitude of the idealized sinusoidal surface forcing |br| *C-M if surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M +**surflayer_ideal_qts:** |br| Start time in seconds for the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_qte:** |br| End time in seconds for the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_qamp:** |br| Maximum amplitude of the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M +**surflayer_qskin_input:** |br| Selector for file input (restart) value for qskin under surflayerSelector == 2 |br| *C-O if moistureSelector==1*, 0, 1, 0, C-O +**surflayer_offshore:** |br| Offshore selector: |br| 0=off;1=on, 0, 1, 1, O +**surflayer_offshore_visc:** |br| Viscous term on z0m: |br| 0=off; 1=on, 0, 1, 1, O +**surflayer_offshore_opt:** |br| Offshore roughness parameterization: |br| ==0 (Charnock); |br| ==1 (Charnock with variable alpha); |br| ==2 (Taylor & Yelland); |br| ==3 (Donelan); |br| ==4 (Drennan); |br| ==5 (Porchetta) |br| *C-M if surflayer_offshore > 0*, 0, 5, 4, O +**surflayer_offshore_dyn:** |br| Selector to use parameterized ocean parameters: |br| 0=off; 1=on |br| *C-O if surflayer_offshore > 0*, 0, 1, 1, C-O +**surflayer_offshore_hs:** |br| Significant wave height |br| *C-M if surflayer_offshore > 0 and* |br| *surflayer_offshore_dyn == 0 and* |br| *surflayer_offshore_opt == 2 or 3 or 4 or 5*, 0, 1e+2, 0.0, C-M +**surflayer_offshore_lp:** |br| Peak wavelength |br| *C-M if surflayer_offshore > 0 and* |br| *surflayer_offshore_dyn == 0 and* |br| *surflayer_offshore_opt == 2*, 0.1, 1e+3, 0.1, C-M +**surflayer_offshore_cp:** |br| Wave phase speed |br| *C-M if surflayer_offshore > 0 and* |br| *surflayer_offshore_dyn == 0 and* |br| *surflayer_offshore_opt == 3 or 4 or 5*, 0.1, 1e+2, 0.1, C-M +**surflayer_offshore_theta:** |br| Wave/wind angle |br| *C-M if surflayer_offshore > 0 and* |br| *surflayer_offshore_dyn == 0 and* |br| *surflayer_offshore_opt == 5 or* |br| *surflayer_offshore > 0 and* |br| *surflayer_offshore_dyn==1 and* |br| *surflayer_offshore_opt == 5*, 0.0, 180.0, 0.0, C-M \ No newline at end of file diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv index 3872258..2ca83b1 100644 --- a/docs/csv/hydro_core_turbulence.csv +++ b/docs/csv/hydro_core_turbulence.csv @@ -1,6 +1,6 @@ -**turbulenceSelector:** Turbulence scheme selector: 0=None; 1=Lilly/Smagorinsky, 0, 1, 0, M -**TKESelector:** Prognostic TKE selector: 0=None; 1=Prognostic; 2=requires canopySelector=1, 0, 2, 1, O -**TKEAdvSelector:** SGSTKE advection selector, 0, 6, 0, O -**TKEAdvSelector_b_hyb:** Hybrid advection scheme parameter, 0.0, 1.0, 0.0, O -**c_s:** Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0, 1e-6, 1e6, 0.18, O -**c_k:** Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0, 1e-6, 1e6, 0.10, O \ No newline at end of file +**turbulenceSelector:** |br| Turbulence scheme selector: |br| 0=None; |br| 1=Lilly/Smagorinsky, 0, 1, 0, M +**TKESelector:** |br| Prognostic TKE selector: |br| 0=None; |br| 1=Prognostic; |br| 2=requires canopySelector=1, 0, 2, 1, O +**TKEAdvSelector:** |br| SGSTKE advection selector, 0, 6, 0, O +**TKEAdvSelector_b_hyb:** |br| Hybrid advection scheme parameter, 0.0, 1.0, 0.0, O +**c_s:** |br| Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0, 1e-6, 1e6, 0.18, O +**c_k:** |br| Lilly turbulence model constant used for turbulenceSelector=1 with TKESelector>0, 1e-6, 1e6, 0.10, O \ No newline at end of file diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index ca98bbf..04b2e2c 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,4 @@ -**timeMethod:** Selector for time integration method. [0=RK3-WS2002 (default)], 0, 0, 0, O -**Nt:** Number of timesteps to perform, 1, INT_MAX, 1000, M -**dt:** Timestep resolution in seconds, FLT_MIN, FLT_MAX, 1.0, M -**NtBatch:** Number of timesteps to compute in batch launch; must have NtBatch <= Nt; should be equal to or a factor of frqOutput, 1, Nt, 1, M \ No newline at end of file +**timeMethod:** |br| Selector for time integration method. |br| [0=RK3-WS2002 (default)], 0, 0, 0, O +**Nt:** |br| Number of timesteps to perform, 1, INT_MAX, 1000, M +**dt:** |br| Timestep resolution in seconds, FLT_MIN, FLT_MAX, 1.0, M +**NtBatch:** |br| Number of timesteps to compute in batch launch; |br| must have NtBatch <= Nt; |br| should be equal to or a factor of frqOutput, 1, Nt, 1, M \ No newline at end of file From 52ee447032246632b8b3cc4f2d66432109fe89e6 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 13:32:09 -0600 Subject: [PATCH 56/65] Per #91, make formatting consistent and cleaner --- docs/csv/extensions_gad.csv | 2 +- docs/csv/grid.csv | 12 ++++++------ docs/csv/hydro_core_advection.csv | 4 ++-- docs/csv/hydro_core_auxiliary_scalars.csv | 18 +++++++++--------- docs/csv/hydro_core_base_state.csv | 2 +- docs/csv/hydro_core_boundary_cond.csv | 2 +- docs/csv/hydro_core_cell_perturbation.csv | 2 +- docs/csv/hydro_core_coriolis.csv | 2 +- docs/csv/hydro_core_diffusion.csv | 2 +- docs/csv/hydro_core_explicit_filters.csv | 4 ++-- docs/csv/hydro_core_surface_layer.csv | 12 ++++++------ docs/csv/hydro_core_turbulence.csv | 4 ++-- docs/csv/time_integration.csv | 2 +- 13 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/csv/extensions_gad.csv b/docs/csv/extensions_gad.csv index b1904b2..dc3d6ee 100644 --- a/docs/csv/extensions_gad.csv +++ b/docs/csv/extensions_gad.csv @@ -2,7 +2,7 @@ **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 +**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 diff --git a/docs/csv/grid.csv b/docs/csv/grid.csv index 9b23ddb..3c8139c 100644 --- a/docs/csv/grid.csv +++ b/docs/csv/grid.csv @@ -1,12 +1,12 @@ -**Nx:** |br| Number of discretised domain elements in the x (zonal) direction, 1, INT_MAX, 128, M -**Ny:** |br| Number of discretised domain elements in the y (meridional) direction, 1, INT_MAX, 122, M -**Nz:** |br| Number of discretised domain elements in the z (vertical) direction, 1, INT_MAX, 122, M -**Nh:** |br| Number of halo cells to be used (dependent on largest stencil extent), 0, INT_MAX, 3, M +**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 (surface elevation in meters ASL), N/A, N/A, , O +**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; 1.0=no compression), 0.0, 1.0, , 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 diff --git a/docs/csv/hydro_core_advection.csv b/docs/csv/hydro_core_advection.csv index 5a99c2d..1cbde96 100644 --- a/docs/csv/hydro_core_advection.csv +++ b/docs/csv/hydro_core_advection.csv @@ -1,2 +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 \ No newline at end of file +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 9cd34d7..9be7128 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -3,12 +3,12 @@ **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 NhydroAuxScalars == 1*, 0, 1, 0, C-M -**srcAuxScStartSeconds:** |br| Source start time in seconds |br| *C-M if srcAuxScFile == NULL and NhydroAuxScalars == 1*, 0, FLT_MAX, 0, C-M -**srcAuxScDurationSeconds:** |br| Source duration in seconds |br| *C-M if srcAuxScFile == NULL and 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 NhydroAuxScalars == 1*, 0, 0, 0, C-M -**srcAuxScMassSpecType:** |br| Mass specification type 0=strict mass in kg; 1=mass source rate in kg/s |br| *C-M if srcAuxScFile == NULL and 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 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 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 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 NhydroAuxScalars == 1*, -FLT_MAX, FLT_MAX, 0.0, C-M \ No newline at end of file +**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 0=strict mass in kg; 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 \ No newline at end of file diff --git a/docs/csv/hydro_core_base_state.csv b/docs/csv/hydro_core_base_state.csv index 2d1ff4a..12c76a9 100644 --- a/docs/csv/hydro_core_base_state.csv +++ b/docs/csv/hydro_core_base_state.csv @@ -1,4 +1,4 @@ -**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 +**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 diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index cad1a6f..ff36a8e 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,5 +1,5 @@ **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; 1=non-zero w-BC), 0, 1, 0, O +**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 diff --git a/docs/csv/hydro_core_cell_perturbation.csv b/docs/csv/hydro_core_cell_perturbation.csv index c4a0fca..2c1f41a 100644 --- a/docs/csv/hydro_core_cell_perturbation.csv +++ b/docs/csv/hydro_core_cell_perturbation.csv @@ -1,6 +1,6 @@ **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_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 diff --git a/docs/csv/hydro_core_coriolis.csv b/docs/csv/hydro_core_coriolis.csv index 57f1dc9..df3f070 100644 --- a/docs/csv/hydro_core_coriolis.csv +++ b/docs/csv/hydro_core_coriolis.csv @@ -1,2 +1,2 @@ -**coriolisSelector:** |br| Coriolis Force selector: |br| 0=None; |br| 1=Horizontal-only; |br| 2=Horizontal & Vertical, 0, 2, 0, M +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_diffusion.csv b/docs/csv/hydro_core_diffusion.csv index df0971c..0b1cc1a 100644 --- a/docs/csv/hydro_core_diffusion.csv +++ b/docs/csv/hydro_core_diffusion.csv @@ -1,2 +1,2 @@ -**diffusionSelector:** |br| Diffusion term-type selector: |br| 0=none; |br| 1=constant; |br| 2=scalar turbulent-diffusivity, 0, 1, 0, O +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_explicit_filters.csv b/docs/csv/hydro_core_explicit_filters.csv index 4707ca7..eabfd0b 100644 --- a/docs/csv/hydro_core_explicit_filters.csv +++ b/docs/csv/hydro_core_explicit_filters.csv @@ -1,6 +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 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 filter_6thdiff_hori == 1*, 0.0, 1.0, 0.03, C-M +**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 \ No newline at end of file diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index 99d57aa..8d5d82f 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -1,22 +1,22 @@ -**surflayerSelector:** |br| Monin-Obukhov surface layer selector: |br| 0=off; |br| 1=surface kinematic heat flux (surflayer_wth); |br| 2=skin temperature rate (surflayer_tr), 0, 3, 0, M +**surflayerSelector:** |br| Monin-Obukhov surface layer selector: |br| 0=off |br| 1=surface kinematic heat flux (surflayer_wth) |br| 2=skin temperature rate (surflayer_tr), 0, 3, 0, M **surflayer_z0:** |br| Roughness length (momentum) when surflayerSelector > 0, 1e-12, 1e+0, 0.1, M **surflayer_z0t:** |br| Roughness length (temperature) when surflayerSelector > 0, 1e-6, 1e+1, 0.1, M **surflayer_z0tdyn:** |br| Dynamic z0t calculation following Zilitinkevich (1995) approach: |br| 0=off |br| 1=constant Zilitinkevich coeff |br| 2=variable Zilitinkevich coeff, 0, 2, 1, O **surflayer_wth:** |br| Kinematic sensible heat flux at the surface |br| *C-M if surflayerSelector==1*, -5e+0, 5e+0, 0.0, C-M **surflayer_tr:** |br| Temperature rate at the surface |br| *C-M if surflayerSelector==2* |br| (>0 for warming; <0 for cooling), -1e+1, 1e+1, 0.0, C-M **surflayer_wq:** |br| Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 |br| *C-M if moistureSelector==1*, -5e+0, 5e+0, 0.0, C-M -**surflayer_qr:** |br| Water vapor rate (kg/kg h-1) when surflayer Selector = 2 |br| *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M +**surflayer_qr:** |br| Water vapor rate (kg/kg h-1) when surflayerSelector = 2 |br| *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M **surflayer_idealsine:** |br| Selector for idealized sinusoidal surface heat flux or skin temperature forcing, 0, 1, 0, O **surflayer_ideal_ts:** |br| Start time in seconds for the idealized sinusoidal surface forcing |br| *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M **surflayer_ideal_te:** |br| End time in seconds for the idealized sinusoidal surface forcing |br| *C-M if surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M **surflayer_ideal_amp:** |br| Maximum amplitude of the idealized sinusoidal surface forcing |br| *C-M if surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M -**surflayer_ideal_qts:** |br| Start time in seconds for the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**surflayer_ideal_qte:** |br| End time in seconds for the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M -**surflayer_ideal_qamp:** |br| Maximum amplitude of the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M +**surflayer_ideal_qts:** |br| Start time in seconds for the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and* |br| *surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_qte:** |br| End time in seconds for the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and* |br| *surflayer_idealsine > 0*, 0, 1e+5, 0.0, C-M +**surflayer_ideal_qamp:** |br| Maximum amplitude of the idealized sinusoidal surface forcing (qv) |br| *C-M if moistureSelector==1 and* |br| *surflayer_idealsine > 0*, 0, 1e+3, 0.1, C-M **surflayer_qskin_input:** |br| Selector for file input (restart) value for qskin under surflayerSelector == 2 |br| *C-O if moistureSelector==1*, 0, 1, 0, C-O **surflayer_offshore:** |br| Offshore selector: |br| 0=off;1=on, 0, 1, 1, O **surflayer_offshore_visc:** |br| Viscous term on z0m: |br| 0=off; 1=on, 0, 1, 1, O -**surflayer_offshore_opt:** |br| Offshore roughness parameterization: |br| ==0 (Charnock); |br| ==1 (Charnock with variable alpha); |br| ==2 (Taylor & Yelland); |br| ==3 (Donelan); |br| ==4 (Drennan); |br| ==5 (Porchetta) |br| *C-M if surflayer_offshore > 0*, 0, 5, 4, O +**surflayer_offshore_opt:** |br| Offshore roughness parameterization: |br| ==0 (Charnock) |br| ==1 (Charnock with variable alpha) |br| ==2 (Taylor & Yelland) |br| ==3 (Donelan) |br| ==4 (Drennan) |br| ==5 (Porchetta) |br| *C-M if surflayer_offshore > 0*, 0, 5, 4, O **surflayer_offshore_dyn:** |br| Selector to use parameterized ocean parameters: |br| 0=off; 1=on |br| *C-O if surflayer_offshore > 0*, 0, 1, 1, C-O **surflayer_offshore_hs:** |br| Significant wave height |br| *C-M if surflayer_offshore > 0 and* |br| *surflayer_offshore_dyn == 0 and* |br| *surflayer_offshore_opt == 2 or 3 or 4 or 5*, 0, 1e+2, 0.0, C-M **surflayer_offshore_lp:** |br| Peak wavelength |br| *C-M if surflayer_offshore > 0 and* |br| *surflayer_offshore_dyn == 0 and* |br| *surflayer_offshore_opt == 2*, 0.1, 1e+3, 0.1, C-M diff --git a/docs/csv/hydro_core_turbulence.csv b/docs/csv/hydro_core_turbulence.csv index 2ca83b1..d3a7181 100644 --- a/docs/csv/hydro_core_turbulence.csv +++ b/docs/csv/hydro_core_turbulence.csv @@ -1,5 +1,5 @@ -**turbulenceSelector:** |br| Turbulence scheme selector: |br| 0=None; |br| 1=Lilly/Smagorinsky, 0, 1, 0, M -**TKESelector:** |br| Prognostic TKE selector: |br| 0=None; |br| 1=Prognostic; |br| 2=requires canopySelector=1, 0, 2, 1, O +**turbulenceSelector:** |br| Turbulence scheme selector: |br| 0=None |br| 1=Lilly/Smagorinsky, 0, 1, 0, M +**TKESelector:** |br| Prognostic TKE selector: |br| 0=None |br| 1=Prognostic |br| 2=requires canopySelector=1, 0, 2, 1, O **TKEAdvSelector:** |br| SGSTKE advection selector, 0, 6, 0, O **TKEAdvSelector_b_hyb:** |br| Hybrid advection scheme parameter, 0.0, 1.0, 0.0, O **c_s:** |br| Smagorinsky turbulence model constant used for turbulenceSelector=1 with TKESelector=0, 1e-6, 1e6, 0.18, O diff --git a/docs/csv/time_integration.csv b/docs/csv/time_integration.csv index 04b2e2c..62f0494 100644 --- a/docs/csv/time_integration.csv +++ b/docs/csv/time_integration.csv @@ -1,4 +1,4 @@ **timeMethod:** |br| Selector for time integration method. |br| [0=RK3-WS2002 (default)], 0, 0, 0, O **Nt:** |br| Number of timesteps to perform, 1, INT_MAX, 1000, M **dt:** |br| Timestep resolution in seconds, FLT_MIN, FLT_MAX, 1.0, M -**NtBatch:** |br| Number of timesteps to compute in batch launch; |br| must have NtBatch <= Nt; |br| should be equal to or a factor of frqOutput, 1, Nt, 1, M \ No newline at end of file +**NtBatch:** |br| Number of timesteps to compute in batch launch |br| Must have NtBatch <= Nt |br| Should be equal to or a factor of frqOutput, 1, Nt, 1, M \ No newline at end of file From ffe8b249d4a5d25a9c54e82bf1b7cd8859abd17f Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 13:33:51 -0600 Subject: [PATCH 57/65] Per #91, make formatting consistent and cleaner --- docs/csv/hydro_core_boundary_cond.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index ff36a8e..f507463 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,4 +1,4 @@ -**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 +**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 From cb050e54953e8d318e550e8f9218d7b01f1729f0 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:21:12 -0600 Subject: [PATCH 58/65] Per #91, cleaned up formatting and modified order of TOC --- docs/csv/extensions_urban.csv | 2 +- docs/csv/hydro_core_auxiliary_scalars.csv | 4 ++-- docs/csv/hydro_core_surface_layer.csv | 2 +- docs/csv/io.csv | 4 ++-- docs/index.rst | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/csv/extensions_urban.csv b/docs/csv/extensions_urban.csv index 02b9a7f..12b7743 100644 --- a/docs/csv/extensions_urban.csv +++ b/docs/csv/extensions_urban.csv @@ -1,4 +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 +**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 diff --git a/docs/csv/hydro_core_auxiliary_scalars.csv b/docs/csv/hydro_core_auxiliary_scalars.csv index 9be7128..6e6d947 100644 --- a/docs/csv/hydro_core_auxiliary_scalars.csv +++ b/docs/csv/hydro_core_auxiliary_scalars.csv @@ -6,8 +6,8 @@ **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 0=strict mass in kg; 1=mass source rate in kg/s |br| *C-M if srcAuxScFile == NULL and* |br| *NhydroAuxScalars == 1*, 0, 0, 0, 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 diff --git a/docs/csv/hydro_core_surface_layer.csv b/docs/csv/hydro_core_surface_layer.csv index 8d5d82f..dda6d2b 100644 --- a/docs/csv/hydro_core_surface_layer.csv +++ b/docs/csv/hydro_core_surface_layer.csv @@ -3,7 +3,7 @@ **surflayer_z0t:** |br| Roughness length (temperature) when surflayerSelector > 0, 1e-6, 1e+1, 0.1, M **surflayer_z0tdyn:** |br| Dynamic z0t calculation following Zilitinkevich (1995) approach: |br| 0=off |br| 1=constant Zilitinkevich coeff |br| 2=variable Zilitinkevich coeff, 0, 2, 1, O **surflayer_wth:** |br| Kinematic sensible heat flux at the surface |br| *C-M if surflayerSelector==1*, -5e+0, 5e+0, 0.0, C-M -**surflayer_tr:** |br| Temperature rate at the surface |br| *C-M if surflayerSelector==2* |br| (>0 for warming; <0 for cooling), -1e+1, 1e+1, 0.0, C-M +**surflayer_tr:** |br| Temperature rate at the surface |br| (>0 for warming; <0 for cooling) |br| *C-M if surflayerSelector==2*, -1e+1, 1e+1, 0.0, C-M **surflayer_wq:** |br| Sensible heat flux at the surface (kg/kg m s-1) when surflayerSelector = 1 |br| *C-M if moistureSelector==1*, -5e+0, 5e+0, 0.0, C-M **surflayer_qr:** |br| Water vapor rate (kg/kg h-1) when surflayerSelector = 2 |br| *C-M if moistureSelector==1*, -1e+1, 1e+1, 0.0, C-M **surflayer_idealsine:** |br| Selector for idealized sinusoidal surface heat flux or skin temperature forcing, 0, 1, 0, O diff --git a/docs/csv/io.csv b/docs/csv/io.csv index ed85dc6..aef145b 100644 --- a/docs/csv/io.csv +++ b/docs/csv/io.csv @@ -2,5 +2,5 @@ **inFile:** |br| Name of the input file for coordinate system and initial or restart conditions, N/A, N/A, , O **outPath:** |br| Path where output files are to be written, N/A, N/A, , M **outFileBase:** |br| Base name of the output file series as in (outFileBase).element-in-series, N/A, N/A, , M -**frqOutput:** |br| Frequency (in timesteps) at which to produce output; should be an even multiple of NtBatch, 0, INT_MAX, , M -**ioOutputMode:** |br| 0: N-to-1 gather and write to a netcdf file; |br| 1: N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file +**frqOutput:** |br| Frequency (in timesteps) at which to produce output |br| Should be an even multiple of NtBatch, 0, INT_MAX, , M +**ioOutputMode:** |br| 0: N-to-1 gather and write to a netcdf file |br| 1: N-to-N writes of FastEddy binary files, 0, 1, 0, O \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 34f89db..35017df 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -53,8 +53,8 @@ web: https://fluidnumerics.com, email: support@fluidnumerics.com :hidden: release_notes.rst - build_run.rst - parameters.rst downloads.rst + build_run.rst Tutorials/index + parameters.rst publications.rst From 911918365651fea49dcdb5051302f8366a25105f Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:23:15 -0600 Subject: [PATCH 59/65] Per #91, added default values --- docs/csv/fecuda.csv | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/csv/fecuda.csv b/docs/csv/fecuda.csv index 65e2818..1dc51cd 100644 --- a/docs/csv/fecuda.csv +++ b/docs/csv/fecuda.csv @@ -1,3 +1,3 @@ -**tBx:** |br| Number of threads in x-dimension, 1, INT_MAX, , M -**tBy:** |br| Number of threads in y-dimension, 1, INT_MAX, , M -**tBz:** |br| Number of threads in z-dimension, 1, INT_MAX, , M \ No newline at end of file +**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 \ No newline at end of file From 05132b2d9ebf155fd59d7e161aedbe4c8ff00fe4 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:29:00 -0600 Subject: [PATCH 60/65] Per #91, attempting to make the conditional statements darker grey --- docs/_static/custom.css | 11 +++++++---- docs/csv/hydro_core_boundary_cond.csv | 8 ++++---- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 0a4b08e..01aa6e6 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -48,7 +48,10 @@ .longtable td:nth-child(5), .longtable th:nth-child(5) { width: 4% !important; } /* Mandatory/Optional */ -/* -.longtable td:nth-child(6), -.longtable th:nth-child(6) { width: 31% !important; } /* Description */ -*/ +/* Custom color for conditional text */ +.conditional-text { + color: #666666; /* or your preferred color */ + font-style: italic; +} + + diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index f507463..15af808 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,6 +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 +**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 From e34a9dba1b932976eb7097bf3cc1db4037a37f4e Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:37:47 -0600 Subject: [PATCH 61/65] Per #91, attempt #2 at coloring the conditionals --- docs/_static/custom.css | 7 ++++--- docs/csv/hydro_core_boundary_cond.csv | 8 ++++---- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 01aa6e6..5033ed0 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -48,9 +48,10 @@ .longtable td:nth-child(5), .longtable th:nth-child(5) { width: 4% !important; } /* Mandatory/Optional */ -/* Custom color for conditional text */ -.conditional-text { - color: #666666; /* or your preferred color */ +/* Style italic text in first column only */ +.longtable td:nth-child(1) em, +.longtable th:nth-child(1) em { + color: #666666; font-style: italic; } diff --git a/docs/csv/hydro_core_boundary_cond.csv b/docs/csv/hydro_core_boundary_cond.csv index 15af808..f507463 100644 --- a/docs/csv/hydro_core_boundary_cond.csv +++ b/docs/csv/hydro_core_boundary_cond.csv @@ -1,6 +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 +**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 From e9d1ea2690456dd1e65ddfdc8e2ee21ad28787e7 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:54:15 -0600 Subject: [PATCH 62/65] Per #91, trying a new color --- docs/_static/custom.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 5033ed0..9e3d97e 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -51,7 +51,7 @@ /* Style italic text in first column only */ .longtable td:nth-child(1) em, .longtable th:nth-child(1) em { - color: #666666; + color: #222222; font-style: italic; } From a9d49032d73285d562305817c91f8c910632e021 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:55:23 -0600 Subject: [PATCH 63/65] Per #91, trying a new color --- docs/_static/custom.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 9e3d97e..39e08e2 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -51,7 +51,7 @@ /* Style italic text in first column only */ .longtable td:nth-child(1) em, .longtable th:nth-child(1) em { - color: #222222; + color: #2a2a2a; font-style: italic; } From cc590001910ce91534cb54a5081810e70645f461 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:56:21 -0600 Subject: [PATCH 64/65] Per #91, trying a new color --- docs/_static/custom.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 39e08e2..5991c87 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -51,7 +51,7 @@ /* Style italic text in first column only */ .longtable td:nth-child(1) em, .longtable th:nth-child(1) em { - color: #2a2a2a; + color: #1a1a1a; font-style: italic; } From 670c83cf0d7dd676039aa54767c592433e5a1d90 Mon Sep 17 00:00:00 2001 From: jprestop Date: Tue, 14 Oct 2025 14:58:06 -0600 Subject: [PATCH 65/65] Per #91, trying a new color blue --- docs/_static/custom.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 5991c87..5891984 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -51,7 +51,7 @@ /* Style italic text in first column only */ .longtable td:nth-child(1) em, .longtable th:nth-child(1) em { - color: #1a1a1a; + color: #1e6ba6; font-style: italic; }