Interface + base class for problem modulus

docs/source/_rst/_code.rst

@@ -208,7 +208,8 @@ Problems
 .. toctree::
     :titlesonly:
 
-    AbstractProblem <problem/abstract_problem.rst>
+    ProblemInterface <problem/problem_interface.rst>
+    BaseProblem <problem/base_problem.rst>
     InverseProblem <problem/inverse_problem.rst>
     ParametricProblem <problem/parametric_problem.rst>
     SpatialProblem <problem/spatial_problem.rst>
@@ -220,13 +221,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/problem/base_problem.rst

@@ -0,0 +1,9 @@
+Base Problem
+===============
+.. currentmodule:: pina.problem.base_problem
+
+.. automodule:: pina._src.problem.base_problem
+
+.. autoclass:: pina._src.problem.base_problem.BaseProblem
+    :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/condition.py

@@ -12,7 +12,7 @@ class Condition:
     """
     The :class:`Condition` class is a core component of the PINA framework that
     provides a unified interface to define heterogeneous constraints that must
-    be satisfied by a :class:`~pina.problem.abstract_problem.AbstractProblem`.
+    be satisfied by a :class:`~pina.problem.base_problem.BaseProblem`.
 
     It encapsulates all types of constraints - physical, boundary, initial, or
     data-driven - that the solver must satisfy during training. The specific

pina/_src/condition/condition_base.py

@@ -42,7 +42,7 @@ def problem(self):
         Return the problem associated with this condition.
 
         :return: Problem associated with this condition.
-        :rtype: ~pina.problem.abstract_problem.AbstractProblem
+        :rtype: ~pina.problem.base_problem.BaseProblem
         """
         return self._problem
 
@@ -51,8 +51,8 @@ def problem(self, value):
         """
         Set the problem associated with this condition.
 
-        :param pina.problem.abstract_problem.AbstractProblem value: The problem
-            to associate with this condition
+        :param pina.problem.base_problem.BaseProblem value: The problem to
+            associate with this condition.
         """
         self._problem = value
 

pina/_src/condition/condition_interface.py

@@ -25,7 +25,7 @@ def problem(self):
         Return the problem associated with this condition.
 
         :return: Problem associated with this condition.
-        :rtype: ~pina.problem.abstract_problem.AbstractProblem
+        :rtype: ~pina.problem.base_problem.BaseProblem
         """
 
     @problem.setter
@@ -34,7 +34,7 @@ def problem(self, value):
         """
         Set the problem associated with this condition.
 
-        :param pina.problem.abstract_problem.AbstractProblem value: The problem
+        :param pina.problem.base_problem.BaseProblem value: The problem
             to associate with this condition
         """
 

pina/_src/core/trainer.py

@@ -48,7 +48,7 @@ def __init__(
 
         :param SolverInterface solver: A
             :class:`~pina.solver.solver.SolverInterface` solver used to solve a
-            :class:`~pina.problem.abstract_problem.AbstractProblem`.
+            :class:`~pina.problem.base_problem.BaseProblem`.
         :param int batch_size: The number of samples per batch to load.
             If ``None``, all samples are loaded and data is not batched.
             Default is ``None``.
@@ -184,7 +184,7 @@ def __init__(
     def _move_to_device(self):
         """
         Moves the ``unknown_parameters`` of an instance of
-        :class:`~pina.problem.abstract_problem.AbstractProblem` to the
+        :class:`~pina.problem.base_problem.BaseProblem` to the
         :class:`Trainer` device.
         """
         device = self._accelerator_connector._parallel_devices[0]

pina/_src/core/utils.py

@@ -93,9 +93,9 @@ def labelize_forward(forward, input_variables, output_variables):
 
     :param Callable forward: The forward function of a :class:`torch.nn.Module`.
     :param list[str] input_variables: The names of the input variables of a
-        :class:`~pina.problem.abstract_problem.AbstractProblem`.
+        :class:`~pina.problem.base_problem.BaseProblem`.
     :param list[str] output_variables: The names of the output variables of a
-        :class:`~pina.problem.abstract_problem.AbstractProblem`.
+        :class:`~pina.problem.base_problem.BaseProblem`.
     :return: The decorated forward function.
     :rtype: Callable
     """

pina/_src/data/data_module.py

@@ -84,7 +84,7 @@ def __init__(
         """
         Initialize the object and creating datasets based on the input problem.
 
-        :param AbstractProblem problem: The problem containing the data on which
+        :param BaseProblem problem: The problem containing the data on which
             to create the datasets and dataloaders.
         :param float train_size: Fraction of elements in the training split. It
             must be in the range [0, 1].