update documentation

Author: GiovanniCanali

pina/_src/condition/data_manager.py

@@ -7,7 +7,7 @@
 from torch_geometric.data.batch import Batch
 from pina import LabelTensor
 from pina._src.core.graph import Graph, LabelBatch
-from ..equation.equation_interface import EquationInterface
+from pina._src.equation.base_equation import BaseEquation
 from .batch_manager import _BatchManager
 
 
@@ -39,7 +39,7 @@ def __new__(cls, **kwargs):
 
         # Does the data contain only tensors/LabelTensors/Equations?
         is_tensor_only = all(
-            isinstance(v, (torch.Tensor, LabelTensor, EquationInterface))
+            isinstance(v, (torch.Tensor, LabelTensor, BaseEquation))
             for v in kwargs.values()
         )
         # Choose the appropriate subclass, GraphDataManager or TensorDataManager

pina/_src/condition/domain_equation_condition.py

@@ -2,7 +2,7 @@
 
 from pina._src.condition.condition_base import ConditionBase
 from pina._src.domain.domain_interface import DomainInterface
-from pina._src.equation.equation_interface import EquationInterface
+from pina._src.equation.base_equation import BaseEquation
 
 
 class DomainEquationCondition(ConditionBase):
@@ -32,7 +32,7 @@ class DomainEquationCondition(ConditionBase):
     __fields__ = ["domain", "equation"]
 
     _avail_domain_cls = (DomainInterface, str)
-    _avail_equation_cls = EquationInterface
+    _avail_equation_cls = BaseEquation
 
     def __new__(cls, domain, equation):
         """
@@ -52,7 +52,7 @@ def __new__(cls, domain, equation):
 
         if not isinstance(equation, cls._avail_equation_cls):
             raise ValueError(
-                "The equation must be an instance of EquationInterface."
+                "The equation must be an instance of BaseEquation."
             )
 
         return super().__new__(cls)

pina/_src/condition/input_equation_condition.py

@@ -3,7 +3,7 @@
 from pina._src.condition.condition_base import ConditionBase
 from pina._src.core.label_tensor import LabelTensor
 from pina._src.core.graph import Graph
-from pina._src.equation.equation_interface import EquationInterface
+from pina._src.equation.base_equation import BaseEquation
 from pina._src.condition.data_manager import _DataManager
 
 
@@ -32,7 +32,7 @@ class InputEquationCondition(ConditionBase):
     # Available input data types
     __fields__ = ["input", "equation"]
     _avail_input_cls = (LabelTensor, Graph)
-    _avail_equation_cls = EquationInterface
+    _avail_equation_cls = BaseEquation
 
     def __new__(cls, input, equation):
         """
@@ -41,7 +41,7 @@ def __new__(cls, input, equation):
 
         :param input: The input data for the condition.
         :type input: LabelTensor | Graph |  list[Graph] | tuple[Graph]
-        :param EquationInterface equation: The equation to be satisfied over the
+        :param BaseEquation equation: The equation to be satisfied over the
             specified ``input`` data.
         :return: The subclass of InputEquationCondition.
         :rtype: pina.condition.input_equation_condition.
@@ -61,7 +61,7 @@ def __new__(cls, input, equation):
         # Check equation type
         if not isinstance(equation, cls._avail_equation_cls):
             raise ValueError(
-                "The equation must be an instance of EquationInterface."
+                "The equation must be an instance of BaseEquation."
             )
 
         return super().__new__(cls)
@@ -90,7 +90,7 @@ def equation(self):
         Return the equation associated with this condition.
 
         :return: Equation associated with this condition.
-        :rtype: EquationInterface
+        :rtype: BaseEquation
         """
         return self._equation
 
@@ -99,11 +99,9 @@ def equation(self, value):
         """
         Set the equation associated with this condition.
 
-        :param EquationInterface value: The equation to associate with this
+        :param BaseEquation value: The equation to associate with this
             condition
         """
-        if not isinstance(value, EquationInterface):
-            raise TypeError(
-                "The equation must be an instance of EquationInterface."
-            )
+        if not isinstance(value, BaseEquation):
+            raise TypeError("The equation must be an instance of BaseEquation.")
         self._equation = value

pina/_src/solver/ensemble_solver/ensemble_pinn.py

@@ -145,7 +145,7 @@ def loss_phys(self, samples, equation):
         model. This method should not be overridden, if not intentionally.
 
         :param LabelTensor samples: The samples to evaluate the physics loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The computed physics loss.
         :rtype: LabelTensor
         """
@@ -161,7 +161,7 @@ def _residual_loss(self, samples, equation):
         method.
 
         :param LabelTensor samples: The samples to evaluate the loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The residual loss.
         :rtype: torch.Tensor
         """

pina/_src/solver/physics_informed_solver/causal_pinn.py

@@ -120,7 +120,7 @@ def loss_phys(self, samples, equation):
         provided samples and equation.
 
         :param LabelTensor samples: The samples to evaluate the physics loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The computed physics loss.
         :rtype: LabelTensor
         """

pina/_src/solver/physics_informed_solver/competitive_pinn.py

@@ -146,7 +146,7 @@ def loss_phys(self, samples, equation):
         provided samples and equation.
 
         :param LabelTensor samples: The samples to evaluate the physics loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The computed physics loss.
         :rtype: LabelTensor
         """

pina/_src/solver/physics_informed_solver/gradient_pinn.py

@@ -110,7 +110,7 @@ def loss_phys(self, samples, equation):
         provided samples and equation.
 
         :param LabelTensor samples: The samples to evaluate the physics loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The computed physics loss.
         :rtype: LabelTensor
         """

pina/_src/solver/physics_informed_solver/pinn.py

@@ -105,7 +105,7 @@ def loss_phys(self, samples, equation):
         provided samples and equation.
 
         :param LabelTensor samples: The samples to evaluate the physics loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The computed physics loss.
         :rtype: LabelTensor
         """

pina/_src/solver/physics_informed_solver/pinn_interface.py

@@ -176,7 +176,7 @@ def loss_phys(self, samples, equation):
         subclasses. It distinguishes different types of PINN solvers.
 
         :param LabelTensor samples: The samples to evaluate the physics loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The computed physics loss.
         :rtype: LabelTensor
         """
@@ -186,7 +186,7 @@ def compute_residual(self, samples, equation):
         Compute the residuals of the equation.
 
         :param LabelTensor samples: The samples to evaluate the loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The residual of the solution of the model.
         :rtype: LabelTensor
         """
@@ -204,7 +204,7 @@ def _residual_loss(self, samples, equation):
 
 
         :param LabelTensor samples: The samples to evaluate the loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The residual loss.
         :rtype: torch.Tensor
         """

pina/_src/solver/physics_informed_solver/self_adaptive_pinn.py

@@ -258,7 +258,7 @@ def loss_phys(self, samples, equation):
         provided samples and equation.
 
         :param LabelTensor samples: The samples to evaluate the physics loss.
-        :param EquationInterface equation: The governing equation.
+        :param BaseEquation equation: The governing equation.
         :return: The computed physics loss.
         :rtype: LabelTensor
         """