Python extension

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.vscode/.DS_Store
+.vscode/c_cpp_properties.json
+.vscode/settings.json

heat_compare.py

@@ -0,0 +1,52 @@
+import pyheat # type: ignore
+import sys
+import matplotlib.pyplot as plt
+
+# Example of using the pyheat module to run a heat transfer simulation with two different numerical models.
+# The simulation is run for a 1D heat transfer problem with a constant heat source and no heat loss.
+# Run with the FTCS and Dufrank numerical models.
+# The results are plotted to compare the temperature profiles predicted by the two.
+
+# Initialize the problem with material properties and boundary conditions
+prob_index = pyheat.problem(1, 0.2, 0, 0, "const(3)")
+print(f"Initialized Problem Index: {prob_index}")
+
+# Initialize the solution for the problem with numerical model parameters
+ftcs_index = pyheat.solution(prob_index, 0.01, 0.00004, 0.04, 100, "ftcs")
+print(f"Initialized Solution Index: {ftcs_index}")
+
+# Initialize the solution for the problem with numerical model parameters
+dufrank_index = pyheat.solution(prob_index, 0.01, 0.00004, 0.04, 100, "dufrank")
+print(f"Initialized Solution Index: {dufrank_index}")
+
+# Run the simulation with the initialized solution and save settings
+ftcs_run_index = pyheat.run(ftcs_index, "heat_results", 100, 100)
+if ftcs_run_index < 0:
+    print("Problem running simulation")
+    sys.exit(1)
+
+dufrank_run_index = pyheat.run(dufrank_index, "heat_results", 100, 100)
+if dufrank_run_index < 0:
+    print("Problem running simulation")
+    sys.exit(1)
+
+# Return the simulation results
+ftcs_results = pyheat.results(ftcs_run_index)
+dufrank_results = pyheat.results(dufrank_run_index)
+print(f"Simulation results: {ftcs_results[4]}") # Temperature values at 4th index in array
+print(f"Simulation results: {dufrank_results[4]}") # Temperature values at 4th index in array
+
+# Plot the results
+x = [] # x values are the distance values
+for i in range (0,100): 
+    x.append(i*0.01) # iterates through the x values
+y1 = ftcs_results[4] # y values are the temperature values
+y2 = dufrank_results[4] # y values are the temperature values
+
+plt.xlabel('Distance (meters)')
+plt.ylabel('Temperature (Kelvin)')
+plt.plot(x,y1)
+plt.plot(x,y2)
+plt.show()
+sys.exit(0)
+

heat_ftcs.py

@@ -0,0 +1,53 @@
+import pyheat # type: ignore
+import sys
+import matplotlib.pyplot as plt
+
+# Example of using the pyheat module to run a heat transfer simulation
+# CLI command that would be used in C application: 
+# ./heat dx=0.01 dt=0.00004 bc1=0 ic="spikes(0,100,50)" maxt=0.04 outi=100 savi=100
+
+# Initialize the problem with material properties and boundary conditions
+prob_index = pyheat.problem(1, 0.2, 0, 0, "spikes(0,100,50)")
+print(f"Initialized Problem Index: {prob_index}")
+
+# Initialize the solution for the problem with numerical model parameters
+ftcs_index = pyheat.solution(prob_index, 0.01, 0.00004, 0.04, 100, "ftcs")
+print(f"Initialized Solution Index: {ftcs_index}")
+
+# Initialize the solution for the problem with numerical model parameters
+dufrank_index = pyheat.solution(prob_index, 0.01, 0.00004, 0.04, 100, "dufrank")
+print(f"Initialized Solution Index: {dufrank_index}")
+
+# Run the simulation with the initialized solution and save settings
+ftcs_run_index = pyheat.run(ftcs_index, "heat_results", 100, 100)
+if ftcs_run_index < 0:
+    print("Problem running simulation")
+    sys.exit(1)
+
+dufrank_run_index = pyheat.run(dufrank_index, "heat_results", 100, 100)
+if dufrank_run_index < 0:
+    print("Problem running simulation")
+    sys.exit(1)
+
+# Return the simulation results
+ftcs_results = pyheat.results(ftcs_run_index)
+dufrank_results = pyheat.results(dufrank_run_index)
+print(f"Simulation results: {ftcs_results[4]}") # Temperature values at 4th index in array
+print(f"Simulation results: {dufrank_results[4]}") # Temperature values at 4th index in array
+
+
+
+# Plot the results
+x = [] # x values are the distance values
+for i in range (0,100): 
+    x.append(i*0.01) # iterates through the x values
+y1 = ftcs_results[4] # y values are the temperature values
+y2 = dufrank_results[4] # y values are the temperature values
+
+plt.xlabel('Distance (meters)')
+plt.ylabel('Temperature (Kelvin)')
+plt.plot(x,y1)
+plt.plot(x,y2)
+plt.show()
+sys.exit(0)
+

makefile

@@ -15,8 +15,13 @@ RM = rm
 HDR = Number.h heat.h
 # Source Files
 SRC = heat.c utils.c args.c exact.c ftcs.c crankn.c dufrank.c
+# Python Source Files
+pySRC = pyheat.c
 # Object Files
 OBJ = $(SRC:.c=.o)
+# Python Object Files
+pyOBJ = $(pySRC:.c=.o)
+pySO = $(pySRC:.c=.so)
 # Coverage Files
 GCOV = $(SRC:.c=.c.gcov) $(SRC:.c=.gcda) $(SRC:.c=.gcno) $(HDR:.h=.h.gcov)
 # Executable
@@ -34,10 +39,12 @@ help:
 	@echo "    heat-single: makes the heat application with single precision" 
 	@echo "    heat-double: makes the heat application with double precision" 
 	@echo "    heat-long-double: makes the heat application with long-double precision" 
+	@echo "    pyheat.so: makes the python-extension of the heat application"
 	@echo "    PTOOL=[gnuplot,matplotlib,visit] RUNAME=<run-dir-name> plot: plots results"
 	@echo "    check: runs various tests confirming steady-state is linear"
 
 
+
 # Linking the final heat app
 heat: $(OBJ)
 	$(CC) -o heat $(OBJ) $(LDFLAGS) -lm
@@ -89,7 +96,8 @@ check_clean:
 	$(RM) -rf heat heat-omp heat-half heat-single heat-double heat-long-double
 
 clean: check_clean
-	$(RM) -f $(OBJ) $(EXE) $(GCOV)
+	$(RM) -f $(OBJ) $(EXE) $(GCOV) $(pyOBJ) $(pySO)
+# added Python shared library [rene] 
 
 #
 # Run for a long time with random initial condition
@@ -135,3 +143,14 @@ check_dufrank: heat check_dufrank/check_dufrank_soln_final.curve
 	./python_testing/check_lss.py check_dufrank/check_dufrank_soln_final.curve $(ERRBND)
 
 check_all: check_ftcs check_crankn check_dufrank
+
+PYTHON_INCLUDES := $(shell python3-config --includes)
+PYTHON_LDFLAGS := $(shell python3-config --ldflags) -lpython3.12
+
+# Target to build the Python extension module
+pyheat.so: $(pyOBJ) $(OBJ)
+	cc -shared -o $(pySO) $(pyOBJ) $(OBJ) -lm $(PYTHON_LDFLAGS)
+
+# Compile pyheat.c into pyheat.o
+pyheat.o: $(pySRC)
+	cc -c -fPIC $(pySRC) -o $(pyOBJ) -I. $(PYTHON_INCLUDES)