Interface + base class for equation modulus

docs/source/_rst/_code.rst

@@ -195,19 +195,35 @@ Equations and Differential Operators
 .. toctree::
     :titlesonly:
 
-    EquationInterface <equation/equation_interface.rst>
+    Equation Interface <equation/equation_interface.rst>
+    Base Equation <equation/base_equation.rst>
     Equation <equation/equation.rst>
-    SystemEquation <equation/system_equation.rst>
+    System Equation <equation/system_equation.rst>
     Equation Factory <equation/equation_factory.rst>
     Differential Operators <operator.rst>
 
 
+Equations Zoo
+---------------------------------------
+
+.. toctree::
+    :titlesonly:
+
+    Acoustic Wave Equation <equation/zoo/acoustic_wave_equation.rst>
+    Advection Equation <equation/zoo/advection_equation.rst>
+    Allen-Cahn Equation <equation/zoo/allen_cahn_equation.rst>
+    Diffusion-Reaction Equation <equation/zoo/diffusion_reaction_equation.rst>
+    Helmholtz Equation <equation/zoo/helmholtz_equation.rst>
+    Poisson Equation <equation/zoo/poisson_equation.rst>
+
+
 Problems
 --------------
 
 .. toctree::
     :titlesonly:
 
+    ProblemInterface <problem/problem_interface.rst>
     AbstractProblem <problem/abstract_problem.rst>
     InverseProblem <problem/inverse_problem.rst>
     ParametricProblem <problem/parametric_problem.rst>
@@ -220,13 +236,13 @@ Problems Zoo
 .. toctree::
     :titlesonly:
 
-    AcousticWaveProblem <problem/zoo/acoustic_wave.rst>
-    AdvectionProblem <problem/zoo/advection.rst>
-    AllenCahnProblem <problem/zoo/allen_cahn.rst>
-    DiffusionReactionProblem <problem/zoo/diffusion_reaction.rst>
-    HelmholtzProblem <problem/zoo/helmholtz.rst>
-    InversePoisson2DSquareProblem <problem/zoo/inverse_poisson_2d_square.rst>
-    Poisson2DSquareProblem <problem/zoo/poisson_2d_square.rst>
+    AcousticWaveProblem <problem/zoo/acoustic_wave_problem.rst>
+    AdvectionProblem <problem/zoo/advection_problem.rst>
+    AllenCahnProblem <problem/zoo/allen_cahn_problem.rst>
+    DiffusionReactionProblem <problem/zoo/diffusion_reaction_problem.rst>
+    HelmholtzProblem <problem/zoo/helmholtz_problem.rst>
+    InversePoisson2DSquareProblem <problem/zoo/inverse_poisson_problem.rst>
+    Poisson2DSquareProblem <problem/zoo/poisson_problem.rst>
     SupervisedProblem <problem/zoo/supervised_problem.rst>
 
 

docs/source/_rst/equation/base_equation.rst

@@ -0,0 +1,7 @@
+Base Equation
+====================
+
+.. currentmodule:: pina.equation.base_equation
+.. autoclass:: pina._src.equation.base_equation.BaseEquation
+   :members:
+   :show-inheritance:

docs/source/_rst/equation/equation_factory.rst

@@ -21,23 +21,3 @@ Equation Factory
 .. autoclass:: pina._src.equation.equation_factory.Laplace
    :members:
    :show-inheritance:
-
-.. autoclass:: pina._src.equation.equation_factory.Advection
-   :members:
-   :show-inheritance:
-
-.. autoclass:: pina._src.equation.equation_factory.AllenCahn
-   :members:
-   :show-inheritance:
-
-.. autoclass:: pina._src.equation.equation_factory.DiffusionReaction
-   :members:
-   :show-inheritance:
-
-.. autoclass:: pina._src.equation.equation_factory.Helmholtz
-   :members:
-   :show-inheritance:
-
-.. autoclass:: pina._src.equation.equation_factory.Poisson
-   :members:
-   :show-inheritance:

docs/source/_rst/equation/zoo/acoustic_wave_equation.rst

@@ -0,0 +1,7 @@
+AcousticWaveEquation
+=====================
+.. currentmodule:: pina.equation.zoo.acoustic_wave_equation
+
+.. automodule:: pina._src.equation.zoo.acoustic_wave_equation
+    :members:
+    :show-inheritance:

docs/source/_rst/equation/zoo/advection_equation.rst

@@ -0,0 +1,7 @@
+Advection Equation
+=====================
+.. currentmodule:: pina.equation.zoo.advection_equation
+
+.. automodule:: pina._src.equation.zoo.advection_equation
+    :members:
+    :show-inheritance:

