delete_group command

Purpose

Command to delete a particle group.

Warning

GPU support for this command has not been tested and may not work as expected.

Syntax

delete_group keyword value

The following keyword/value pairs are obligatory:

Keywords

Description

id

obligatory;user-assigned name for the particle group to be deleted

Examples

delete_group id groupA

Description

Delete the (existing) particle group known by id, which will remove the named group and un-assigns all particles that were assigned to that group. Since there is a restriction that no more than 32 groups can be defined at any time (see define_group), delete_group allows you to remove groups that are no longer needed (so that others can be specified). You cannot delete a group if it is in use by an active command. A group with the ID all is preredefined, which contains all particles (it cannot be deleted).