VirtualParticleFiller¶

class hoomd.mpcd.fill.VirtualParticleFiller(type, density, kT)¶

Bases: Operation

Base virtual-particle filler.

Parameters:

type (str) – Type of particles to fill.
density (float) – Particle number density.
kT (hoomd.variant.variant_like) – Temperature of particles.

Virtual particles will be added with the specified type and density. Their velocities will be drawn from a Maxwell–Boltzmann distribution consistent with kT.

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 defined in VirtualParticleFiller:

density¶

Particle number density.

Example:

filler.density = 5.0

Type:: float

kT¶

Temperature of particles.

Examples:

Constant temperature.

filler.kT = 1.0

Variable temperature.

filler.kT = hoomd.variant.Ramp(1.0, 2.0, 0, 100)

Type:: hoomd.variant.variant_like

type¶

Type of particles to fill.

Example:

filler.type = "A"

Type:: str