Electric

class hoomd.md.external.field.Electric

Bases: Field

Electric field force.

Electric computes forces, virials, and energies on all particles in the simulation state which are consistent with:

$$U_i = - q_i \vec{E} \cdot \vec{r}_i$$

where $q_i$ is the particle charge and $\vec{E}$ is the field vector. The field vector $\vec{E}$ must be set per unique particle type.

Example:

electric = hoomd.md.external.field.Electric()
electric.E["A"] = (1, 0, 0)
simulation.operations.integrator.forces = [electric]

---

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

E

The electric field vector $\vec{E}$ as a tuple $(E_x, E_y, E_z)$ $[\mathrm{energy} \cdot \mathrm{charge}^{-1} \cdot \mathrm{length^{-1}}]$.

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