Triplet¶

class hoomd.md.many_body.Triplet(nlist, default_r_cut=None)¶

Bases: Force

Base class triplet force.

Triplet is the base class for many-body triplet forces.

Warning

This class should not be instantiated by users. The class can be used for isinstance or issubclass checks.

Warning

Currently HOOMD-blue does not support reverse force communication between MPI domains on the GPU. Since reverse force communication is required for the calculation of three-body forces, attempting to use this potential on the GPU with MPI will result in an error.

Members inherited from AutotunedObject:

property kernel_parameters¶: Kernel parameters. Read more...

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

tune_kernel_parameters()¶: Start tuning kernel parameters. Read more...

Members inherited from Force:

additional_energy¶: Additional energy term. Read more...

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

cpu_local_force_arrays¶: Local force arrays on the CPU. Read more...

energies¶: Energy contribution \(U_i\) from each particle. Read more...

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

forces¶: The force \(\vec{F}_i\) applied to each particle. Read more...

gpu_local_force_arrays¶: Local force arrays on the GPU. 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 defined in Triplet:

r_cut¶

r_cut \([\mathrm{length}]\), Cuttoff radius beyond which the energy and: force are 0.

Type: TypeParameter [tuple [particle_type, particle_type], float])

nlist¶

Neighbor list used to compute the triplet potential.

Type: hoomd.md.nlist.NeighborList