jax_dna.energy.dna2.debye
=========================

.. py:module:: jax_dna.energy.dna2.debye

.. autoapi-nested-parse::

   Debye-huckel function for DNA2 model.



Classes
-------

.. autoapisummary::

   jax_dna.energy.dna2.debye.DebyeConfiguration
   jax_dna.energy.dna2.debye.Debye


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

.. py:class:: DebyeConfiguration

   Bases: :py:obj:`jax_dna.energy.configuration.BaseConfiguration`


   Configuration for the debye-huckel energy function.


   .. py:attribute:: q_eff
      :type:  float | None
      :value: None



   .. py:attribute:: lambda_factor
      :type:  float | None
      :value: None



   .. py:attribute:: prefactor_coeff
      :type:  float | None
      :value: None



   .. py:attribute:: kt
      :type:  float | None
      :value: None



   .. py:attribute:: salt_conc
      :type:  float | None
      :value: None



   .. py:attribute:: is_end
      :type:  jax_dna.utils.types.Arr_Nucleotide_Int | None
      :value: None



   .. py:attribute:: half_charged_ends
      :type:  bool | None
      :value: None



   .. py:attribute:: lambda_
      :type:  float | None
      :value: None



   .. py:attribute:: kappa
      :type:  float | None
      :value: None



   .. py:attribute:: r_high
      :type:  float | None
      :value: None



   .. py:attribute:: prefactor
      :type:  float | None
      :value: None



   .. py:attribute:: smoothing_coeff
      :type:  float | None
      :value: None



   .. py:attribute:: r_cut
      :type:  float | None
      :value: None



   .. py:attribute:: required_params
      :type:  tuple[str]
      :value: ('q_eff', 'lambda_factor', 'prefactor_coeff', 'kt', 'salt_conc', 'is_end', 'half_charged_ends')



   .. py:method:: init_params() -> DebyeConfiguration

      Initializes the dependent parameters in configuration.

      Should be implemented in the subclass if dependent parameters are present.



.. py:class:: Debye

   Bases: :py:obj:`jax_dna.energy.base.BaseEnergyFunction`


   Debye-huckel energy function for DNA2 model.


   .. py:attribute:: params
      :type:  DebyeConfiguration


   .. py:method:: pairwise_energies(body_i: jax_dna.energy.base.BaseNucleotide, body_j: jax_dna.energy.base.BaseNucleotide, unbonded_neighbors: jax_dna.utils.types.Arr_Unbonded_Neighbors_2) -> jax_dna.utils.types.Arr_Bonded_Neighbors

      Computes the debye-huckel energy for each unbonded pair.



   .. py:method:: __call__(body: jax_dna.energy.base.BaseNucleotide, seq: jax_dna.utils.types.Discrete_Sequence, bonded_neighbors: jax_dna.utils.types.Arr_Bonded_Neighbors_2, unbonded_neighbors: jax_dna.utils.types.Arr_Unbonded_Neighbors_2) -> jax_dna.utils.types.Scalar

      Calculate the energy of the system.