StreamingMethod

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

Bases: Operation

Base streaming method.

Parameters:

• period (int) – Number of integration steps covered by streaming step.

• mpcd_particle_force (BodyForce) – Force on MPCD particles.

---

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

period

Number of integration steps covered by streaming step (read only).

The MPCD particles will be streamed every time the timestep is a multiple of period. The streaming time is hence equal to period steps of the Integrator. Typically period should be equal to the period for the corresponding collision method. A smaller fraction of this may be used if an external force is applied, and more faithful numerical integration is needed.

Type:

int

mpcd_particle_force

Body force on MPCD particles.

The mpcd_particle_force cannot be changed after the StreamingMethod is constructed, but its attributes can be modified.

Type:

BodyForce