48 lines
1.8 KiB
Python
48 lines
1.8 KiB
Python
"""Module for the Equation."""
|
|
|
|
from .equation_interface import EquationInterface
|
|
|
|
|
|
class Equation(EquationInterface):
|
|
"""
|
|
Implementation of the Equation class. Every ``equation`` passed to a
|
|
:class:`~pina.condition.Condition` object must be either a :class:`Equation`
|
|
or a :class:`~pina.equation.SystemEquation` instance.
|
|
"""
|
|
|
|
def __init__(self, equation):
|
|
"""
|
|
Initialization of the :class:`Equation` class.
|
|
|
|
:param Callable equation: A ``torch`` callable function used to compute
|
|
the residual of a mathematical equation.
|
|
:raises ValueError: If the equation is not a callable function.
|
|
"""
|
|
if not callable(equation):
|
|
raise ValueError(
|
|
"equation must be a callable function."
|
|
"Expected a callable function, got "
|
|
f"{equation}"
|
|
)
|
|
self.__equation = equation
|
|
|
|
def residual(self, input_, output_, params_=None):
|
|
"""
|
|
Compute the residual of the equation.
|
|
|
|
:param LabelTensor input_: Input points where the equation is evaluated.
|
|
:param LabelTensor output_: Output tensor, eventually produced by a
|
|
:class:`~torch.nn.Module` instance.
|
|
:param dict params_: Dictionary of unknown parameters, associated with a
|
|
:class:`~pina.problem.InverseProblem` instance. If the equation is
|
|
not related to a :class:`~pina.problem.InverseProblem` instance, the
|
|
parameters must be initialized to ``None``. Default is ``None``.
|
|
:return: The computed residual of the equation.
|
|
:rtype: LabelTensor
|
|
"""
|
|
if params_ is None:
|
|
result = self.__equation(input_, output_)
|
|
else:
|
|
result = self.__equation(input_, output_, params_)
|
|
return result
|