Bulk¶

class hoomd.mpcd.stream.Bulk(period, mpcd_particle_force=None)¶

Bases: StreamingMethod

Bulk fluid.

Parameters:

period (int) – Number of integration steps covered by streaming step.
mpcd_particle_force (BodyForce) – Body force on MPCD particles.

Bulk streams the MPCD particles in a fully periodic geometry (2D or 3D). This geometry is appropriate for modeling bulk fluids, i.e., those that are not confined by any surfaces.

Examples:

Bulk streaming.

stream = hoomd.mpcd.stream.Bulk(period=1)
simulation.operations.integrator.streaming_method = stream

Bulk streaming with applied force.

stream = hoomd.mpcd.stream.Bulk(
    period=1,
    mpcd_particle_force=hoomd.mpcd.force.ConstantForce((1, 0, 0)),
)
simulation.operations.integrator.streaming_method = stream

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

period¶: Number of integration steps covered by streaming step. Read more...

mpcd_particle_force¶: Body force on MPCD particles. Read more...