Area¶

class hoomd.md.mesh.conservation.Area(mesh, ignore_type=False)¶

Area conservation potential.

Parameters:

mesh (hoomd.mesh.Mesh) – Mesh data structure.
ignore_type (bool, optional) – ignores mesh type if set to True and calculates the conservation energy considering all triangles in the mesh. Defaults to False.

Area specifies a global area conservation energy for each mesh type.

\[U_t = k \frac{ (A_t - A_{0,t} )^2}{2 \cdot A_0}\]

with \(A_t\) is the instantaneous total area of all triangles of type \(t\).

Example:

area_conservation_potential = hoomd.md.mesh.conservation.Area(mesh)
area_conservation_potential.params["mesh"] = dict(k=10.0, A0=250)

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 Area:

parameter¶

The parameter of the area conservation for each mesh type. The dictionary has the following keys:

k (float, required) - bending stiffness \([\mathrm{energy} \cdot \mathrm{length}^{-2}]\)
A0 (float, required) - targeted global surface area \([\mathrm{length}]^2]\)

property area¶

Area of the mesh triangulation.

(Loggable: category=”scalar”)