Fixed Laplacian#
Module for defining the fixed laplacian equation.
- class FixedLaplacian(value, components=None, d=None)[source]#
Bases:
EquationEquation to enforce a fixed laplacian for a specific condition.
Initialization of the
FixedLaplacianclass.- Parameters:
value (float | int) – The fixed value to be enforced to the laplacian.
components (str | list[str]) – The name of the output variables for which the fixed laplace condition is applied. It should be a subset of the output labels. If
None, all output variables are considered. Default isNone.d (str | list[str]) – The name of the input variables on which the laplacian is computed. It should be a subset of the input labels. If
None, all the input variables are considered. Default isNone.
- Raises:
ValueError – If
valueis neither a float nor an integer.ValueError – If, when provided,
componentsis neither a string nor a list of strings.ValueError – If, when provided,
dis neither a string nor a list of strings.
- class Laplace(components=None, d=None)[source]#
Bases:
FixedLaplacianInitialization of the
FixedLaplacianclass.- Parameters:
value (float | int) – The fixed value to be enforced to the laplacian.
components (str | list[str]) – The name of the output variables for which the fixed laplace condition is applied. It should be a subset of the output labels. If
None, all output variables are considered. Default isNone.d (str | list[str]) – The name of the input variables on which the laplacian is computed. It should be a subset of the input labels. If
None, all the input variables are considered. Default isNone.
- Raises:
ValueError – If
valueis neither a float nor an integer.ValueError – If, when provided,
componentsis neither a string nor a list of strings.ValueError – If, when provided,
dis neither a string nor a list of strings.