Skip to content

Commit 5e88c60

Browse files
Merge branch 'main' into swe_separation
2 parents 38c6e86 + 3f4f154 commit 5e88c60

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

src/equations/compressible_euler_2d.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ Details about the 1D pressure Riemann solution can be found in Section 6.3.3 of
294294
3rd edition
295295
[DOI: 10.1007/b79761](https://doi.org/10.1007/b79761)
296296
297-
Should be used together with [`UnstructuredMesh2D`](@ref).
297+
Should be used together with [`UnstructuredMesh2D`](@ref) or [`P4estMesh`](@ref).
298298
"""
299299
@inline function boundary_condition_slip_wall(u_inner, normal_direction::AbstractVector,
300300
x, t,

src/equations/compressible_euler_3d.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,8 @@ Details about the 1D pressure Riemann solution can be found in Section 6.3.3 of
285285
Riemann Solvers and Numerical Methods for Fluid Dynamics: A Practical Introduction
286286
3rd edition
287287
[DOI: 10.1007/b79761](https://doi.org/10.1007/b79761)
288+
289+
Should be used together with [`P4estMesh`](@ref).
288290
"""
289291
@inline function boundary_condition_slip_wall(u_inner, normal_direction::AbstractVector,
290292
x, t,

src/equations/compressible_navier_stokes.jl

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
"""
33
struct BoundaryConditionNavierStokesWall
44
5-
Creates a wall-type boundary conditions for the compressible Navier-Stokes equations.
5+
Creates a wall-type boundary conditions for the compressible Navier-Stokes equations, see
6+
[`CompressibleNavierStokesDiffusion1D`](@ref), [`CompressibleNavierStokesDiffusion2D`](@ref), and
7+
[`CompressibleNavierStokesDiffusion3D`](@ref).
68
The fields `boundary_condition_velocity` and `boundary_condition_heat_flux` are intended
7-
to be boundary condition types such as the `NoSlip` velocity boundary condition and the
8-
`Adiabatic` or `Isothermal` heat boundary condition.
9+
to be boundary condition types such as the [`NoSlip`](@ref) velocity boundary condition and the
10+
[`Adiabatic`](@ref) or [`Isothermal`](@ref) heat boundary condition.
911
"""
1012
struct BoundaryConditionNavierStokesWall{V, H}
1113
boundary_condition_velocity::V
@@ -15,10 +17,10 @@ end
1517
"""
1618
struct NoSlip
1719
18-
Use to create a no-slip boundary condition with `BoundaryConditionNavierStokesWall`. The field `boundary_value_function`
19-
should be a function with signature `boundary_value_function(x, t, equations)`
20-
and should return a `SVector{NDIMS}` whose entries are the velocity vector at a
21-
point `x` and time `t`.
20+
Use to create a no-slip boundary condition with [`BoundaryConditionNavierStokesWall`](@ref).
21+
The field `boundary_value_function` should be a function with signature
22+
`boundary_value_function(x, t, equations)` and return a `SVector{NDIMS}`
23+
whose entries are the velocity vector at a point `x` and time `t`.
2224
"""
2325
struct NoSlip{F}
2426
boundary_value_function::F # value of the velocity vector on the boundary

0 commit comments

Comments
 (0)