add burgers problem

Author: GiovanniCanali

docs/source/_rst/_code.rst

@@ -256,6 +256,7 @@ Problem Zoo
     AcousticWaveProblem <problem/zoo/acoustic_wave_problem.rst>
     AdvectionProblem <problem/zoo/advection_problem.rst>
     AllenCahnProblem <problem/zoo/allen_cahn_problem.rst>
+    BurgersProblem <problem/zoo/burgers_problem.rst>
     DiffusionReactionProblem <problem/zoo/diffusion_reaction_problem.rst>
     HelmholtzProblem <problem/zoo/helmholtz_problem.rst>
     InversePoisson2DSquareProblem <problem/zoo/inverse_poisson_problem.rst>

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

@@ -0,0 +1,9 @@
+Burgers Problem
+=====================
+.. currentmodule:: pina.problem.zoo.burgers_problem
+
+.. automodule:: pina._src.problem.zoo.burgers_problem
+
+.. autoclass:: pina._src.problem.zoo.burgers_problem.BurgersProblem
+    :members:
+    :show-inheritance:

pina/_src/equation/zoo/burgers_equation.py

@@ -30,7 +30,7 @@ def __init__(self, nu):
         check_consistency(nu, (float, int))
         if nu < 0:
             raise ValueError(
-                "The viscosity ``nu`` must be a positive float or int."
+                "The viscosity ``nu`` must be a non-negative float or int."
             )
 
         # Store viscosity coefficient

pina/_src/problem/zoo/burgers_problem.py

@@ -0,0 +1,79 @@
+"""Formulation of the burgers problem."""
+
+import torch
+from pina._src.problem.time_dependent_problem import TimeDependentProblem
+from pina._src.domain.cartesian_domain import CartesianDomain
+from pina._src.problem.spatial_problem import SpatialProblem
+from pina._src.condition.condition import Condition
+from pina._src.core.utils import check_consistency
+from pina._src.equation.equation import Equation
+from pina._src.equation.zoo.fixed_value import FixedValue
+from pina._src.equation.zoo.burgers_equation import BurgersEquation
+
+
+def initial_condition(input_, output_):
+    """
+    Definition of the initial condition of the burgers problem.
+
+    :param LabelTensor input_: The input data of the problem.
+    :param LabelTensor output_: The output data of the problem.
+    :return: The residual of the initial condition.
+    :rtype: LabelTensor
+    """
+    return output_ + torch.sin(torch.pi * input_["x"])
+
+
+class BurgersProblem(TimeDependentProblem, SpatialProblem):
+    r"""
+    Implementation of the burgers problem in the spatial interval
+    :math:`[-1, 1]` and temporal interval :math:`[0, 1]`.
+
+    .. seealso::
+
+        **Original reference**: Raissi M., Perdikaris P., Karniadakis G. E.
+        (2017).
+        *Physics Informed Deep Learning (Part I): Data-driven Solutions of
+        Nonlinear Partial Differential Equations*.
+        DOI: `10.48550 <https://doi.org/10.48550/arXiv.1711.10561>`_.
+
+    :Example:
+
+        >>> problem = BurgersProblem()
+    """
+
+    output_variables = ["u"]
+    spatial_domain = CartesianDomain({"x": [-1, 1]})
+    temporal_domain = CartesianDomain({"t": [0, 1]})
+
+    domains = {
+        "D": spatial_domain.update(temporal_domain),
+        "t0": spatial_domain.update(CartesianDomain({"t": 0})),
+        "boundary": spatial_domain.partial().update(temporal_domain),
+    }
+
+    conditions = {
+        "boundary": Condition(domain="boundary", equation=FixedValue(0.0)),
+        "t0": Condition(domain="t0", equation=Equation(initial_condition)),
+    }
+
+    def __init__(self, nu=0):
+        """
+        Initialization of the :class:`BurgersProblem` class.
+
+        :param nu: The viscosity coefficient.
+        :type nu: float | int
+        :raises ValueError: If ``nu`` is not a float or an int.
+        :raises ValueError: If ``nu`` is negative.
+        """
+        super().__init__()
+
+        # Check consistency
+        check_consistency(nu, (float, int))
+        if nu < 0:
+            raise ValueError(
+                "The viscosity ``nu`` must be a non-negative float or int."
+            )
+
+        self.conditions["D"] = Condition(
+            domain="D", equation=BurgersEquation(nu)
+        )

pina/problem/zoo.py

@@ -9,6 +9,7 @@
     "DiffusionReactionProblem",
     "InversePoisson2DSquareProblem",
     "AcousticWaveProblem",
+    "BurgersProblem",
 ]
 
 from pina._src.problem.zoo.acoustic_wave_problem import AcousticWaveProblem
@@ -17,6 +18,7 @@
 from pina._src.problem.zoo.advection_problem import AdvectionProblem
 from pina._src.problem.zoo.helmholtz_problem import HelmholtzProblem
 from pina._src.problem.zoo.poisson_problem import Poisson2DSquareProblem
+from pina._src.problem.zoo.burgers_problem import BurgersProblem
 from pina._src.problem.zoo.diffusion_reaction_problem import (
     DiffusionReactionProblem,
 )

tests/test_problem_zoo/test_burgers_problem.py

@@ -0,0 +1,23 @@
+import pytest
+from pina.problem.zoo import BurgersProblem
+from pina.problem import SpatialProblem, TimeDependentProblem
+
+
+@pytest.mark.parametrize("nu", [0.1, 1])
+def test_constructor(nu):
+
+    problem = BurgersProblem(nu=nu)
+    problem.discretise_domain(n=10, mode="random", domains=None)
+    assert problem.are_all_domains_discretised
+    assert isinstance(problem, SpatialProblem)
+    assert isinstance(problem, TimeDependentProblem)
+    assert hasattr(problem, "conditions")
+    assert isinstance(problem.conditions, dict)
+
+    # Should fail if nu is not a float or int
+    with pytest.raises(ValueError):
+        BurgersProblem(nu="invalid")
+
+    # Should fail if nu is negative
+    with pytest.raises(ValueError):
+        BurgersProblem(nu=-0.1)