Skip to content
Open
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
Binary file added Coverage report.pdf
Binary file not shown.
9 changes: 8 additions & 1 deletion diffusion2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,21 @@ def __init__(self):
self.dt = None

def initialize_domain(self, w=10., h=10., dx=0.1, dy=0.1):
assert isinstance(w, float)
assert isinstance(h, float)
assert isinstance(dx, float)
assert isinstance(dy, float)
self.w = w
self.h = h
self.dx = dx
self.dy = dy
self.nx = int(w / dx)
self.ny = int(h / dy)

def initialize_physical_parameters(self, d=4., T_cold=300, T_hot=700):
def initialize_physical_parameters(self, d=4., T_cold=300.0, T_hot=700.0):
assert isinstance(d, float)
assert isinstance(T_cold, float)
assert isinstance(T_hot, float)
self.D = d
self.T_cold = T_cold
self.T_hot = T_hot
Expand Down
9 changes: 9 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Testing & Tools
pytest>=7.0.0
pytest-cov>=4.0.0
tox>=4.0.0
coverage>=7.0.0

# Data Science / Plotting
numpy
matplotlib
35 changes: 32 additions & 3 deletions tests/integration/test_diffusion2d.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,48 @@
"""
Tests for functionality checks in class SolveDiffusion2D
"""

import numpy as np
import pytest
from diffusion2d import SolveDiffusion2D

@pytest.fixture
def initial_values():
return {
"w": 5.0, "h": 5.0, "dx": 0.2, "dy": 0.2, "d": 3.5, "T_cold": 290.0, "T_hot": 750.0}

def test_initialize_physical_parameters():
def test_initialize_physical_parameters(initial_values):
"""
Checks function SolveDiffusion2D.initialize_domain
"""
solver = SolveDiffusion2D()
solver.initialize_domain(w=initial_values["w"], h=initial_values["h"], dx=initial_values["dx"], dy=initial_values["dy"])

d = initial_values["d"]

dx2, dy2 = solver.dx * solver.dx, solver.dy * solver.dy
dt = dx2 * dy2 / (2 * d * (dx2 + dy2))

solver.initialize_physical_parameters(d=initial_values["d"], T_cold=initial_values["T_cold"], T_hot=initial_values["T_hot"])
assert solver.dt == dt

def test_set_initial_condition():
def test_set_initial_condition(initial_values):
"""
Checks function SolveDiffusion2D.get_initial_function
"""
solver = SolveDiffusion2D()
solver.initialize_domain(w=initial_values["w"], h=initial_values["h"], dx=initial_values["dx"], dy=initial_values["dy"])
solver.initialize_physical_parameters(d=initial_values["d"], T_cold=initial_values["T_cold"], T_hot=initial_values["T_hot"])
u_test = solver.T_cold * np.ones((solver.nx, solver.ny))
r, cx, cy = 2, 5, 5
r2 = r ** 2
for i in range(solver.nx):
for j in range(solver.ny):
p2 = (i * solver.dx - cx) ** 2 + (j * solver.dy - cy) ** 2
if p2 < r2:
u_test[i, j] = solver.T_hot

ground_truth = u_test.copy()

test_value = solver.set_initial_condition()

assert np.array_equal(ground_truth, test_value)
30 changes: 30 additions & 0 deletions tests/unit/test_diffusion2d_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Tests for functions in class SolveDiffusion2D
"""

import pytest, numpy as np
from diffusion2d import SolveDiffusion2D


Expand All @@ -10,17 +11,46 @@ def test_initialize_domain():
Check function SolveDiffusion2D.initialize_domain
"""
solver = SolveDiffusion2D()
solver.initialize_domain(w=5.0, h=5.0, dx=0.2, dy=0.2)
assert solver.nx == 25
assert solver.ny == 25


def test_initialize_physical_parameters():
"""
Checks function SolveDiffusion2D.initialize_domain
"""
solver = SolveDiffusion2D()
solver.dx = 0.2
solver.dy = 0.2
solver.D = 3.5
solver.initialize_physical_parameters(d=3.5, T_cold=290.0, T_hot=750.0)
assert solver.dt == pytest.approx(0.002857142857142857, rel=1e-6)


def test_set_initial_condition():
"""
Checks function SolveDiffusion2D.get_initial_function
"""
solver = SolveDiffusion2D()
solver.nx = 100
solver.ny = 100
solver.dx = 0.1
solver.dy = 0.1
solver.T_cold = 300.0
solver.T_hot = 750.0

u = solver.set_initial_condition()


u_test = solver.T_cold * np.ones((solver.nx, solver.ny))
r, cx, cy = 2, 5, 5
r2 = r ** 2
for i in range(solver.nx):
for j in range(solver.ny):
p2 = (i * solver.dx - cx) ** 2 + (j * solver.dy - cy) ** 2
if p2 < r2:
u_test[i, j] = solver.T_hot

ground_truth = u_test.copy()
assert np.array_equal(ground_truth, u)
12 changes: 12 additions & 0 deletions tox.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[tox]
env_list = ["pytest"]

[env_common]
# Common settings to avoid repetition
base_python = ["python3.9"]
deps = ["-rrequirements.txt"]

[env.pytest_env]
description = "Run tests using pytest"
deps = ["-rrequirements.txt"]
commands = [["pytest"]]