GeometryFiller¶

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

Bases: VirtualParticleFiller

Virtual-particle filler for a bounce-back geometry.

Parameters:

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

Virtual particles are inserted in cells whose volume is sliced by the specified geometry. The algorithm for doing the filling depends on the specific geometry.

Limitations:

This filler does not currently support triclinic boxes for any Geometry. Additionally, this filler does not support the PlanarPore geometry for any non-cubic cell shape. Exceptions will be raised in these cases.

Example:

Filler for parallel plate geometry.

plates = hoomd.mpcd.geometry.ParallelPlates(separation=6.0)
filler = hoomd.mpcd.fill.GeometryFiller(
    type="A", density=5.0, kT=1.0, geometry=plates
)
simulation.operations.integrator.virtual_particle_fillers = [filler]

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

density¶: Particle number density. Read more...

kT¶: Temperature of particles. Read more...

type¶: Type of particles to fill. Read more...

Members defined in GeometryFiller:

geometry¶

Surface to fill around (read only).

Type:: hoomd.mpcd.geometry.Geometry