ifcopenshell.api.group.add_group

Module Contents

ifcopenshell.api.group.add_group.add_group(file: ifcopenshell.file, name: str = 'Unnamed', description: str | None = None) → ifcopenshell.entity_instance

Adds a new group

An IFC group is an arbitrary collection of products, which are typically physical. It may be used when there is no other more specific group which may be used. Other types of groups include distribution systems, which group together products that are connected and circulate a medium (such as fluid or electricity), or zones, which group together spaces, or structural load groups, which group together loads for structural analysis, or inventories, which are groups of assets.

Parameters:

• Name (str, optional) – The name of the group. Defaults to “Unnamed”

• description (str, optional) – The description of the purpose of the group.

Returns:

The newly created IfcGroup

Return type:

ifcopenshell.entity_instance

Example:

ifcopenshell.api.group.add_group(model, name="Unit 1A")