kees-study/cds-numerical-methods
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

10: Attempt to write a comprehensive yet redundant docstring

Browse Source
This commit is contained in:
Kees van Kempen
2022-03-15 16:06:37 +01:00
parent a5353c7cf7
commit f56c5c26df
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Week 6/10 Hyperbolic PDEs.ipynb
View File

@ -387,7 +387,17 @@
"outputs": [], "outputs": [],
"source": [ "source": [
"def test_pdeHyperbolic():\n", "def test_pdeHyperbolic():\n",
" # TODO: Docstring\n", " \"\"\"\n",
" Check that function pdeHyperbolic returns solutions for the PDE\n",
" ∂^2/∂𝑡^2 𝑢(𝑥,𝑡) − ∂^2/∂𝑥^2 𝑢(𝑥,𝑡) = 0 for boundary conditions given by\n",
" 𝑢(0, t) = 0 = 𝑢(x[-1], t) for all 0 <= t <= 1\n",
" y(x, 0) = f(x) for all 0 <= x <= 1\n",
" ∂𝑢(x, t)/∂t = g(x) for t = 0 and all 0 <= x <= 1\n",
" that are within tolerance (TOL = 1e-5) of the exact solution\n",
" 𝑢(𝑥,𝑡) = sin(2𝜋𝑥)(cos(2𝜋𝑡)+sin(2𝜋𝑡)),\n",
" using a grid of x and t values of each 1200 equidistant points.\n",
" \"\"\"\n",
" \n",
" a = 1\n", " a = 1\n",
" l = 1\n", " l = 1\n",
" x = np.linspace(0, l, 1200)\n", " x = np.linspace(0, l, 1200)\n",