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

.. py:module:: FELiCS.Equation.Equations.EnthalpyEquation


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

Classes
~~~~~~~

.. autoapisummary::

   FELiCS.Equation.Equations.EnthalpyEquation.EnthalpyEquation




Attributes
~~~~~~~~~~

.. autoapisummary::

   FELiCS.Equation.Equations.EnthalpyEquation.logger


.. py:data:: logger

   

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


   Bases: :py:obj:`FELiCS.Equation.Equations.EquationTemplate.EquationTemplate`

   Class representing the enthalpy conservation equation.

   This class formulates the enthalpy conservation equation using a
   tensorial framework. It extends the `EquationTemplate` and implements
   methods for adding weight matrices, linear expressions, and nonlinear
   expressions to the weak form.

   **Initialize the EnthalpyEquation object**

   :param index: The index of the equation in the equation collection.
   :type index: :py:class:`int`
   :param eqColl: The equation collection object.
   :type eqColl: :py:class:`EquationCollection`
   :param fluc: The fluctuations object containing fluctuating fields.
   :type fluc: :py:class:`Fluctuations`
   :param X: The function representing the mesh coordinates.
   :type X: :py:class:`Function`
   :param param: The parameters object used to configure the numerical scheme.
   :type param: :py:class:`Parameters`

   :ivar J_hat: Jacobian determinant or related geometric scaling factor.
   :vartype J_hat: :py:class:`float` or :py:class:`Function`
   :ivar X: The mesh coordinate function.
   :vartype X: :py:class:`Function`
   :ivar fluc: Container of fluctuation fields.
   :vartype fluc: :py:class:`Fluctuations`
   :ivar all_ds: Surface measure used for boundary integrals.

   :vartype all_ds: :py:class:`Measure`

   .. admonition:: Notes

      If the numerical scheme specified in the parameters is
      'Discontinuous Galerkin', an error is raised because that scheme
      is not supported in the tensorial framework.

   .. py:method:: addWeightMatrixExpression(weakForm, mean)

      Add the weight matrix expression to the weak form.

      :param weakForm: The weak form object where the equation terms are added.
      :type weakForm: :py:class:`Form`
      :param mean: The mean fields object containing averaged field variables.
      :type mean: :py:class:`MeanFields`

      .. admonition:: Notes

         This method adds the time derivative terms to the weak form using the
         tensorial representation of fluctuating enthalpy and pressure.


   .. py:method:: addNonlinearExpression()

      Add the nonlinear expression to the weak form.

      .. admonition:: Notes

         This method is a placeholder and currently does not contribute any
         nonlinear terms to the weak form.


   .. py:method:: addLinearExpression(weakForm, mean)

      Construct the weak form of the linearized enthalpy conservation equation.

      :param weakForm: The weak form object to which the linearized terms are added.
      :type weakForm: :py:class:`Form`
      :param mean: The mean fields object containing averaged field variables.
      :type mean: :py:class:`MeanFields`

      .. admonition:: Notes

         Constructs the linearized weak form by incorporating:
         - Volume integrals of advection terms remaining after partial integration.
         - Boundary integrals resulting from the partial integration of advection terms.
         - Diffusion terms using gradient and dot product operations.

         Debugging messages may be emitted if enabled via the parameters.