FELiCS.Equation.Equations.EquationTemplate

FELiCS.Equation.Equations.EquationTemplate#

Module Contents#

Classes#

EquationTemplate

A base class for equation templates.
class FELiCS.Equation.Equations.EquationTemplate.EquationTemplate(index, eqColl, fluc, X, param)#

Bases: abc.ABC

A base class for equation templates.

This abstract base class provides a structure for defining equations within a given coordinate system and with specified parameters. It interfaces with a collection of equations and fluctuation data.

Initialize the EquationTemplate object

Parameters:

  • index (int) – The index of the equation.

  • eqColl (EquationCollection) – The equation collection object.

  • fluc (Fluctuations) – The fluctuations object.

  • X (CoordinateSystem) – The coordinate system object.

  • param (dict) – The parameters for the equation.

Variables:

  • J_hat (ndarray) – The J_hat attribute of the coordinate system.

  • param (dict) – The parameters for the equation.

  • fluc (Fluctuations) – The fluctuations object.

  • X (CoordinateSystem) – The coordinate system object.

  • n (int) – The value of n.

  • all_ds (list) – The list of all ds.

  • ds (list) – The list of ds.

abstractmethod addWeightMatrixExpression()#

Define the weight matrix expression.

This abstract method must be implemented by subclasses to specify how the weight matrix is constructed.

abstractmethod addLinearExpression()#

Define the linear expression.

This abstract method must be implemented by subclasses to specify the linear part of the equation.

abstractmethod addNonlinearExpression()#

Define the nonlinear expression.

This abstract method must be implemented by subclasses to specify the nonlinear part of the equation.

addBilinearExpression(*args)#

Optionally define a bilinear expression.

Parameters:

*args (tuple) – Optional arguments required for the bilinear expression.

Contents