mythos.energy.dna1.coaxial_stacking
===================================

.. py:module:: mythos.energy.dna1.coaxial_stacking

.. autoapi-nested-parse::

   Coaxial stacking energy function for DNA1 model.



Classes
-------

.. autoapisummary::

   mythos.energy.dna1.coaxial_stacking.CoaxialStackingConfiguration
   mythos.energy.dna1.coaxial_stacking.CoaxialStacking


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

.. py:class:: CoaxialStackingConfiguration

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


   Configuration for the coaxial stacking energy function.


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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



   .. py:attribute:: required_params
      :type:  tuple[str]
      :value: ('dr_low_coax', 'dr_high_coax', 'k_coax', 'dr0_coax', 'dr_c_coax', 'theta0_coax_4',...



   .. py:attribute:: dependent_params
      :type:  tuple[str]
      :value: ('b_low_coax', 'dr_c_low_coax', 'b_high_coax', 'dr_c_high_coax', 'b_coax_4',...



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

      Initializes the dependent parameters in configuration.

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



.. py:class:: CoaxialStacking

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


   Coaxial stacking energy function for DNA1 model.


   .. py:attribute:: params
      :type:  CoaxialStackingConfiguration


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

      Computes the coaxial stacking energy for each unbonded pair.



   .. py:method:: compute_energy(nucleotide: mythos.energy.base.BaseNucleotide) -> mythos.utils.types.Scalar

      Compute the energy of the system given the nucleotide.