8b7b61b3bd
* Adding Equations, solving typos * improve _code.rst * the team rst and restuctore index.rst * fixing errors --------- Co-authored-by: Dario Coscia <dariocoscia@dhcp-015.eduroam.sissa.it>
34 lines
1.1 KiB
Python
34 lines
1.1 KiB
Python
""" Module for Equation. """
|
|
from .equation_interface import EquationInterface
|
|
|
|
|
|
class Equation(EquationInterface):
|
|
|
|
def __init__(self, equation):
|
|
"""
|
|
Equation class for specifing any equation in PINA.
|
|
Each ``equation`` passed to a ``Condition`` object
|
|
must be an ``Equation`` or ``SystemEquation``.
|
|
|
|
:param equation: A ``torch`` callable equation to
|
|
evaluate the residual.
|
|
:type equation: Callable
|
|
"""
|
|
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_):
|
|
"""
|
|
Residual computation of the equation.
|
|
|
|
:param LabelTensor input_: Input points to evaluate the equation.
|
|
:param LabelTensor output_: Output vectors given my a model (e.g,
|
|
a ``FeedForward`` model).
|
|
:return: The residual evaluation of the specified equation.
|
|
:rtype: LabelTensor
|
|
"""
|
|
return self.__equation(input_, output_)
|