Tether¶

class hoomd.md.mesh.bond.Tether(mesh)¶

Bases: MeshPotential

Tethering bond potential.

Tether computes forces, virials, and energies on all mesh bonds in mesh with the harmonic potential (see hoomd.md.bond.Tether).

Example:

bond_potential = hoomd.md.mesh.bond.Tether(mesh)
bond_potential.params["mesh"] = dict(
    k_b=10.0, l_min=0.9, l_c1=1.2, l_c0=1.8, l_max=2.1
)

Members inherited from AutotunedObject:

property is_tuning_complete¶: Check if kernel parameter tuning is complete. Read more...

Members inherited from Force:

additional_virial¶: Additional virial tensor term \(W_\mathrm{additional}\). Read more...

energy¶: The potential energy \(U\) of the system from this force. Read more...

torques¶: The torque \(\vec{\tau}_i\) applied to each particle. Read more...

virials¶: Virial tensor contribution \(W_i\) from each particle. Read more...

Members inherited from MeshPotential:

mesh¶: Mesh data structure used to compute the bond potential. Read more...

Members defined in Tether:

params¶

The parameter of the Tether bonds for the defined mesh. The mesh type name defaults to “mesh”. The dictionary has the following keys:

k_b (float, required) - bond stiffness \([\mathrm{energy}]\)
l_min (float, required) - minimum bond length \([\mathrm{length}]\)
l_c1 (float, required) - cutoff distance of repulsive part \([\mathrm{length}]\)
l_c0 (float, required) - cutoff distance of attractive part \([\mathrm{length}]\)
l_max (float, required) - maximum bond length \([\mathrm{length}]\)