:py:mod:`FELiCS.Equation.Equations.EquationTemplate`
====================================================

.. py:module:: FELiCS.Equation.Equations.EquationTemplate


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   FELiCS.Equation.Equations.EquationTemplate.EquationTemplate




.. py:class:: EquationTemplate(index, eqColl, fluc, X, param)


   Bases: :py:obj:`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**

   :param index: The index of the equation.
   :type index: :py:class:`int`
   :param eqColl: The equation collection object.
   :type eqColl: :py:class:`EquationCollection`
   :param fluc: The fluctuations object.
   :type fluc: :py:class:`Fluctuations`
   :param X: The coordinate system object.
   :type X: :py:class:`CoordinateSystem`
   :param param: The parameters for the equation.
   :type param: :py:class:`dict`

   :ivar J_hat: The J_hat attribute of the coordinate system.
   :vartype J_hat: :py:class:`ndarray`
   :ivar param: The parameters for the equation.
   :vartype param: :py:class:`dict`
   :ivar fluc: The fluctuations object.
   :vartype fluc: :py:class:`Fluctuations`
   :ivar X: The coordinate system object.
   :vartype X: :py:class:`CoordinateSystem`
   :ivar n: The value of n.
   :vartype n: :py:class:`int`
   :ivar all_ds: The list of all ds.
   :vartype all_ds: :py:class:`list`
   :ivar ds: The list of ds.

   :vartype ds: :py:class:`list`

   .. py:method:: addWeightMatrixExpression()
      :abstractmethod:

      Define the weight matrix expression.

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


   .. py:method:: addLinearExpression()
      :abstractmethod:

      Define the linear expression.

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


   .. py:method:: addNonlinearExpression()
      :abstractmethod:

      Define the nonlinear expression.

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


   .. py:method:: addBilinearExpression(*args)

      Optionally define a bilinear expression.

      :param \*args: Optional arguments required for the bilinear expression.
      :type \*args: :py:class:`tuple`