Magnetic

class hoomd.md.external.field.Magnetic

Bases: Field

Magnetic field torque on a magnetic dipole.

Magnetic computes torques and energies on all particles in the simulation state which are consistent with:

$$U_i = -\vec{\mu}_i \cdot \vec{B}$$

where $\vec{\mu}_i$ is the magnetic dipole moment of particle $i$ and $\vec{B}$ is the field vector.

Example:

magnetic = hoomd.md.external.field.Magnetic()
magnetic.params["A"] = dict(B=(1.0, 0.0, 0.0), mu=(1.0, 0.0, 0.0))
simulation.operations.integrator.forces = [magnetic]

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:

params

The Magnetic external potential parameters. The dictionary has the following keys:

• B (tuple [float, float, float], required) - The magnetic field vector in the global reference frame $[\mathrm{energy} \cdot \mathrm{time} \cdot \mathrm{charge}^{-1} \cdot \mathrm{length}^{-2} ]$.

• mu (tuple [float, float, float], required) - The magnetic dipole moment of the particles type in the particle reference frame $[\mathrm{charge} \cdot \mathrm{length}^2 \cdot \mathrm{time}^{-1}]$.

Type: TypeParameter [particle_type, dict]