Started KSP doc

Signed-off-by: Umberto Zerbinati <[email protected]>

docs/src/index.rst

@@ -12,6 +12,12 @@ Welcome to ngsPETSc's documentation!
 
    install
 
+.. toctree::
+   :maxdepth: 1
+   :caption: PETSc KSP
+
+   PETScKSP/poisson.py
+
 .. toctree::
    :maxdepth: 1
    :caption: PETSc PC

ngsPETSc/ksp.py

@@ -12,31 +12,31 @@ def createFromBilinearForm(a, freeDofs, solverParameters):
     """
     a.Assemble()
     #Setting deafult matrix type
-    if "mat_type" not in solverParameters:
-        solverParameters["mat_type"] = "aij"
+    if "ngs_mat_type" not in solverParameters:
+        solverParameters["ngs_mat_type"] = "aij"
     #Assembling matrix if not of type Python
-    if solverParameters["mat_type"] not in ["python"]:
+    if solverParameters["ngs_mat_type"] not in ["python"]:
         if hasattr(a.mat, "row_pardofs"):
             dofs = a.mat.row_pardofs
         else:
             dofs = None
-        mat = Matrix(a.mat, (dofs, freeDofs, None), solverParameters["mat_type"])
+        mat = Matrix(a.mat, (dofs, freeDofs, None), solverParameters["ngs_mat_type"])
     return (a.mat, mat.mat)
 
 def createFromMatrix(a, freeDofs, solverParameters):
     """
     This function creates a PETSc matrix from an NGSolve bilinear form
     """
     #Setting deafult matrix type
-    if "mat_type" not in solverParameters:
-        solverParameters["mat_type"] = "aij"
+    if "ngs_mat_type" not in solverParameters:
+        solverParameters["ngs_mat_type"] = "aij"
     #Assembling matrix if not of type Python
-    if solverParameters["mat_type"] not in ["python"]:
+    if solverParameters["ngs_mat_type"] not in ["python"]:
         if hasattr(a, "row_pardofs"):
             dofs = a.row_pardofs
         else:
             dofs = None
-        mat = Matrix(a, (dofs, freeDofs, None), solverParameters["mat_type"])
+        mat = Matrix(a, (dofs, freeDofs, None), solverParameters["ngs_mat_type"])
     return (a, mat.mat)
 
 def createFromPC(a, freeDofs, solverParameters):

setup.py

@@ -39,7 +39,7 @@
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    packages=["ngsPETSc", "ngsPETSc.utils", "ngsPETSc.utils.firedrake"],
+    packages=["ngsPETSc", "ngsPETSc.utils", "ngsPETSc.utils.firedrake", "ngsPETSc.utils.ngs"],
     python_requires = ">=3.8",
     install_requires=install_requires