Skip to content

Commit 8a731ce

Browse files
zingalezingale
authored
rename viscous_burgers -> burgers_viscous (#267)
this is consistent with incompressible and also allows it to appear next to burgers in a listing (alphabetically)
1 parent d063c13 commit 8a731ce

30 files changed

+273
-79
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ pyro provides the following solvers (all in 2-d):
138138
- `burgers`: a second-order unsplit solver for invsicid Burgers'
139139
equation.
140140
141-
- `viscous_burgers`: a second-order unsplit solver for viscous
141+
- `burgers_viscous`: a second-order unsplit solver for viscous
142142
Burgers' equation with constant-coefficient diffusion. It uses
143143
Crank-Nicolson time-discretized solver for solving diffusion.
144144

‎docs/source/burgers_basics.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,28 @@ A 2D viscous Burgers' Equation has the following form:
4545
u_t + u u_x + v u_y = \epsilon \left( u_{xx} + u_{yy}\right) \\
4646
v_t + u v_x + v v_y = \epsilon \left( v_{xx} + v_{yy}\right)
4747
48-
The viscous Burgers' equation has an additional velocity diffusion term on the RHS compared to the inviscid Burgers' equation. Here :math:`\epsilon` represents the constant viscosity.
48+
The viscous Burgers' equation has an additional velocity diffusion
49+
term on the RHS compared to the inviscid Burgers' equation. Here
50+
:math:`\epsilon` represents the constant viscosity.
4951

50-
:py:mod:`pyro.viscous_burgers` is inherited from :py:mod:`pyro.burgers`, where we added an additional diffusion term when constructing the interface states. We then solve for diffusion along with the extra advective source to the Helmholtz equation by using the Crank-Nicolson discretization and multigrid solvers.
52+
:py:mod:`pyro.burgers_viscous` is inherited from
53+
:py:mod:`pyro.burgers`, where we added an additional diffusion term
54+
when constructing the interface states. We then solve for diffusion
55+
along with the extra advective source to the Helmholtz equation by
56+
using the Crank-Nicolson discretization and multigrid solvers.
5157

5258

5359
The parameters for this solver are:
5460

55-
.. include:: viscous_burgers_defaults.inc
61+
.. include:: burgers_viscous_defaults.inc
5662

5763

5864
.. image:: viscous_burgers.png
5965
:align: center
6066

61-
The figure above is generated using ``viscous_burgers/problems/test.py``, which has the identical setup as in ``burgers/problems/test.py``. With diffusion added to the system, we see the shock (discontinuity) is smeared out as system evolves.
67+
The figure above is generated using
68+
``burgers_viscous/problems/test.py``, which has the identical setup as
69+
in ``burgers/problems/test.py``. With diffusion added to the system,
70+
we see the shock (discontinuity) is smeared out as system evolves.
6271

6372

‎docs/source/pyro.advection.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ pyro.advection.advective\_fluxes module
2525
:undoc-members:
2626
:show-inheritance:
2727

28+
pyro.advection.interface module
29+
-------------------------------
30+
31+
.. automodule:: pyro.advection.interface
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
2836
pyro.advection.simulation module
2937
--------------------------------
3038

‎docs/source/pyro.advection_fv4.problems.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,19 @@ pyro.advection\_fv4.problems.smooth module
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
19+
20+
pyro.advection\_fv4.problems.test module
21+
----------------------------------------
22+
23+
.. automodule:: pyro.advection_fv4.problems.test
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.advection\_fv4.problems.tophat module
29+
------------------------------------------
30+
31+
.. automodule:: pyro.advection_fv4.problems.tophat
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/source/pyro.burgers.problems.rst

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
pyro.burgers.problems package
2-
===============================
2+
=============================
33

44
.. automodule:: pyro.burgers.problems
55
:members:
@@ -9,27 +9,34 @@ pyro.burgers.problems package
99
Submodules
1010
----------
1111

12-
pyro.burgers.problems.test module
12+
pyro.burgers.problems.converge module
1313
-------------------------------------
1414

15-
.. automodule:: pyro.burgers.problems.test
15+
.. automodule:: pyro.burgers.problems.converge
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
1919

20+
pyro.burgers.problems.test module
21+
---------------------------------
2022

21-
pyro.burgers.problems.converge module
22-
-------------------------------------
23-
24-
.. automodule:: pyro.burgers.problems.converge
23+
.. automodule:: pyro.burgers.problems.test
2524
:members:
2625
:undoc-members:
2726
:show-inheritance:
2827

2928
pyro.burgers.problems.tophat module
30-
-------------------------------------
29+
-----------------------------------
3130

3231
.. automodule:: pyro.burgers.problems.tophat
3332
:members:
3433
:undoc-members:
3534
:show-inheritance:
35+
36+
pyro.burgers.problems.verify module
37+
-----------------------------------
38+
39+
.. automodule:: pyro.burgers.problems.verify
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:

‎docs/source/pyro.burgers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
pyro.burgers package
2-
======================
2+
====================
33

44
.. automodule:: pyro.burgers
55
:members:
@@ -18,15 +18,15 @@ Submodules
1818
----------
1919

2020
pyro.burgers.burgers\_interface module
21-
---------------------------------------
21+
--------------------------------------
2222

2323
.. automodule:: pyro.burgers.burgers_interface
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
2727

2828
pyro.burgers.simulation module
29-
--------------------------------
29+
------------------------------
3030

3131
.. automodule:: pyro.burgers.simulation
3232
:members:

‎docs/source/pyro.burgers_viscous.problems.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
pyro.burgers\_viscous.problems package
2+
======================================
3+
4+
.. automodule:: pyro.burgers_viscous.problems
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
pyro.burgers\_viscous.problems.converge module
13+
----------------------------------------------
14+
15+
.. automodule:: pyro.burgers_viscous.problems.converge
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
pyro.burgers\_viscous.problems.test module
21+
------------------------------------------
22+
23+
.. automodule:: pyro.burgers_viscous.problems.test
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.burgers\_viscous.problems.tophat module
29+
--------------------------------------------
30+
31+
.. automodule:: pyro.burgers_viscous.problems.tophat
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/source/pyro.burgers_viscous.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
pyro.burgers\_viscous package
2+
=============================
3+
4+
.. automodule:: pyro.burgers_viscous
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 4
14+
15+
pyro.burgers_viscous.problems
16+
17+
Submodules
18+
----------
19+
20+
pyro.burgers\_viscous.interface module
21+
--------------------------------------
22+
23+
.. automodule:: pyro.burgers_viscous.interface
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.burgers\_viscous.simulation module
29+
---------------------------------------
30+
31+
.. automodule:: pyro.burgers_viscous.simulation
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/source/pyro.compressible.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,14 @@ pyro.compressible.interface module
4949
:undoc-members:
5050
:show-inheritance:
5151

52+
pyro.compressible.riemann module
53+
--------------------------------
54+
55+
.. automodule:: pyro.compressible.riemann
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
5260
pyro.compressible.simulation module
5361
-----------------------------------
5462

‎docs/source/pyro.multigrid.examples.rst

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
pyro.multigrid.examples package
2+
===============================
3+
4+
.. automodule:: pyro.multigrid.examples
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
pyro.multigrid.examples.mg\_test\_general\_alphabeta\_only module
13+
-----------------------------------------------------------------
14+
15+
.. automodule:: pyro.multigrid.examples.mg_test_general_alphabeta_only
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
pyro.multigrid.examples.mg\_test\_general\_beta\_only module
21+
------------------------------------------------------------
22+
23+
.. automodule:: pyro.multigrid.examples.mg_test_general_beta_only
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.multigrid.examples.mg\_test\_general\_constant module
29+
----------------------------------------------------------
30+
31+
.. automodule:: pyro.multigrid.examples.mg_test_general_constant
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
pyro.multigrid.examples.mg\_test\_general\_dirichlet module
37+
-----------------------------------------------------------
38+
39+
.. automodule:: pyro.multigrid.examples.mg_test_general_dirichlet
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
pyro.multigrid.examples.mg\_test\_general\_inhomogeneous module
45+
---------------------------------------------------------------
46+
47+
.. automodule:: pyro.multigrid.examples.mg_test_general_inhomogeneous
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
pyro.multigrid.examples.mg\_test\_simple module
53+
-----------------------------------------------
54+
55+
.. automodule:: pyro.multigrid.examples.mg_test_simple
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
pyro.multigrid.examples.mg\_test\_vc\_constant module
61+
-----------------------------------------------------
62+
63+
.. automodule:: pyro.multigrid.examples.mg_test_vc_constant
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
pyro.multigrid.examples.mg\_test\_vc\_dirichlet module
69+
------------------------------------------------------
70+
71+
.. automodule:: pyro.multigrid.examples.mg_test_vc_dirichlet
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
pyro.multigrid.examples.mg\_test\_vc\_periodic module
77+
-----------------------------------------------------
78+
79+
.. automodule:: pyro.multigrid.examples.mg_test_vc_periodic
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
pyro.multigrid.examples.mg\_vis module
85+
--------------------------------------
86+
87+
.. automodule:: pyro.multigrid.examples.mg_vis
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
pyro.multigrid.examples.project\_periodic module
93+
------------------------------------------------
94+
95+
.. automodule:: pyro.multigrid.examples.project_periodic
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
pyro.multigrid.examples.prolong\_restrict\_demo module
101+
------------------------------------------------------
102+
103+
.. automodule:: pyro.multigrid.examples.prolong_restrict_demo
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:

0 commit comments

Comments
 (0)