Fixed Laplacian#

Module for defining the fixed laplacian equation.

class FixedLaplacian(value, components=None, d=None)[source]#

Bases: Equation

Equation to enforce a fixed laplacian for a specific condition.

Initialization of the FixedLaplacian class.

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 is None.

  • 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 is None.

Raises:
  • ValueError – If value is neither a float nor an integer.

  • ValueError – If, when provided, components is neither a string nor a list of strings.

  • ValueError – If, when provided, d is neither a string nor a list of strings.

class Laplace(components=None, d=None)[source]#

Bases: FixedLaplacian

Initialization of the FixedLaplacian class.

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 is None.

  • 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 is None.

Raises:
  • ValueError – If value is neither a float nor an integer.

  • ValueError – If, when provided, components is neither a string nor a list of strings.

  • ValueError – If, when provided, d is neither a string nor a list of strings.