Skip to content
Snippets Groups Projects
Commit 4a3f6e5f authored by Haocheng LIU's avatar Haocheng LIU
Browse files

DOCUMENTATION: Add group operator description

parent e593a139
No related branches found
No related tags found
No related merge requests found
......@@ -4,12 +4,27 @@
<Definitions>
<!-- Operation -->
<AttDef Type="entity group" BaseType="operator">
<BriefDescription>
Create a group of cell entities. User can modify and remove the created group afterwards.
</BriefDescription>
<DetailedDescription>
Create a group of cell entities. User can modify and remove the created group afterwards.
Boundary groups are intended to hold cell entities of the highest dimension that the model contains.
Domain groups are intended to hold cell entities that are lower than the highest dimension
that the mode contains.
</DetailedDescription>
<ItemDefinitions>
<ModelEntity Name="model" NumberOfRequiredValues="1">
<MembershipMask>model</MembershipMask>
</ModelEntity>
<String Name="Operation" Label="Operation" Version="0" AdvanceLevel="0" NumberOfRequiredValues="1">
<BriefDescription>operation for the operator</BriefDescription>
<BriefDescription>
The operation determines which action to take on the group: create it, modify its membership, or remove it.
</BriefDescription>
<DetailedDescription>
The operation determines which action to take on the group: create it, modify its membership, or remove it.
</DetailedDescription>
<ChildrenDefinitions>
<ModelEntity Name="modify cell group" NumberOfRequiredValues="1">
<MembershipMask>group</MembershipMask>
......@@ -24,9 +39,12 @@
<MembershipMask>volume|face|edge</MembershipMask>
</ModelEntity>
<Int Name="group type" Label="Group Type:" Version="0" NumberOfRequiredValues="1">
<BriefDescription>Group type for the discrete model kernel:
Boundary group (face or edge) is not partitioned, meaning each entity can belong to multiple boundary groups;
Domain group (volume or face) is partitioned, meaning each entity will only belong to one domain group.
<BriefDescription>
Group type for the discrete model kernel:
Boundary groups are intended to hold cell entities of the highest dimension that the model contains.
Domain groups are intended to hold cell entities that are lower than the highest dimension
that the mode contains.
</BriefDescription>
<DiscreteInfo DefaultIndex="0">
<Value Enum="Boundary">0</Value>
......
......@@ -208,7 +208,7 @@ bool Group::meetsMembershipConstraintsInternal(
memberMask &= preExistingMember.entityFlags();
}
// Now we look at how the dimensionality of members should be constrained.
// First, do we require things to matcht he model dimensionality (or its boundary)?
// First, do we require things to match the model dimensionality (or its boundary)?
if (groupFlags & (MODEL_BOUNDARY | MODEL_DOMAIN))
{
BitFlags dimMask;
......
......@@ -4,12 +4,25 @@
<Definitions>
<!-- Operation -->
<AttDef Type="entity group" Label="Model - Create Group" BaseType="operator">
<BriefDescription>
Create a group of cell entities. User can modify and remove the created group afterwards.
</BriefDescription>
<DetailedDescription>
Create a group of cell entities. User can modify and remove the created group afterwards.
If advance level is turned on, user can filter the entities by their cell type then use them to modify the group.
</DetailedDescription>
<ItemDefinitions>
<ModelEntity Name="model" NumberOfRequiredValues="1">
<MembershipMask>model</MembershipMask>
</ModelEntity>
<String Name="Operation" Label="Operation" Version="0" AdvanceLevel="0" NumberOfRequiredValues="1">
<BriefDescription>operation for the operator</BriefDescription>
<BriefDescription>
The operation determines which action to take on the group: create it, modify its membership, or remove it.
</BriefDescription>
<DetailedDescription>
The operation determines which action to take on the group: create it, modify its membership, or remove it.
</DetailedDescription>
<ChildrenDefinitions>
<ModelEntity Name="modify cell group" NumberOfRequiredValues="1">
<MembershipMask>group</MembershipMask>
......@@ -23,31 +36,21 @@
<ModelEntity Name="cell to remove" NumberOfRequiredValues="0" Extensible="1">
<MembershipMask>volume|face|edge</MembershipMask>
</ModelEntity>
<Int Name="group type" Label="Group Type:" Version="0" NumberOfRequiredValues="1">
<BriefDescription>Group type for the discrete model kernel:
Boundary group (face or edge) is not partitioned, meaning each entity can belong to multiple boundary groups;
Domain group (volume or face) is partitioned, meaning each entity will only belong to one domain group.
</BriefDescription>
<DiscreteInfo DefaultIndex="0">
<Value Enum="Cover">0</Value>
<Value Enum="Partition">1</Value>
</DiscreteInfo>
</Int>
<Void Name="Vertex" Label="Vertex" Version="0" NumberOfRequiredValues="1" Optional="true" AdvanceLevel = "1" Option = "true" IsEnabledByDefault = "true">
<BriefDescription>Allow vertex to be added to the group.
</BriefDescription>
<BriefDescription>Allow vertices to be added to the group.</BriefDescription>
<DetailedDescription>Allow vertices to be added to the group.</DetailedDescription>
</Void>
<Void Name="Edge" Label="Edge" Version="0" NumberOfRequiredValues="1" Optional="true" AdvanceLevel = "1" Option = "true" IsEnabledByDefault = "true">
<BriefDescription>Allow edge to be added to the group.
</BriefDescription>
<BriefDescription>Allow edges to be added to the group.</BriefDescription>
<DetailedDescription>Allow edges to be added to the group.</DetailedDescription>
</Void>
<Void Name="Face" Label="Face" Version="0" NumberOfRequiredValues="1" Optional="true" AdvanceLevel = "1" Option = "true" IsEnabledByDefault = "true">
<BriefDescription>Allow face to be added to the group.
</BriefDescription>
<BriefDescription>Allow faces to be added to the group.</BriefDescription>
<DetailedDescription>Allow faces to be added to the group.</DetailedDescription>
</Void>
<Void Name="Volume" Label="Volume" Version="0" NumberOfRequiredValues="1" Optional="true" AdvanceLevel = "1" Option = "true" IsEnabledByDefault = "true">
<BriefDescription>Allow volume to be added to the group.
</BriefDescription>
<BriefDescription>Allow volumes to be added to the group.</BriefDescription>
<DetailedDescription>Allow volumes to be added to the group.</DetailedDescription>
</Void>
<String Name="group name" Label="group name" Version="0" AdvanceLevel="0" NumberOfRequiredValues="1">
<DefaultValue>new group</DefaultValue>
......@@ -96,3 +99,4 @@
</AttDef>
</Definitions>
</SMTK_AttributeSystem>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment