Search Syntax Catalog
In this section, you will find a summary of all field expressions and symbols available in the Model Manager search syntax:
•
Table 3-1 contains item field expressions that match on basic fields of models and files.
•
Table 3-2 contains node field expressions that match on node types and properties.
•
Table 3-3 contains setting field expressions that match on node settings.
•
Table 3-4 contains the various expressions used to write plain and nested node and setting filters.
•
Table 3-5 contains symbols available in the search syntax.
If you are uncertain of what field values are available for a Selection Field with built-in values, write any character and press Enter. Model Manager will show an error dialog containing supported values.
Table 3-1: Field expressions for item fields.
Syntax
Type
Description
@branch:...
Selection
The name of the branch that an item version is saved to. Escape spaces or other reserved characters in names with backslash.
@commitComment:
Text
The commit comment written when the item version was saved.
@computedData:...
File Size
The estimated disk space usage of all built, computed, and plotted data of a model version when stored on the file system.
@description:…
Text
The description of an item version.
@filename:…
Keyword
The filename used when exporting an item version to the file system.
@fileType:…
Keyword
The file type extensions of the file resources belonging to a file version.
@itemKey:...
Selection
The unique key of the item that an item version belongs to.
@itemSaveType:…
Selection
The item save type of an item that an item version belongs to.
@itemType:…
Selection
The item type of the item that an item version belongs to.
@itemVersionKey:...
Selection
The unique key of an item version.
@itemVersionType:...
Selection
The item version type of an item version.
@lastModified:…
Date
The instant in time when an item was last modified with respect to a branch. May be used in place of @saved:...
@lastModifiedBy:…
Selection
The name or display name of the user that last modified an item with respect to a branch. Escape spaces or other reserved characters in names with backslash. May be used in place of @savedBy:...
@originItemKey:...
Selection
The unique key of the origin item to an item that an item version belongs to.
@owner:…
Selection
The name or display name of the user that owns the item. Escape spaces or other reserved characters in names with backslash.
@part:...
Selection
A reusable model part in a model version.
@repository:...
Selection
The name of the repository that an item version is saved to. Escape spaces or other reserved characters in names with backslash.
@saved:...
Date
The instant in time when an item version was saved.
@savedBy:...
Selection
The name or display name of the user that saved an item version. Escape spaces or other reserved characters in names with backslash.
@size:...
File size
The estimated disk space usage of an item version when stored on the file system.
@tag:…
Text
The titles of tags assigned to an item with respect to a branch.
@tagKey:…
Selection
The unique keys of tags assigned to an item with respect to a branch.
@title:…
Text
The title of an item version.
Table 3-2: Field expressions for node fields.
Syntax
Type
Description
@apiClass:…
Keyword
The class of a node in the COMSOL API.
@apiType:…
Keyword
The node type as represented in the COMSOL API.
@author:…
Text
The author property of a node.
@axisymmetric:…
Boolean
The axisymmetric property of a Component or Geometry node.
@comment:…
Text
The comment property of a node.
@created:…
Date
The instant in time when a node was created.
@label:…
Text
The label of a node.
@lastComputationDate:...
Date
The instant in time when a Study node was last solved.
@lastComputationTime:…
Numeric
The computation time in seconds when a Study node was last solved.
@lastComputationVersion:...
Keyword
The COMSOL version that a Study node was last solved in.
@lastModified:…
Date
The instant in time when a node was last modified.
@lastModifiedBy:…
Text
The last modified by property of a node.
@name:…
Keyword
The name of a node.
@spaceDimension:…
Numeric
The spatial dimension of a Component or Geometry node.
@tag:…
Keyword
The tag of a node.
@type:…
Text
The node type as shown in the user interface.
@version:…
Text
The version property of a node.
Table 3-3: Field expressions for setting fields.
Syntax
Type
Description
@apiValue:…
Keyword
The value of a setting as returned in the COMSOL API.
@description:…
Text
The description of a setting.
@name:…
Keyword
The identifier name of a setting.
@scalarImag:…
Numeric
The imaginary part of a scalar setting value.
@scalarReal:…
Numeric
The real part of a scalar setting value.
@value:…
Keyword
The value of a setting.
Table 3-4: Node and setting expressions.
Syntax
API Class
Description
@commonDefinition{…}
CommonFeature
A common definition node.
@component{…}
ModelNode
A Component node.
@geometry{…}
GeomSequence
A Geometry node.
@material{…}
Material
A Material node.
@mesh{…}
MeshSequence
A Mesh node.
@model{…}
Model
The root node of a model.
@multiphysicsCoupling{…}
MultiphysicsCoupling
A Multiphysics coupling node.
@node{…}
N/A
An arbitrary node.
@nodeGroup{…}
NodeGroup
A Node Group.
@parameters{…}
ModelParamGroup
A Parameters node.
@physics{…}
Physics
A Physics node.
@results{…}
Results
The Results node.
@setting{…}
N/A
A node setting.
@study{…}
Study
A Study node.
@studyStep{…}
StudyFeature
A Study Step node.
Table 3-5: Symbols in the Model Manager search syntax.
Syntax
Description
*
A wildcard in a search word.
AND
Combines two field values or field expressions with a Boolean AND.
OR
Combines two field values or field expressions with a Boolean OR.
NOT
Negates a field value or field expression.
ANY
An alias for a field value containing a single wildcard.
(…)
Enclosing field values or field expressions.
{…}
Enclosing expressions inside a node or setting filter.
[… TO …]
A field range value.
"…"
Quotation marks enclosing a sequence of search words as a phrase.
Table 3-6: Date shorthands in the Model Manager search syntax.
Syntax
Description
TODAY
Shorthand for an interval covering the current day.
YESTERDAY
Shorthand for an interval covering yesterday.
CURRENTWEEK
Shorthand for an interval covering the current week.
CURRENTMONTH
Shorthand for an interval covering the current month.
CURRENTYEAR
Shorthand for an interval covering the current year.