docs/source/_rst/equation/zoo/allen_cahn_equation.rst

@@ -0,0 +1,7 @@
+Allen Cahn Equation
+=====================
+.. currentmodule:: pina.equation.zoo.allen_cahn_equation
+
+.. automodule:: pina._src.equation.zoo.allen_cahn_equation
+    :members:
+    :show-inheritance:

docs/source/_rst/equation/zoo/diffusion_reaction_equation.rst

@@ -0,0 +1,7 @@
+Diffusion Reaction Equation
+==============================
+.. currentmodule:: pina.equation.zoo.diffusion_reaction_equation
+
+.. automodule:: pina._src.equation.zoo.diffusion_reaction_equation
+    :members:
+    :show-inheritance:

docs/source/_rst/equation/zoo/helmholtz_equation.rst

@@ -0,0 +1,9 @@
+Helmholtz Equation
+=====================
+.. currentmodule:: pina.equation.zoo.helmholtz_equation
+
+.. automodule:: pina._src.equation.zoo.helmholtz_equation
+
+.. autoclass:: pina._src.equation.zoo.helmholtz_equation.HelmholtzEquation
+    :members:
+    :show-inheritance:

docs/source/_rst/equation/zoo/poisson_equation.rst

@@ -0,0 +1,9 @@
+Poisson Equation
+=====================
+.. currentmodule:: pina.equation.zoo.poisson_equation
+
+.. automodule:: pina._src.equation.zoo.poisson_equation
+
+.. autoclass:: pina._src.equation.zoo.poisson_equation.PoissonEquation
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/problem_interface.rst

@@ -0,0 +1,9 @@
+ProblemInterface
+===================
+.. currentmodule:: pina.problem.problem_interface
+
+.. automodule:: pina._src.problem.problem_interface
+
+.. autoclass:: pina._src.problem.problem_interface.ProblemInterface
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/zoo/acoustic_wave_problem.rst

@@ -0,0 +1,9 @@
+AcousticWaveProblem
+=====================
+.. currentmodule:: pina.problem.zoo.acoustic_wave_problem
+
+.. automodule:: pina._src.problem.zoo.acoustic_wave_problem
+
+.. autoclass:: pina._src.problem.zoo.acoustic_wave_problem.AcousticWaveProblem
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/zoo/advection_problem.rst

@@ -0,0 +1,9 @@
+AdvectionProblem
+==================
+.. currentmodule:: pina.problem.zoo.advection_problem
+
+.. automodule:: pina._src.problem.zoo.advection_problem
+
+.. autoclass:: pina._src.problem.zoo.advection_problem.AdvectionProblem
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/zoo/allen_cahn_problem.rst

@@ -0,0 +1,9 @@
+AllenCahnProblem
+==================
+.. currentmodule:: pina.problem.zoo.allen_cahn_problem
+
+.. automodule:: pina._src.problem.zoo.allen_cahn_problem
+
+.. autoclass:: pina._src.problem.zoo.allen_cahn_problem.AllenCahnProblem
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/zoo/diffusion_reaction_problem.rst

@@ -0,0 +1,9 @@
+DiffusionReactionProblem
+=========================
+.. currentmodule:: pina.problem.zoo.diffusion_reaction_problem
+
+.. automodule:: pina._src.problem.zoo.diffusion_reaction_problem
+
+.. autoclass:: pina._src.problem.zoo.diffusion_reaction_problem.DiffusionReactionProblem
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/zoo/helmholtz_problem.rst

@@ -0,0 +1,9 @@
+HelmholtzProblem
+==================
+.. currentmodule:: pina.problem.zoo.helmholtz_problem
+
+.. automodule:: pina._src.problem.zoo.helmholtz_problem
+
+.. autoclass:: pina._src.problem.zoo.helmholtz_problem.HelmholtzProblem
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/zoo/inverse_poisson_problem.rst

@@ -0,0 +1,9 @@
+InversePoisson2DSquareProblem
+==============================
+.. currentmodule:: pina.problem.zoo.inverse_poisson_problem
+
+.. automodule:: pina._src.problem.zoo.inverse_poisson_problem
+
+.. autoclass::  pina._src.problem.zoo.inverse_poisson_problem.InversePoisson2DSquareProblem
+    :members:
+    :show-inheritance:

docs/source/_rst/problem/zoo/poisson_problem.rst

@@ -0,0 +1,9 @@
+Poisson2DSquareProblem
+========================
+.. currentmodule:: pina.problem.zoo.poisson_problem
+
+.. automodule:: pina._src.problem.zoo.poisson_problem
+
+.. autoclass:: pina._src.problem.zoo.poisson_problem.Poisson2DSquareProblem
+    :members:
+    :show-inheritance:

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