Equation Factory#

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

Bases: Equation

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

Initialization of the FixedValue class.

Parameters:

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

  • components (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.

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

Bases: Equation

Equation to enforce a fixed gradient for a specific condition.

Initialization of the FixedGradient class.

Parameters:

  • value (float) – The fixed value to be enforced to the gradient.

  • components (list[str]) – The name of the output variables for which the fixed gradient condition is applied. It should be a subset of the output labels. If None, all output variables are considered. Default is None.

  • d (list[str]) – The name of the input variables on which the gradient is computed. It should be a subset of the input labels. If None, all the input variables are considered. Default is None.

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

Bases: Equation

Equation to enforce a fixed flux, or divergence, for a specific condition.

Initialization of the FixedFlux class.

Parameters:

  • value (float) – The fixed value to be enforced to the flux.

  • components (list[str]) – The name of the output variables for which the fixed flux condition is applied. It should be a subset of the output labels. If None, all output variables are considered. Default is None.

  • d (list[str]) – The name of the input variables on which the flux is computed. It should be a subset of the input labels. If None, all the input variables are considered. Default is None.

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

Bases: Equation

Equation to enforce a null laplacian for a specific condition.

Initialization of the Laplace class.

Parameters:

  • components (list[str]) – The name of the output variables for which the null laplace condition is applied. It should be a subset of the output labels. If None, all output variables are considered. Default is None.

  • d (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.