openmmtools.forces.HarmonicRestraintForce
=========================================

.. currentmodule:: openmmtools.forces

.. autoclass:: HarmonicRestraintForce

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~HarmonicRestraintForce.__init__
      ~HarmonicRestraintForce.addBond
      ~HarmonicRestraintForce.addEnergyParameterDerivative
      ~HarmonicRestraintForce.addGlobalParameter
      ~HarmonicRestraintForce.addGroup
      ~HarmonicRestraintForce.addPerBondParameter
      ~HarmonicRestraintForce.addTabulatedFunction
      ~HarmonicRestraintForce.compute_standard_state_correction
      ~HarmonicRestraintForce.deserialize_xml
      ~HarmonicRestraintForce.distance_at_energy
      ~HarmonicRestraintForce.getBondParameters
      ~HarmonicRestraintForce.getEnergyFunction
      ~HarmonicRestraintForce.getEnergyParameterDerivativeName
      ~HarmonicRestraintForce.getForceGroup
      ~HarmonicRestraintForce.getGlobalParameterDefaultValue
      ~HarmonicRestraintForce.getGlobalParameterName
      ~HarmonicRestraintForce.getGroupParameters
      ~HarmonicRestraintForce.getName
      ~HarmonicRestraintForce.getNumBonds
      ~HarmonicRestraintForce.getNumEnergyParameterDerivatives
      ~HarmonicRestraintForce.getNumFunctions
      ~HarmonicRestraintForce.getNumGlobalParameters
      ~HarmonicRestraintForce.getNumGroups
      ~HarmonicRestraintForce.getNumGroupsPerBond
      ~HarmonicRestraintForce.getNumPerBondParameters
      ~HarmonicRestraintForce.getNumTabulatedFunctions
      ~HarmonicRestraintForce.getPerBondParameterName
      ~HarmonicRestraintForce.getTabulatedFunction
      ~HarmonicRestraintForce.getTabulatedFunctionName
      ~HarmonicRestraintForce.is_restorable
      ~HarmonicRestraintForce.restore_interface
      ~HarmonicRestraintForce.setBondParameters
      ~HarmonicRestraintForce.setEnergyFunction
      ~HarmonicRestraintForce.setForceGroup
      ~HarmonicRestraintForce.setGlobalParameterDefaultValue
      ~HarmonicRestraintForce.setGlobalParameterName
      ~HarmonicRestraintForce.setGroupParameters
      ~HarmonicRestraintForce.setName
      ~HarmonicRestraintForce.setPerBondParameterName
      ~HarmonicRestraintForce.setUsesPeriodicBoundaryConditions
      ~HarmonicRestraintForce.updateParametersInContext
      ~HarmonicRestraintForce.usesPeriodicBoundaryConditions
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~HarmonicRestraintForce.controlling_parameter_name
      ~HarmonicRestraintForce.restrained_atom_indices1
      ~HarmonicRestraintForce.restrained_atom_indices2
      ~HarmonicRestraintForce.restraint_parameters
      ~HarmonicRestraintForce.spring_constant
      ~HarmonicRestraintForce.thisown