Package hoomd_script.group

Commands for grouping particles. More...

Classes
class	group
	Defines a group of particles. More...
Functions
def	type
	Groups particles by type.
def	tags
	Groups particles by tag.
def	all
	Groups all particles.

---

Detailed Description

Commands for grouping particles.

This package contains various commands for making groups of particles

---

Function Documentation

def hoomd_script.group.all

(

)

Groups all particles.

Creates a particle group from all particles in the simulation. The group can then be used by other hoomd_script commands (such as analyze.msd) to specify which particles should be operated on.

Particle groups can be combined in various ways to build up more complicated matches. See group for information and examples.

Examples:

 all = group.all()

def hoomd_script.group.tags	(		tag_min,
			tag_max = None
	)

Groups particles by tag.

Parameters:

	tag_min	First tag in the range to include (inclusive)
	tag_max	Last tag in the range to include (inclusive)

The second argument (tag_max) is optional. If it is not specified, then a single particle with tag=tag_min will be added to the group.

Creates a particle group from particles that match the given tag range. The group can then be used by other hoomd_script commands (such as analyze.msd) to specify which particles should be operated on.

Particle groups can be combined in various ways to build up more complicated matches. See group for information and examples.

Examples:

 half1 = group.tags(0, 999)
 half2 = group.tags(1000, 1999)

def hoomd_script.group.type

(

type

)

Groups particles by type.

Parameters:

type

Name of the particle type to add to the group

Creates a particle group from particles that match the given type. The group can then be used by other hoomd_script commands (such as analyze.msd) to specify which particles should be operated on.

Particle groups can be combined in various ways to build up more complicated matches. See group for information and examples.

Examples:

 groupA = group.type('A')
 groupB = group.type('B')