diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
index af8311b67b..67e274a9e2 100644
--- a/_sources/index.rst.txt
+++ b/_sources/index.rst.txt
@@ -26,9 +26,10 @@ development effort. As with other codes in the
`Exawind `_ ecosystem, AMR-wind shares the following
objectives:
-- an open, well-documented implementation of the state-of-the-art computational
- models for modeling wind farm flow physics at various fidelities that are
- backed by a comprehensive verification and validation (V&V) process;
+- an open, well-documented implementation of the state-of-the-art
+ computational models for modeling wind farm flow physics at various
+ fidelities that are backed by a comprehensive verification and
+ validation (V&V) process (:ref:`capabilities`);
- be capable of performing the highest-fidelity simulations of flowfields within
wind farms; and
diff --git a/_sources/theory/theory.rst.txt b/_sources/theory/theory.rst.txt
index 9569388e0c..0be45564aa 100644
--- a/_sources/theory/theory.rst.txt
+++ b/_sources/theory/theory.rst.txt
@@ -1,8 +1,10 @@
Theory Manual
-================================
+=============
+
+.. _governing_equations:
Governing equations
-------------------------------------
+-------------------
Conservation of fluid mass:
@@ -21,11 +23,19 @@ Tracer(s) advection:
.. math:: \frac{\partial \rho s}{\partial t} + \nabla \cdot (\rho U s) = 0
-Discretization
--------------------------------------
-The numerical methdology used to solve the partial differential equations (PDEs)
-within AMR-Wind is documented in `Almgren et al. (JCP 1998)
-`_.
+.. _discretization:
+
+Discretization
+--------------
+
+The numerical methdology used to solve the partial differential
+equations (PDEs) within AMR-Wind is documented in `Almgren et
+al. (JCP 1998)
+`_. AMR-Wind uses
+`AMReX-Hydro
+`_
+for many advection routines. The reader is referred to their
+documentation for implementation details.
Time Step -- MOL
~~~~~~~~~~~~~~~~
@@ -135,8 +145,10 @@ Often for simulations involving walls, (e.g., channel flows, complex terrains et
mapping.rst
+.. _multiphase:
+
Multiphase flow modelling
-------------------------------------
+-------------------------
AMR-Wind employs the volume-of-fluid method for simulating two-phase (water-air) flows.
More specifically, the volume fraction field is advected explicitly using a
@@ -148,8 +160,10 @@ is not modeled by AMR-Wind currently. For further detail, see
`Kuhn, Deskos, Sprague (Computers & Fluids 2023)
`_.
+.. _source_terms:
+
Source terms
-------------------------------------
+------------
Gravity Forcing
~~~~~~~~~~~~~~~~
@@ -174,6 +188,7 @@ Using the perturbational form implies that the hydrostatic pressure is removed f
.. math:: p = p' - \int_z^{z_{max}} \rho_0 g dz + p(z = z_{max}) = p' - \int_z^{z_{max}} \rho_0 g dz
+.. _mesoscale_forcing:
Mesoscale Forcing
~~~~~~~~~~~~~~~~~
@@ -196,17 +211,12 @@ approach can be used with NWP model output or observational data. For more
information, see `Allaerts et al. (BLM 2020)
`_
-The application of these forcing approaches is detailed in:
-
-.. toctree::
- :glob:
- :maxdepth: 2
-
- ../user/inputs_ABL_meso_forcing.rst
+The application of these forcing approaches is detailed :ref:`here `.
+.. _turbulence:
Turbulence Models
------------------------------
+-----------------
LES models for subgrid scales
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -306,11 +316,13 @@ length scale is modified as follows
Here the term :math:`H=1.5 dz` specifies the location at which the length scale switches to :math:`L=C_s\Delta` and :math:`\phi_M`
is the atmospheric stability function. Currently, the implementation for the stability function uses a single global value.
The implementation of the non-linear model is split into two parts. The subgrid-scale viscosity term is directly used
-within the ``AMR-wind`` diffusion framework. The last two terms in :math:`M_{ij}` are added as source-terms in the momentum equation.
+within the ``AMR-Wind`` diffusion framework. The last two terms in :math:`M_{ij}` are added as source-terms in the momentum equation.
+
+.. _wall_models:
Wall models
-----------
-The wall models described in this section are implemented in ``AMR-wind`` for
+The wall models described in this section are implemented in ``AMR-Wind`` for
running wall-bounded flows (non-ABL cases).
Log-law wall model
@@ -329,7 +341,7 @@ Given a horizontal velocity magnitude
:math:`z = z_{\mathrm{ref}}`, :math:`u_\tau` can be computed using a
non-linear solve to satisfy `[eq:loglaw] <#eq:loglaw>`__.
-In ``AMR-wind`` Newton-Raphson iterations are used with a convergence
+In ``AMR-Wind`` Newton-Raphson iterations are used with a convergence
criterion of :math:`\lvert u_\tau^{n+1} - u_\tau^n \rvert < 10^{-5}`.
For this, derivative of
:math:`\frac{\partial u_{\mathrm{mag}}}{\partial {u_\tau}}` is used,
diff --git a/_sources/user/build.rst.txt b/_sources/user/build.rst.txt
index 81391ed75e..7fd7eda3fd 100644
--- a/_sources/user/build.rst.txt
+++ b/_sources/user/build.rst.txt
@@ -28,7 +28,11 @@ your system. The main dependencies are listed below:
#. `Intel OneAPI
`_
- for building with DPC++.
+ for building with SyCL.
+
+#. `AMD GPU
+ `_
+ for building with ROCM.
Building from source
--------------------
@@ -84,6 +88,10 @@ Architecture options
Enable `Intel OneAPI SyCL `_ builds. Default: OFF
+.. cmakeval:: AMR_WIND_ENABLE_ROCM
+
+ Enable `AMD ROCM GPU `_ builds. Default: OFF
+
Dependencies
~~~~~~~~~~~~~
@@ -135,13 +143,6 @@ Other AMR-Wind specific options
Enable compiler warnings during build. Default: OFF
-.. cmakeval:: AMR_WIND_ENABLE_FORTRAN
-
- Build Fortran interfaces. Default: OFF
-
- AMR-Wind itself has no Fortran code. This option is unused if
- :cmakeval:`AMR_WIND_USE_INTERNAL_AMREX` is set to ``OFF``.
-
General CMake options
~~~~~~~~~~~~~~~~~~~~~~
diff --git a/_sources/user/features.rst.txt b/_sources/user/features.rst.txt
new file mode 100644
index 0000000000..ef4a092e81
--- /dev/null
+++ b/_sources/user/features.rst.txt
@@ -0,0 +1,186 @@
+.. _capabilities:
+
+Capabilities and Roadmap
+========================
+
+This section documents a non-exhaustive list of current AMR-Wind
+capabilities and roadmap for future capabilities.
+
+.. tip::
+
+ If your project relies on a capability that is not yet present in
+ AMR-Wind, please create an issue on the code project page.
+
+
+.. note::
+
+ This reflects the capabilities for AMR-Wind version 2.1.0 and above.
+
+
+Capabilities
+------------
+
+.. tip::
+
+ The capabilities are linked to the relevant input file references
+ (keyword `inp`) and documentation (keyword `doc`). Searching for
+ those keywords in the `test/test_files` directory will give
+ concrete examples of the feature usage.
+
+
+Methods and models
+~~~~~~~~~~~~~~~~~~
+
+* Numerical methods
+
+ * Advection: second order, piecewise parabolic, piecewise linear, WENO, Bell-Dawson-Shubin [:ref:`doc `, :ref:`inp `]
+
+ * Diffusion: second order, explicit, Crank-Nicolson, and implicit [:ref:`doc `, :ref:`inp `]
+
+ * Mesh refinement: static refinement for specified regions [:ref:`inp `], adaptive mesh refinement [:ref:`inp `] (e.g., field based, curvature, q-criterion, vorticity [:ref:`inp `])
+
+ * Mesh mapping for non-uniform cartesian grids [:ref:`doc `, :ref:`inp `]
+
+* Equations systems
+
+ * Incompressible and low Mach formulations of Navier-Stokes :ref:`[doc] `
+
+ * Temperature
+
+ * Level set
+
+ * Subgrid scale kinetic energy :ref:`[doc] `
+
+ * Specific dissipation rate :ref:`[doc] `
+
+ * Passive scalar
+
+ * Source terms for these PDEs [:ref:`doc `, :ref:`inp `]
+
+* Turbulence modeling
+
+ * Large Eddy Simulation: constant Smagorinsky, AMD, one equation :math:`k_{sgs}`, Kosovic [:ref:`doc `, :ref:`inp `]
+
+ * Wall models: log-law, constant stress, Schumann [:ref:`doc `, :ref:`inp `]
+
+ * Reynolds-Average Navier-Stokes: :math:`k`-:math:`\omega` SST (and IDDES variant) [:ref:`doc `, :ref:`inp `]
+
+* Transport models
+
+ * Constant transport coefficients [:ref:`inp `]
+
+ * Two phase transport (separate coefficients for each material) [:ref:`inp `]
+
+Flow physics
+~~~~~~~~~~~~
+
+* Wind energy physics
+
+ * Atmospheric boundary layer (ABL): various stability states (stable, unstable, neutral), precursor simulations with inflow boundary planes for wind farm simulations, anelastic formulation, mesoscale forcing, geostrophic forcing, Coriolis forcing, Monin-Obukhov similarity theory, gravity forcing, gravity wave damping [:ref:`inp `]
+
+ * Actuator turbine representations: Joukowsky disks, uniform disks, actuator line [:ref:`inp `]
+
+ * Coupling with OpenFAST
+
+ * Coupling with Nalu-Wind for blade resolved simulations
+
+* Multiphase flows [:ref:`doc `]
+
+ * Prescribed flow cases for verification of volume-of-fluid transport: Zalesak disk, vortex patch
+
+ * Prescribed flow cases for verification of momentum equation coupled to volume-of-fluid transport: Zalesak disk scalar vel, vortex patch scalar vel
+
+ * Validation and demonstration cases: sloshing tank, dam break, breaking waves, falling or inertial droplet
+
+ * Methods to initialize volume-of-fluid field from an initial levelset field
+
+ * Monitors conservation of mass and momentum
+
+* Ocean wave forcing (for multiphase flows) [:ref:`inp `]
+
+ * Wave types: linear (monochromatic), Stokes (2nd- to 5th-order), irregular (input by modes files from HOS-Ocean)
+
+ * Relaxation zones force wave profile to generate waves at lower x boundary or force toward quiescent flat interface at upper x boundary. Wave profile can also be enforced (instead of numerical beach) at upper x boundary for periodic simulations.
+
+* Boundary conditions
+
+ * Periodic, outflow, inflow, walls, user-defined inflows [:ref:`inp `]
+
+ * Wall models (e.g., wall functions, stress) [:ref:`doc `, :ref:`inp `]
+
+ * Inflow planes from precursor simulations [:ref:`doc `, :ref:`inp `]
+
+ * Mesoscale forcing [:ref:`doc `, :ref:`inp `]
+
+ * Synthetic turbulence [:ref:`inp `]
+
+* Geometry
+
+ * Immersed boundary
+
+ * Coupling with Nalu-Wind for body-conforming meshes with overset methodology
+
+* Miscellaneous cases
+
+ * Verification and validation cases: method of manufactured solutions, convecting Taylor-Vortex, Rayleigh-Taylor, passive scalar, Burggraf flow, channel flow, Ekman spiral, vortex dipole, vortex ring
+
+* Postprocessing
+
+ * Visualization with VisIt, Paraview, yt
+
+ * Sampling of fields with planes, point probes, lines, volumes, lidar, and radar [:ref:`doc `, :ref:`inp `]
+
+ * Sampling of fields at probes that follow free surface of liquid-gas flows [:ref:`inp `]
+
+ * Scalar outputs such as kinetic energy, enstrophy, total wave energy, and norms [:ref:`doc `, :ref:`inp `]
+
+ * Turbulence averaging quantities such as Reynolds stresses [:ref:`inp `]
+
+ * Field plane averaging and second and third order moments
+
+ * Derived fields and field operators such as vorticity, q-criterion, strain-rates, gradients, divergence, laplacian
+
+ * in-situ post-processing with Ascent
+
+High performance computing
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Highly parallelized and performance portable
+
+ * Shared memory parallelism with OpenMP threading
+
+ * Distributed memory parallelism with MPI
+
+ * Supports all major compilers (e.g., GCC, Intel, LLVM)
+
+ * Runs on all major GPU vendors (NVIDIA, AMD, Intel)
+
+ * Supported build systems: cmake, spack
+
+* Supported linear solvers
+
+ * native AMReX solvers such as MLMG [:ref:`inp `]
+
+ * hypre
+
+
+Roadmap
+-------
+
+The roadmap is an evolving, living document and does not purport to
+track every future capability. It is not a promise of future
+capabilities. The main use case is to inform users of
+potential upcoming new capabilities.
+
+Current development
+~~~~~~~~~~~~~~~~~~~
+
+* Inflow-outflow BCs to enable coupling amr-wind to ERF mesoscale modeling software
+
+* Temporal and spatial varying MMC forcing
+
+* Complex terrain
+
+ * Improved wall conditions, e.g., non-uniform roughness, temperature and heat fluxes
+
+ * Complex terrain though immersed boundary methods
diff --git a/_sources/user/inputs.rst.txt b/_sources/user/inputs.rst.txt
index 27be9ae91f..779d3292e3 100644
--- a/_sources/user/inputs.rst.txt
+++ b/_sources/user/inputs.rst.txt
@@ -38,6 +38,7 @@ Section Description
======================= ============================================================
``geometry`` Computational domain information
``amr`` Mesh refinement controls
+``tagging`` Static and dynamic refinement options
``time`` Simulation time controls
``io`` Input/Output controls
``incflo`` CFD algorithm and physics controls
@@ -49,7 +50,6 @@ Section Description
``Momentum sources`` Activate Momentum source terms and their parameters
``Boundary conditions`` Boundary condition types and gradients
``MLMG options`` Multi-Level Multi-Grid Linear solver options
-``Tagging`` Static and dynamic refinement options
``Sampling`` Data probes to sample field data during simulations
``Averaging`` Time averaging and correlations
======================= ============================================================
@@ -71,6 +71,7 @@ This section documents the parameters available within each section.
inputs_geometry.rst
inputs_amr.rst
+ inputs_tagging.rst
inputs_time.rst
inputs_io.rst
inputs_incflo.rst
@@ -80,10 +81,8 @@ This section documents the parameters available within each section.
inputs_ABL.rst
inputs_ABL_meso_forcing.rst
inputs_SyntheticTurbulence.rst
- inputs_Static_Refinement.rst
inputs_Boundary_conditions.rst
inputs_MLMG.rst
- inputs_AMR_Tagging.rst
inputs_Sampling.rst
inputs_Averaging.rst
inputs_KineticEnergy.rst
diff --git a/_sources/user/inputs_ABL.rst.txt b/_sources/user/inputs_ABL.rst.txt
index fd6b584379..3eb14760a7 100644
--- a/_sources/user/inputs_ABL.rst.txt
+++ b/_sources/user/inputs_ABL.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_abl:
+
Section: ABL
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~
This section is for setting atmospheric boundary layer parameters.
diff --git a/_sources/user/inputs_ABL_meso_forcing.rst.txt b/_sources/user/inputs_ABL_meso_forcing.rst.txt
index 012283ac6f..33727a7c03 100644
--- a/_sources/user/inputs_ABL_meso_forcing.rst.txt
+++ b/_sources/user/inputs_ABL_meso_forcing.rst.txt
@@ -1,3 +1,5 @@
+.. _inputs_meso_forcing:
+
Section: ABLMesoForcing
~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/_sources/user/inputs_Actuator.rst.txt b/_sources/user/inputs_Actuator.rst.txt
index bee227efac..0c5794bbb3 100644
--- a/_sources/user/inputs_Actuator.rst.txt
+++ b/_sources/user/inputs_Actuator.rst.txt
@@ -1,7 +1,7 @@
.. _inputs_actuator:
Section: Actuator
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
This section controls the actuator type models. This includes the actuator
disk and line models. The prefix is the label set in
diff --git a/_sources/user/inputs_Boundary_conditions.rst.txt b/_sources/user/inputs_Boundary_conditions.rst.txt
index 326714c2e5..be809a7a0c 100644
--- a/_sources/user/inputs_Boundary_conditions.rst.txt
+++ b/_sources/user/inputs_Boundary_conditions.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_boundary_conditions:
+
Section: Boundary conditions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section controls the boundary conditions. Only non-periodic BC's need to be defined here.
diff --git a/_sources/user/inputs_MLMG.rst.txt b/_sources/user/inputs_MLMG.rst.txt
index 3d09312ff7..07635b896d 100644
--- a/_sources/user/inputs_MLMG.rst.txt
+++ b/_sources/user/inputs_MLMG.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_mlmg:
+
Section: MLMG options
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
This section specifies the Multi-Level Multi-Grid (MLMG) options for each type
of linear solve. There are three types of linear solves performed in amr-wind
diff --git a/_sources/user/inputs_Momentum_Sources.rst.txt b/_sources/user/inputs_Momentum_Sources.rst.txt
index 15e20386ea..2216ed569d 100644
--- a/_sources/user/inputs_Momentum_Sources.rst.txt
+++ b/_sources/user/inputs_Momentum_Sources.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_momentum_sources:
+
Section: Momentum Sources
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
.. input_param:: ICNS.source_terms
diff --git a/_sources/user/inputs_Static_Refinement.rst.txt b/_sources/user/inputs_Static_Refinement.rst.txt
deleted file mode 100644
index 75ff3616f3..0000000000
--- a/_sources/user/inputs_Static_Refinement.rst.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-
-Section: Static Refinement
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This section is for controlling the static mesh refinement of the grid.
-
-.. input_param:: tagging.static_refinement
-
- **type:** Boolean, optional, default = false
-
- Static refinement with Cartesian-aligned bounding boxes.
-
-.. input_param:: tagging.static_refinement_def
-
- **type:** String
-
- Static refinement with Cartesian-aligned bounding boxes input file name.
-
diff --git a/_sources/user/inputs_SyntheticTurbulence.rst.txt b/_sources/user/inputs_SyntheticTurbulence.rst.txt
index 4b87cc26d3..8690a7c0ec 100644
--- a/_sources/user/inputs_SyntheticTurbulence.rst.txt
+++ b/_sources/user/inputs_SyntheticTurbulence.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_synthetic_turbulence:
+
Section: SyntheticTurbulence
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This section is for setting turbulence injection parameters.
diff --git a/_sources/user/inputs_amr.rst.txt b/_sources/user/inputs_amr.rst.txt
index 9962a33fe1..d93cee3335 100644
--- a/_sources/user/inputs_amr.rst.txt
+++ b/_sources/user/inputs_amr.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_amr:
+
Section: amr
-~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~
This section contains input parameters used by the core AMReX mesh data
structure ``AmrCore`` to determine the base mesh and adaptive mesh refinement
diff --git a/_sources/user/inputs_geometry.rst.txt b/_sources/user/inputs_geometry.rst.txt
index a32186ed7d..676e232d0b 100644
--- a/_sources/user/inputs_geometry.rst.txt
+++ b/_sources/user/inputs_geometry.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_geometry:
+
Section: geometry
-~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
This section deals with inputs related to the problem domain.
diff --git a/_sources/user/inputs_incflo.rst.txt b/_sources/user/inputs_incflo.rst.txt
index 204beba188..948a34d9f6 100644
--- a/_sources/user/inputs_incflo.rst.txt
+++ b/_sources/user/inputs_incflo.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_incflo:
+
Section: incflo
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
This section deals with parameters that mostly determine how amr-wind is run such
as initial conditions and discretization options.
@@ -67,6 +69,8 @@ as initial conditions and discretization options.
stability at larger CFL numbers, and greater computational efficiency. Setting this argument to false is
not recommended, and active use or development relying on the method of lines (MOL) is very sparse.
+.. _inputs_incflo_advection:
+
.. input_param:: incflo.godunov_type
**type:** String, optional, default = weno_z
@@ -81,6 +85,8 @@ as initial conditions and discretization options.
Specifies if body forces are included in the transverse velocity prediction.
Note: only used when :input_param:`incflo.use_godunov` = true.
+.. _inputs_incflo_diffusion:
+
.. input_param:: incflo.diffusion_type
**type:** Integer, optional, default = 2
diff --git a/_sources/user/inputs_ocean_waves.rst.txt b/_sources/user/inputs_ocean_waves.rst.txt
index 8814bb3e01..1311305fcb 100644
--- a/_sources/user/inputs_ocean_waves.rst.txt
+++ b/_sources/user/inputs_ocean_waves.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_ocean_waves:
+
Section: Ocean Waves
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
This section is for setting up wave forcing and relaxation zones.
@@ -200,4 +202,4 @@ The following input arguments are only valid for the W2AWaves wave type:
The number of points placed above the mean water surface for the velocity transformation process. The spacing
between the points above the surface is equal to the interp_spacing_at_surface. When setting this value, the wave height
- should be considered so that velocity can be accurately computed for portions of the waves above the mean surface.
\ No newline at end of file
+ should be considered so that velocity can be accurately computed for portions of the waves above the mean surface.
diff --git a/_sources/user/inputs_AMR_Tagging.rst.txt b/_sources/user/inputs_tagging.rst.txt
similarity index 92%
rename from _sources/user/inputs_AMR_Tagging.rst.txt
rename to _sources/user/inputs_tagging.rst.txt
index cbbbd2c40d..23d4719d78 100644
--- a/_sources/user/inputs_AMR_Tagging.rst.txt
+++ b/_sources/user/inputs_tagging.rst.txt
@@ -1,7 +1,7 @@
.. _inputs_tagging:
-Section: AMR Tagging
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Section: tagging
+~~~~~~~~~~~~~~~~
This section manages the various mesh refinement criteria that can be used to
activate either static or adaptive mesh refinement during simulations. The
@@ -225,3 +225,25 @@ Example::
the cell is tagged for refinement.
The user must specify a value for each level desired.
+.. _inputs_static_refinement:
+
+Static refinement
+`````````````````
+
+This section is for controlling the static mesh refinement of the
+grid. This is done a bit differently than the tagging criteria above
+in that an external file species the refinement regions.
+
+.. input_param:: tagging.static_refinement
+
+ **type:** Boolean, optional, default = false
+
+ Static refinement with Cartesian-aligned bounding boxes.
+
+.. input_param:: tagging.static_refinement_def
+
+ **type:** String
+
+ Static refinement with Cartesian-aligned bounding boxes input file name.
+
+
diff --git a/_sources/user/inputs_transport.rst.txt b/_sources/user/inputs_transport.rst.txt
index f47d1f98a4..559a5a38ec 100644
--- a/_sources/user/inputs_transport.rst.txt
+++ b/_sources/user/inputs_transport.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_transport:
+
Section: transport
-~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~
This section is for setting thermal and momentum diffusivities.
@@ -7,7 +9,7 @@ This section is for setting thermal and momentum diffusivities.
**type:** String, optional, default = ConstTransport
- Currently this is the only transport model implemented.
+ The implemented transport model are ConstTransport and TwoPhaseTransport.
.. input_param:: transport.viscosity
diff --git a/_sources/user/inputs_turbulence.rst.txt b/_sources/user/inputs_turbulence.rst.txt
index 8fbfc58aa6..19aa5e8708 100644
--- a/_sources/user/inputs_turbulence.rst.txt
+++ b/_sources/user/inputs_turbulence.rst.txt
@@ -1,5 +1,7 @@
+.. _inputs_turbulence:
+
Section: turbulence
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
This section is for setting turbulence model parameters
@@ -7,9 +9,10 @@ This section is for setting turbulence model parameters
**type:** String, optional, default = Laminar
- Specifies which turbulence model to use, by default "Laminar" is chosen
- (effectively no turbulence model).
- Currently the only turbulence model is "Smagorinsky"
+ Specifies which turbulence model to use, by default "Laminar" is
+ chosen (effectively no turbulence model). Currently the supported
+ turbulence models are "Smagorinsky", "AMD", "Kosovic", and
+ "OneEqKsgsM84", "KOmegaSST", and "KOmegaSSTIDDES".
.. input_param:: Smagorinsky_coeffs.Cs
diff --git a/_sources/user/post_processing_examples.rst.txt b/_sources/user/post_processing_examples.rst.txt
index 82145b107b..6b62daa2e9 100644
--- a/_sources/user/post_processing_examples.rst.txt
+++ b/_sources/user/post_processing_examples.rst.txt
@@ -1,3 +1,5 @@
+.. _post_processing:
+
Post-processing Examples
========================
diff --git a/_sources/user/sampling_freesurfacesampler.rst.txt b/_sources/user/sampling_freesurfacesampler.rst.txt
index 2ba16fe2ab..77bc1fe1e6 100644
--- a/_sources/user/sampling_freesurfacesampler.rst.txt
+++ b/_sources/user/sampling_freesurfacesampler.rst.txt
@@ -1,4 +1,4 @@
-.. _sampling_freesurface_sampler.rst:
+.. _inputs_sampling_freesurface_sampler:
FreeSurfaceSampler
==================
@@ -53,4 +53,4 @@ test/test_files/dam_break_godunov with the sampling format set to "ascii" and th
frequency (actually an interval) set to 30.
.. literalinclude:: ../../../tools/sampling_dam_break_godunov_ascii.py
- :language: python
\ No newline at end of file
+ :language: python
diff --git a/_sources/user/user.rst.txt b/_sources/user/user.rst.txt
index af3c6c15a6..1dc10ab41d 100644
--- a/_sources/user/user.rst.txt
+++ b/_sources/user/user.rst.txt
@@ -5,6 +5,7 @@ User Manual
:glob:
:maxdepth: 2
+ features.rst
build.rst
inputs.rst
abl_bndry_io.rst
diff --git a/genindex.html b/genindex.html
index d4bf2ce0f8..102d14e6ba 100644
--- a/genindex.html
+++ b/genindex.html
@@ -1100,31 +1100,31 @@ A
SynthTurb.zref
- tagging.CartBoxRefinement.static_refinement_def
+ tagging.CartBoxRefinement.static_refinement_def
- tagging.FieldRefinement.field_error
+ tagging.FieldRefinement.field_error
- tagging.FieldRefinement.field_name
+ tagging.FieldRefinement.field_name
- tagging.FieldRefinement.grad_error
+ tagging.FieldRefinement.grad_error
- tagging.GeoemtryRefinement.level
+ tagging.GeoemtryRefinement.level
- tagging.GeometryRefinement.max_level
+ tagging.GeometryRefinement.max_level
- tagging.GeometryRefinement.min_level
+ tagging.GeometryRefinement.min_level
- tagging.GeometryRefinement.shapes
+ tagging.GeometryRefinement.shapes
- tagging.labels
+ tagging.labels
- tagging.QCriterionRefinement.nondim
+ tagging.QCriterionRefinement.nondim
- tagging.QCriterionRefinement.values
+ tagging.QCriterionRefinement.values
- tagging.static_refinement
+ tagging.static_refinement
- tagging.static_refinement_def
+ tagging.static_refinement_def
time.cfl
@@ -1235,13 +1235,6 @@ A
-
- AMR_WIND_ENABLE_FORTRAN
-
-
@@ -1270,6 +1263,13 @@ A
+
+ AMR_WIND_ENABLE_ROCM
+
+
@@ -1437,8 +1437,6 @@ C
AMR_WIND_ENABLE_ALL_WARNINGS
AMR_WIND_ENABLE_CUDA
-
- AMR_WIND_ENABLE_FORTRAN
AMR_WIND_ENABLE_MASA
@@ -1447,6 +1445,8 @@ C
AMR_WIND_ENABLE_NETCDF
AMR_WIND_ENABLE_OPENMP
+
+ AMR_WIND_ENABLE_ROCM
AMR_WIND_ENABLE_SYCL
@@ -2305,91 +2305,91 @@ T
tagging.CartBoxRefinement.static_refinement_def
tagging.FieldRefinement.field_error
tagging.FieldRefinement.field_name
tagging.FieldRefinement.grad_error
tagging.GeoemtryRefinement.level
tagging.GeometryRefinement.max_level
tagging.GeometryRefinement.min_level
tagging.GeometryRefinement.shapes
tagging.labels
tagging.QCriterionRefinement.nondim
tagging.QCriterionRefinement.values
tagging.static_refinement
tagging.static_refinement_def
diff --git a/index.html b/index.html
index e50c9ec55b..12f1665795 100644
--- a/index.html
+++ b/index.html
@@ -100,9 +100,10 @@ AMR-WindExawind ecosystem, AMR-wind shares the following
objectives:
-an open, well-documented implementation of the state-of-the-art computational
-models for modeling wind farm flow physics at various fidelities that are
-backed by a comprehensive verification and validation (V&V) process;
+an open, well-documented implementation of the state-of-the-art
+computational models for modeling wind farm flow physics at various
+fidelities that are backed by a comprehensive verification and
+validation (V&V) process (Capabilities and Roadmap);
be capable of performing the highest-fidelity simulations of flowfields within
wind farms; and
be able to leverage the high-performance leadership class computating
@@ -111,6 +112,7 @@
AMR-Wind