Fixed Value#

Module for defining the fixed value equation.

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

Bases: Equation

Equation to enforce a fixed value. Can be used to enforce Dirichlet Boundary conditions.

Example:
>>> from pina.equation import FixedValue
>>> eq = FixedValue(value=0.0)
>>> # Use within a Condition:
>>> # condition = Condition(domain=domain, equation=eq)

Initialization of the FixedValue class.

Parameters:

  • value (float | int) – The fixed value to be enforced.

  • components (str | list[str]) – The name of the output variables for which the fixed value condition is applied. It should be a subset of the output labels. If None, all output 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.