diff --git a/NEWS.md b/NEWS.md index f012de09786..71d711dfb09 100644 --- a/NEWS.md +++ b/NEWS.md @@ -10,6 +10,9 @@ for human readability. #### Changed +- Parabolic diffusion terms are now officially supported and not marked as experimental + anymore. + #### Deprecated #### Removed diff --git a/README.md b/README.md index 1d52089ae3e..c531ab4d1a4 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@

-**Trixi.jl** is a numerical simulation framework for hyperbolic conservation +**Trixi.jl** is a numerical simulation framework for conservation laws written in [Julia](https://julialang.org). A key objective for the framework is to be useful to both scientists and students. Therefore, next to having an extensible design with a fast implementation, Trixi.jl is @@ -46,6 +46,7 @@ installation and postprocessing procedures. Its features include: * Periodic and weakly-enforced boundary conditions * Multiple governing equations: * Compressible Euler equations + * Compressible Navier-Stokes equations * Magnetohydrodynamics (MHD) equations * Multi-component compressible Euler and MHD equations * Linearized Euler and acoustic perturbation equations @@ -56,6 +57,7 @@ installation and postprocessing procedures. Its features include: * Multi-physics simulations * [Self-gravitating gas dynamics](https://github.com/trixi-framework/paper-self-gravitating-gas-dynamics) * Shared-memory parallelization via multithreading +* Multi-node parallelization via MPI * Visualization and postprocessing of the results * In-situ and a posteriori visualization with [Plots.jl](https://github.com/JuliaPlots/Plots.jl) * Interactive visualization with [Makie.jl](https://makie.juliaplots.org/) diff --git a/docs/src/index.md b/docs/src/index.md index fd923348928..fbb4b36b224 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -12,7 +12,7 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3996439.svg)](https://doi.org/10.5281/zenodo.3996439) [**Trixi.jl**](https://github.com/trixi-framework/Trixi.jl) -is a numerical simulation framework for hyperbolic conservation +is a numerical simulation framework for conservation laws written in [Julia](https://julialang.org). A key objective for the framework is to be useful to both scientists and students. Therefore, next to having an extensible design with a fast implementation, Trixi.jl is @@ -40,6 +40,7 @@ installation and postprocessing procedures. Its features include: * Periodic and weakly-enforced boundary conditions * Multiple governing equations: * Compressible Euler equations + * Compressible Navier-Stokes equations * Magnetohydrodynamics (MHD) equations * Multi-component compressible Euler and MHD equations * Linearized Euler and acoustic perturbation equations @@ -50,6 +51,7 @@ installation and postprocessing procedures. Its features include: * Multi-physics simulations * [Self-gravitating gas dynamics](https://github.com/trixi-framework/paper-self-gravitating-gas-dynamics) * Shared-memory parallelization via multithreading +* Multi-node parallelization via MPI * Visualization and postprocessing of the results * In-situ and a posteriori visualization with [Plots.jl](https://github.com/JuliaPlots/Plots.jl) * Interactive visualization with [Makie.jl](https://makie.juliaplots.org/) diff --git a/docs/src/overview.md b/docs/src/overview.md index 9cd11a5df93..9bc523ca297 100644 --- a/docs/src/overview.md +++ b/docs/src/overview.md @@ -60,10 +60,9 @@ different features on different mesh types. | Flux differencing | ✅ | ✅ | ✅ | ✅ | ✅ | [`VolumeIntegralFluxDifferencing`](@ref) | Shock capturing | ✅ | ✅ | ✅ | ✅ | ❌ | [`VolumeIntegralShockCapturingHG`](@ref) | Nonconservative equations | ✅ | ✅ | ✅ | ✅ | ✅ | e.g., GLM MHD or shallow water equations -| Parabolic termsᵇ | ✅ | ✅ | ❌ | ✅ | ✅ | e.g., [`CompressibleNavierStokesDiffusion2D`](@ref) +| Parabolic terms | ✅ | ✅ | ❌ | ✅ | ✅ | e.g., [`CompressibleNavierStokesDiffusion2D`](@ref) ᵃ: quad = quadrilateral, hex = hexahedron -ᵇ: Parabolic terms do not currently support adaptivity. ## Time integration methods diff --git a/src/equations/compressible_navier_stokes.jl b/src/equations/compressible_navier_stokes.jl index af7897d4586..3059771197c 100644 --- a/src/equations/compressible_navier_stokes.jl +++ b/src/equations/compressible_navier_stokes.jl @@ -6,9 +6,6 @@ Creates a wall-type boundary conditions for the compressible Navier-Stokes equat The fields `boundary_condition_velocity` and `boundary_condition_heat_flux` are intended to be boundary condition types such as the `NoSlip` velocity boundary condition and the `Adiabatic` or `Isothermal` heat boundary condition. - -!!! warning "Experimental feature" - This is an experimental feature and may change in future releases. """ struct BoundaryConditionNavierStokesWall{V, H} boundary_condition_velocity::V @@ -52,9 +49,6 @@ struct Adiabatic{F} end """ -!!! warning "Experimental code" - This code is experimental and may be changed or removed in any future release. - `GradientVariablesPrimitive` and `GradientVariablesEntropy` are gradient variable type parameters for `CompressibleNavierStokesDiffusion1D`. By default, the gradient variables are set to be `GradientVariablesPrimitive`. Specifying `GradientVariablesEntropy` instead uses the entropy variable diff --git a/src/equations/compressible_navier_stokes_1d.jl b/src/equations/compressible_navier_stokes_1d.jl index 74d672ce7ae..f5ae598f389 100644 --- a/src/equations/compressible_navier_stokes_1d.jl +++ b/src/equations/compressible_navier_stokes_1d.jl @@ -79,9 +79,6 @@ where ```math w_2 = \frac{\rho v1}{p},\, w_3 = -\frac{\rho}{p} ``` - -!!! warning "Experimental code" - This code is experimental and may be changed or removed in any future release. """ struct CompressibleNavierStokesDiffusion1D{GradientVariables, RealT <: Real, E <: AbstractCompressibleEulerEquations{1} diff --git a/src/equations/compressible_navier_stokes_2d.jl b/src/equations/compressible_navier_stokes_2d.jl index 80857999017..cc0c580bf10 100644 --- a/src/equations/compressible_navier_stokes_2d.jl +++ b/src/equations/compressible_navier_stokes_2d.jl @@ -79,9 +79,6 @@ where ```math w_2 = \frac{\rho v_1}{p},\, w_3 = \frac{\rho v_2}{p},\, w_4 = -\frac{\rho}{p} ``` - -!!! warning "Experimental code" - This code is experimental and may be changed or removed in any future release. """ struct CompressibleNavierStokesDiffusion2D{GradientVariables, RealT <: Real, E <: AbstractCompressibleEulerEquations{2} diff --git a/src/equations/compressible_navier_stokes_3d.jl b/src/equations/compressible_navier_stokes_3d.jl index de2cad99ea8..e9ad3eb6aad 100644 --- a/src/equations/compressible_navier_stokes_3d.jl +++ b/src/equations/compressible_navier_stokes_3d.jl @@ -79,9 +79,6 @@ where ```math w_2 = \frac{\rho v_1}{p},\, w_3 = \frac{\rho v_2}{p},\, w_4 = \frac{\rho v_3}{p},\, w_5 = -\frac{\rho}{p} ``` - -!!! warning "Experimental code" - This code is experimental and may be changed or removed in any future release. """ struct CompressibleNavierStokesDiffusion3D{GradientVariables, RealT <: Real, E <: AbstractCompressibleEulerEquations{3}