bluemira.equilibria.optimisation.harmonics.harmonics_constraint_functions
=========================================================================

.. py:module:: bluemira.equilibria.optimisation.harmonics.harmonics_constraint_functions

.. autoapi-nested-parse::

   Harmonics constraint classes



Classes
-------

.. autoapisummary::

   bluemira.equilibria.optimisation.harmonics.harmonics_constraint_functions.SphericalHarmonicConstraintFunction
   bluemira.equilibria.optimisation.harmonics.harmonics_constraint_functions.ToroidalHarmonicConstraintFunction


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

.. py:class:: SphericalHarmonicConstraintFunction(a_mat: numpy.ndarray, b_vec: numpy.ndarray, value: float, scale: float, name: str | None = None)

   Bases: :py:obj:`bluemira.equilibria.optimisation.constraints.ConstraintFunction`

   .. autoapi-inheritance-diagram:: bluemira.equilibria.optimisation.harmonics.harmonics_constraint_functions.SphericalHarmonicConstraintFunction
      :parts: 1
      :private-bases:


   Constraint function to constrain spherical harmonics starting from initial
   coil currents and associated core plasma.

   :param a_mat: Response matrix
   :param b_vec: Target value vector
   :param value: Target constraint value
   :param scale: Current scale with which to calculate the constraints


   .. py:attribute:: a_mat


   .. py:attribute:: b_vec


   .. py:attribute:: value


   .. py:attribute:: scale


   .. py:attribute:: name
      :value: None


      The name of the constraint


   .. py:method:: f_constraint(vector: numpy.typing.NDArray) -> numpy.typing.NDArray

      Constraint function



   .. py:method:: df_constraint(_vector: numpy.typing.NDArray[numpy.float64]) -> numpy.typing.NDArray[numpy.float64]

      Constraint derivative



.. py:class:: ToroidalHarmonicConstraintFunction(a_mat: numpy.ndarray, b_vec: numpy.ndarray, value: float, scale: float, name: str | None = None)

   Bases: :py:obj:`bluemira.equilibria.optimisation.constraints.ConstraintFunction`

   .. autoapi-inheritance-diagram:: bluemira.equilibria.optimisation.harmonics.harmonics_constraint_functions.ToroidalHarmonicConstraintFunction
      :parts: 1
      :private-bases:


   Constraint function to constrain harmonics starting from initial
   coil currents and associated core plasma.
   Used for toroidal harmonics.

   :param a_mat: Response matrix
   :param b_vec: Target value vector
   :param value: Target constraint value
   :param scale: Current scale with which to calculate the constraints


   .. py:attribute:: a_mat


   .. py:attribute:: b_vec


   .. py:attribute:: value


   .. py:attribute:: scale


   .. py:attribute:: name
      :value: None


      The name of the constraint


   .. py:method:: f_constraint(vector: numpy.typing.NDArray) -> numpy.typing.NDArray

      Constraint function



   .. py:method:: df_constraint(vector: numpy.typing.NDArray) -> numpy.typing.NDArray

      Constraint derivative