Predicate Reference
Predicates have a wide variety of types, operators, and values to help you create a precise search in Simcenter STAR-CCM+.
| Note | For predicates of type Name and Tag, only objects that you can rename are included in the search results. For example, a search for Name contains Plot yields individual plots, but not the Plots manager object. |
|
Predicate Type |
Available Operators |
Effect |
||
|---|---|---|---|---|
| Relationship | below in tree | Matches all objects that are contained within the selected object (that is, sub-objects, sub-objects of sub-objects, and so on). | ||
| exclude children of | Disregards all objects that are contained within the selected object (that is, sub-objects, sub-objects of sub-objects, and so on). | |||
| above in tree | For the selected object, matches the hierarchy of parent objects (that is, the parent object, the parent of the parent object, and so on). | |||
| exclude parents of | Disregards all objects that are above the selected object (that is, the parent object, the parent of the parent object, and so on). | |||
| directly below in tree | Matches the immediate sub-objects of the selected object. | |||
| directly above in tree | Matches the immediate parent object of the selected object. | |||
| referencing | Matches all objects that are referencing the selected object. | |||
| not referencing | Matches all objects other than the ones that are referencing the selected object. | |||
| referenced by | Matches all objects that are referenced by the selected object. | |||
| not referenced by | Matches all objects other than the ones that are referenced by the selected object. | |||
| Type | is |
Matches the selected object type. The available object types are:
|
||
| is not | Matches all objects other than the selected object type. | |||
|
Name |
contains | Matches all objects with names that include the specified text string. | ||
| does not contain | Matches all objects with names that do not include the specified text string. | |||
| matches | Matches all objects with the specified name. | |||
| does not match |
Matches all objects with names other than the specified name. |
|||
| starts with | Matches all objects with names that begin with the specified text string. | |||
| does not start with | Matches all objects with names that do not begin with the specified text string. | |||
| ends with |
Matches all objects with names that end with the specified text string. A name can include a trailing number which is considered part of the name, such as Cartesian 1. Therefore, for example, an entry of ian does not find the Cartesian 1 node. The Name predicate is case-insensitive for the Western alphabet but otherwise case-sensitive. |
|||
| does not end with | Matches all objects with names that do not end with the specified text string. | |||
| contains regular expression | Matches all objects with names that include the
pattern. To match the pattern directly, that is to select only
objects with names that match the pattern in their entirety, the
pattern needs to be anchored (wrapped with ^ and
$). For more information about these
expressions, see Regular Expressions. |
|||
| does not contain regular expression | Matches all objects with names that do not include the pattern. | |||
|
Tag For more information, see Tagging Simulation Objects. |
contains | Matches all objects that are tagged with the selected tag. | ||
| does not contain | Matches all objects that are not tagged with the selected tag. | |||
|
Comment For more information, see Adding Comments to Simulation Objects. |
contains | Matches all comments that include the specified text string. | ||
| does not contain | Matches all comments that do not include the specified text string. | |||
| matches | Matches all comments with the specified text. | |||
| does not match | Matches all comments other than those with the specified text. | |||
| starts with | Matches all comments that begin with the specified text string. | |||
| does not start with | Matches all comments that do not begin with the specified text string. | |||
| ends with | Matches all comments that end with the specified text string. | |||
| does not end with | Matches all comments that do not end with the specified text string. | |||
|
Objects (Static)
|
are | Matches the selected objects. | ||
| are not | Matches all objects other than the selected objects. | |||
|
Filter Use this type to reuse portions of a filter without duplicating predicates. |
matches |
Matches all objects that match the referenced filter. |
||
| does not match | Matches all objects that do not match the referenced filter. | |||
|
Metadata -- for more information, see What Is Metadata?. The values are two text components: key and value. The key is always a string, but the value can be either a string or a number. |
contains |
Matches all objects that contain the specified metadata. If you enter a numeric value, it only finds objects with that value as a number. If you enter a number in single quotes, it only finds objects with that value as a string of text. |
||
| does not contain | Matches all objects that do not contain the specified metadata. | |||
| pair contains | Matches partially the key and/or the value. | |||
| pair does not contain | Neither the key nor the value has any partial match of the pattern. | |||
| pair contains regular expression | Matches the same as pair contains, with the addition of regular expression special characters. For more information about these expressions, see Regular Expressions. | |||
| pair does not contain regular expression | Matches the same as pair does not contain, with the addition of regular expression special characters. | |||
|
Inherited Parts Searches for parts that are inherited from geometry objects: parts, composites, part surfaces, part curves, and part points. For more information, see Inherited Parts. |
derive from | Matches all part surfaces, part curves and part point objects below the selected objects in the tree, either the original source objects themselves or their occurrence under the Inherited Parts folder of another part. Only the leaf-level objects at the bottom of the tree are selected. Intermediate objects, such as parts composites, are not selected. | ||
| do not derive from | Matches all objects other than the selected inherited parts. | |||
| derive from (inherited objects only) | Matches the occurrence of all part surfaces, part curves and part point objects below the selected objects in the tree, under the Inherited Parts folder of another part. the original source objects themselves are not selected. | |||
| do not derive from (inherited objects only) | Matches all objects other than the selected inherited parts, including the original source objects. | |||
| Contents of | (object selector) | Matches all objects referenced by the selected property of the object that you select in the operator. See the example for finding output parts for mesh operations. |