Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docstrings to the incompressible problems #279

Merged
merged 2 commits into from
Sep 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pyro/incompressible/problems/converge.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@
p(x,y,t) = -\cos(4 \pi (x - t)) - \cos(4 \pi (y - t))

The numerical solution can be compared to the exact solution to
measure the convergence rate of the algorithm.
measure the convergence rate of the algorithm. These initial
conditions come from Minion 1996.

"""

Expand Down
13 changes: 8 additions & 5 deletions pyro/incompressible/problems/shear.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@
Initialize the doubly periodic shear layer (see, for example, Martin
and Colella, 2000, JCP, 163, 271). This is run in a unit square
domain, with periodic boundary conditions on all sides. Here, the
initial velocity is::
initial velocity is:

/ tanh(rho_s (y-0.25)) if y <= 0.5
u(x,y,t=0) = <
\ tanh(rho_s (0.75-y)) if y > 0.5
.. math::

v(x,y,t=0) = delta_s sin(2 pi x)
u(x,y,t=0) = \begin{cases}
\tanh(\rho_s (y - 1/4)) & \mbox{if}~ y \le 1/2 \\
\tanh(\rho_s (3/4 - y)) & \mbox{if}~ y > 1/2
\end{cases}

.. math::

v(x,y,t=0) = \delta_s \sin(2 \pi x)
"""


Expand Down
13 changes: 8 additions & 5 deletions pyro/incompressible_viscous/problems/shear.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@
Initialize the doubly periodic shear layer (see, for example, Martin
and Colella, 2000, JCP, 163, 271). This is run in a unit square
domain, with periodic boundary conditions on all sides. Here, the
initial velocity is::
initial velocity is:

/ tanh(rho_s (y-0.25)) if y <= 0.5
u(x,y,t=0) = <
\ tanh(rho_s (0.75-y)) if y > 0.5
.. math::

v(x,y,t=0) = delta_s sin(2 pi x)
u(x,y,t=0) = \begin{cases}
\tanh(\rho_s (y - 1/4)) & \mbox{if}~ y \le 1/2 \\
\tanh(\rho_s (3/4 - y)) & \mbox{if}~ y > 1/2
\end{cases}

.. math::

v(x,y,t=0) = \delta_s \sin(2 \pi x)
"""


Expand Down