zone.face.group
Syntax
- s := zone.face.group(z,iside<,slot>)
- zone.face.group(z,iside<,slot>) := s
Get/set the group name assigned to face iside of zone z in slot slot, if provided. On get, the slot named
'Default'
is used if slot is not provided. On set, if slot is omitted, all group/slot assignments are returned.On get, the return string enumerates all group/slot assignments present on the face in the format “SlotName=GroupName,SlotName=GroupName”.
On set, a group index may be used instead of a string for s. On get or set, a slot index may be used instead of a string for slot. Indices operate more efficiently than strings.*
Returns: s - group name or index*; “None” if no group is assigned
Accepts: s - group name or index*; if “None” is used the group name will be cleared
Arguments: z - zone pointer
iside - side of the zone indicating the face, from 1 to 6
slot - slot name or index*;
Note
*Use the
group.find
andgroup.find.slot
intrinsics to obtain group and slot indices, respectively, and for further information.Use of the group logic is described in Groups.
Was this helpful? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |