Skip to content

Commit fa1b56a

Browse files
committed
Added short descriptions to examples
1 parent 936a98a commit fa1b56a

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,29 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<Group id="Fluid" name="Fluid examples">
33
<Example id="SodShockTube2D" app="CompressibleFluid" logo="logo_sod.png" name="Sod shock tube 2D" dim="2D" cmd="::CompressibleFluid::examples::SodShockTube::Init">
4-
<Description>Shock tube is a long tube with contant cross section, where a diaphragm separates the left and right halves that are filled with two differecnt pressures of air.
5-
The gas in the left portion is higher pressure than the one on the right.
4+
<Description>This is a 2D simulation of the classical Sod shock tube benchmark using the Euler equations.
5+
Shock tube is a long tube with contant cross section, where a diaphragm separates the left and right halves that are filled with two different pressures
6+
of air. This diaphragm is located at x=0.5.
7+
The gas in the left portion is higher pressure than the one on the right.
8+
The problem geometry consists in a rectangular domain, 1 unit long and 0.1 units wide, with free-slip conditions on long sides and open boundaries on
9+
the short sides.
10+
The Sod shock problem is one-dimensional, which coincides with the X-axis in this case. Hence, no variations along the Y-axis are observed.
611
</Description>
712
</Example>
813
<Example id="Wedge" app="CompressibleFluid" logo="logo_wedge.png" name="Wedge 2D" dim="2D" cmd="::CompressibleFluid::examples::Wedge::Init">
9-
<Description>A supersonic inviscid flow over a wedge having an angle of 21.5°. This supersonic flow will create an oblique shock over the wedge.
14+
<Description>This is a classical 2D simulation of a supersonic flow over a wedge using the Euler equations.
15+
The supersonic flow will create an oblique shock over the wedge that reach a stedy state very quickly.
16+
The geometry is a Wedge with an angle of 21.5° in a rectangular domain. The Wedge and bottom boundaries are free-slip. The right and top boundaries are
17+
left open and the left boundary enforces same values as the initial conditions.
1018
</Description>
1119
</Example>
1220
<Example id="Step" app="CompressibleFluid" logo="logo_step.png" name="Step 2D" dim="2D" cmd="::CompressibleFluid::examples::Step::Init">
13-
<Description>This example is a classical test example dating at least back to the famous paper of Woodward and Colella:
14-
The numerical simulation of two-dimensional fluid flow with strong shocks, Journal of Computational Physics, 54, pp. 115-173 (1984).
15-
The test case describes a Mach 3 flow in a wind tunnel. The tunnel is 1 length unit high and 3 length units long.
16-
The step is 0.2 length units high and is located 0.6 length units from the left-hand end of the tunnel. The walls are reflective.
21+
<Description>This is a 2D simulation of the classical step from Woodward and Collela using the Euler equations.
22+
The problem geometry consists of a rectangle with a step at the bottom. The rectangular domain has a width of 3 units and a height of 1 unit. The step
23+
is located 0.6 units to the right of the bottom-left corner, and it rises to 0.1 units above the bottom edge.
24+
The top and bottom boundaries, as well as the step are free-slip. The node at the bottom of the step (0.6, 0.0), has its velocity set to zero for
25+
numerical stability purposes.
26+
The right boundary is left open and the left boundary enforces same values as the initial conditions.
1727
</Description>
1828
</Example>
1929
</Group>

0 commit comments

Comments
 (0)