Change default coefficient of ImplicitSourceTerm to 1

Fixes #512
usnistgov · Dec 7, 2023 · cbc0b38 · cbc0b38
1 parent fcf3dfb
commit cbc0b38
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/fipy/terms/implicitSourceTerm.py b/fipy/terms/implicitSourceTerm.py
@@ -20,6 +20,18 @@ class ImplicitSourceTerm(SourceTerm):
     where :math:`S` is the `coeff` value.
     """
 
+    def __init__(self, coeff=1., var=None):
+        r"""
+        Parameters
+        ----------
+        coeff : float or ~fipy.variables.cellVariable.CellVariable
+            Proportiounality coefficient :math:`S` (default: 1)
+        var : ~fipy.variables.cellVariable.CellVariable
+            Variable :math:`\phi` that
+            :class:`~fipy.terms.sourcTerm.SourceTerm` is implicit in.
+        """
+        super(self, ImplicitSourceTerm).__init__(coeff=coeff, var=var)
+
     def _getWeight(self, var, transientGeomCoeff=None, diffusionGeomCoeff=None):
         """
         Test for a bug due to the sign operator not being updating

diff --git a/fipy/terms/sourceTerm.py b/fipy/terms/sourceTerm.py
@@ -15,6 +15,15 @@ class SourceTerm(CellTerm):
     .. attention:: This class is abstract. Always create one of its subclasses.
     """
     def __init__(self, coeff=0., var=None):
+        r"""
+        Parameters
+        ----------
+        coeff : float or ~fipy.variables.cellVariable.CellVariable
+            Coefficient of source (default: 0)
+        var : ~fipy.variables.cellVariable.CellVariable
+            Variable :math:`\phi` that :class:`~fipy.terms.term.Term` is
+            implicit in.
+        """
         if self.__class__ is SourceTerm:
             raise AbstractBaseClassError
         CellTerm.__init__(self, coeff=coeff, var=var)