|
2 | 2 | """ |
3 | 3 | struct BoundaryConditionNavierStokesWall |
4 | 4 |
|
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). |
6 | 8 | 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. |
9 | 11 | """ |
10 | 12 | struct BoundaryConditionNavierStokesWall{V, H} |
11 | 13 | boundary_condition_velocity::V |
|
15 | 17 | """ |
16 | 18 | struct NoSlip |
17 | 19 |
|
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`. |
22 | 24 | """ |
23 | 25 | struct NoSlip{F} |
24 | 26 | boundary_value_function::F # value of the velocity vector on the boundary |
|
0 commit comments