pw:: Examine

Examine type

Derives From

pw::Object

Summary
Examine type
This action creates an examine object.
This action gets a list of allowable function names.
This action adds a cut to the list of saved cuts for block examine.
This action removes a cut from the list of saved cuts for block examine.
This action gets the number of saved cuts for block examine.
This action gets the specified saved cut for block examine.
This action reports statistics about the cell area of domains.
This action reports statistics about the minimum skew of domains.
This action reports statistics about the maximum skew of domains.
This action reports statistics about the skew angle of domains.
This action reports statistics about the cell volume of blocks.
Thsi action reports statistics about the cell minimum skew of blocks.
This action reports statistics about the cell maximum skew of blocks.
This action reports statistics about the cell skew angle of blocks.
This action reports statistics about the blocks’ Jacobians.
This action deletes this examine object.
This action clears any computed data.
This action executes the examine function for each entity added to the examine object.
This action processes the computed examine data again with any modified values in the interval count or range limits without recalculating the examine functions on each entity.
This action gets the average value computed during the last call to examine.
This action gets the maximum value computed during the last call to examine.
This action gets the minimum value computed during the last call to examine.
This action gets the number of entities being examined and optionally sets a variable to the list of entities.
This action adds one or more entities to the examine object.
This action removes one or more entities from the examine object.
This action removes all entities from the examine object.
This action returns the lower and upper cutoff limits.
This action sets the lower and upper cutoff limits to be applied during the next call to examine or refilter.
This action gets the number of cells or points that were below the lower cutoff range during the last examine or refilter call.
This action gets the number of cells or points between the lower and upper cutoff limits (inclusive) during the last examine or refilter call.
This action gets the number of cells or points that were above the upper cutoff range during the last examine call.
This action gets the number of intervals used for the histogram when examine or refilter was last run.
This action sets the number of intervals to use for the histogram.
This action gets the limits of all intervals in the histogram.
This action gets the number of values in the specified interval.
This action gets the number of values in all intervals.
This action gets the computed value at a location within an entity.
This action gets the number of computed values either for a specific entity or for all entities.
This action gets the sample point at a location within an entity.
This action gets the grid or database coordinates for the examined element of an entity at a given point or cell index depending upon whether grid or database entities are being examined.
This action gets the XYZ values for the examined element of an entity at a given point or cell index.
This action gets the list of categories for which separate counts are maintained.
This action gets the specified category count for the examine function.
This action gets the constant U and V lines for the examined entity at a given point.
This action gets the value of the current highlighter position.

Static Actions

create

pw::Examine create type

This action creates an examine object.

Parameters

typeThis parameter is a function name string of the type of examination to create; BlockAspectRatio | BlockComponentVolume | BlockEdgeLength | BlockJacobian | BlockLengthI | BlockLengthJ | BlockLengthK | BlockLengthRatioI | BlockLengthRatioJ | BlockLengthRatioK | BlockMaximumAngle | BlockMinimumAngle | BlockSkewCentroid | BlockSkewEquiangle | BlockSkewEquivolume | BlockSmoothnessI | BlockSmoothnessJ | BlockSmoothnessK | BlockVolume | BlockVolumeRatio | BlockNone | BlockCellType | ConnectorEdgeLength | ConnectorLengthI | ConnectorLengthRatioI | ConnectorOnDatabase | ConnectorOnDatabaseSources | ConnectorSmoothnessI | DomainArea | DomainAreaRatio | DomainAspectRatio | DomainEdgeLength | DomainLengthI | DomainLengthJ | DomainLengthRatioI | DomainLengthRatioJ | DomainMaximumAngle | DomainMinimumAngle | DomainOnDatabase | DomainOnDatabaseSources | DomainSkewEquiangle | DomainSkewEquiarea | DomainSmoothnessI | DomainSmoothnessJ | DomainWarp | EdgeWallSpacing | EdgeWallOrthogonality | FaceWallOrthogonality | FaceWallSpacing | DatabaseProximityBoundary | DatabaseProximitySurface | BlockDonorVolRatio | SizeField.

Returns

This action returns a new pw::Examine object.

getFunctionNames

pw::Examine getFunctionNames

This action gets a list of allowable function names.

Parameters

None

Returns

This action returns a list of strings representing the supported function names.

addSavedCut

pw::Examine addSavedCut type value <block | form> ?-excludeCellTypes type_list? ?user_normal?

This action adds a cut to the list of saved cuts for block examine.

Parameters

typeThis parameter is the type of cut: either User, X, Y, Z, I, J, or K.
valueThis parameter is the value of the cut (float value for User, X, Y, or Z type cuts, integer value for I, J, or K type cuts).
formFor User, X, Y, or Z type cuts, this optional parameter specifies the type of cut to make: either Cells, Flat, or Crinkle.
blockFor I, J, or K type cuts, this optional parameter specifies the pw::Block object to which the cut applies.
-excludeCellTypesspecify a list of cell types to exclude.  Currently, the supported values are “Tet”, “Pyramid”, “Prism”, and “Hex”.  Excluded cells are not displayed in the cut but do not effect the examine metric.
user_normalIf the type is User, this parameter should indicate the cutting plane normal as a vector of three float numbers.  This parameter is required if the type is User, and must not be present for any other type.

Returns

This action returns the integer cut index.

removeSavedCut

pw::Examine removeSavedCut type value <block | form> ?-excludeCellTypes type_list? ?user_normal?

This action removes a cut from the list of saved cuts for block examine.

Parameters

typeThis parameter is the type of cut: either User, X, Y, Z, I, J, or K.
valueThis parameter is the value of the cut (float value for User, X, Y, or Z type cuts, integer value for I, J, or K type cuts).
formFor User, X, Y, or Z type cuts, this optional parameter specifies the type of cut to make: either Cells, Flat, or Crinkle.
blockFor I, J, or K type cuts, this optional parameter specifies the pw::Block object to which the cut applies.
-excludeCellTypesspecify a list of cell types to exclude.  Currently, the supported values are “Tet”, “Pyramid”, “Prism”, and “Hex”.  Excluded cells are not displayed in the cut but do not effect the examine metric.
user_normalIf the type is User, this parameter should indicate the cutting plane normal as a vector of three float numbers.  This parameter is required if the type is User, and must not be present for any other type.

Returns

This action returns a boolean, which is true if successful.

getSavedCutCount

pw::Examine getSavedCutCount

This action gets the number of saved cuts for block examine.

Parameters

None

Returns

This action returns the integer number of saved cuts.

getSavedCut

pw::Examine getSavedCut index

This action gets the specified saved cut for block examine.

Parameters

indexThis parameter is the integer index of the saved cut; [0, number of saved cuts).

Returns

This action returns the specified saved cut as a list of seven or eight values in the following order.  The first value is the cut type (User, X, Y, Z, I, J, or K).  The second value is the cut value.  The third value is either the form (Cells, Flat, or Crinkle) for User, X, Y, and Z cuts, or the pw::Block object to which the cut applies for I, J, and K cuts.  The fourth value is a list of string specifying cell types that are excluded from the cut (“Tet”, “Pyramid”, “Prism”, “Hex”).  If the cut type is User, there will be an fifth value representing the normal vector of the cutting plane.

domainArea

pw::Examine domainArea ?-intervals number? resultsVar domain_list

This action reports statistics about the cell area of domains.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
domain_listThis parameter is a list of pw::Domain objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

domainSkewMinimum

pw::Examine domainSkewMinimum ?-intervals number? resultsVar domain_list

This action reports statistics about the minimum skew of domains.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
domain_listThis parameter is a list of pw::Domain objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

domainSkewMaximum

pw::Examine domainSkewMaximum ?-intervals number? resultsVar domain_list

This action reports statistics about the maximum skew of domains.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
domain_listThis parameter is a list of pw::Domain objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

domainSkewAngle

pw::Examine domainSkewAngle ?-intervals number? resultsVar domain_list

This action reports statistics about the skew angle of domains.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
domain_listThis parametere is a list of pw::Domain objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

blockVolume

pw::Examine blockVolume ?-intervals number? resultsVar block_list

This action reports statistics about the cell volume of blocks.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
block_listThis parameter is a list of pw::Block objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

blockSkewMinimum

pw::Examine blockSkewMinimum ?-intervals number? resultsVar block_list

Thsi action reports statistics about the cell minimum skew of blocks.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
block_listThis parameter is a list of pw::Block objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

blockSkewMaximum

pw::Examine blockSkewMaximum ?-intervals number? resultsVar block_list

This action reports statistics about the cell maximum skew of blocks.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
block_listThis parameter is a list of pw::Block objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

blockSkewAngle

pw::Examine blockSkewAngle ?-intervals number? resultsVar block_list

This action reports statistics about the cell skew angle of blocks.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
block_listThis parameter is a list of pw::Block objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

blockJacobian

pw::Examine blockJacobian ?-intervals number? resultsVar block_list

This action reports statistics about the blocks’ Jacobians.

Parameters

-intervals numberThis optional parameter is the integer number of intervals in the histogram with the range [1, infinity).  The default is 10.
resultsVarThis parameter is the string name of an array in which to store the results.
block_listThis parameter is a list of pw::Block objects.

Returns

This action returns nothing.  Results will be in the resultsVar array.

Instance Actions

delete

$examine delete

This action deletes this examine object.

Parameters

None

Returns

This action returns nothing.

clear

$examine clear

This action clears any computed data.

Parameters

None

Returns

This action returns nothing.

examine

$examine examine ?-excludeCellTypes type_list?

This action executes the examine function for each entity added to the examine object.

Parameters

-excludeCellTypesspecify a list of cell types to exclude.  Currently, the supported values are “Tet”, “Pyramid”, “Prism”, and “Hex”.  The excluded cells will still have values calculated, but they will not be factored into the minimum value, maximum value, average value, below range count, above range count, or interval total calculations.  Note that only some examine functions honor this request.

Returns

This action returns nothing.

refilter

$examine refilter

This action processes the computed examine data again with any modified values in the interval count or range limits without recalculating the examine functions on each entity.

Parameters

None

Returns

This action returns nothing.

getAverage

$examine getAverage

This action gets the average value computed during the last call to examine.

Parameters

None

Returns

This action returns the float average value.

getMaximum

$examine getMaximum ?-entity entVar? ?-location locVar?

This action gets the maximum value computed during the last call to examine.

Parameters

-entity entVarThis optional parameter is a string variable name which will be assigned with the pw::Entity object which contains the maximum value.  For metrics that perform calculations at the boundaries of database surfaces, this will be a boundary.
-location locVarThis optional parameter is a string variable name which will be assigned with the location within the entity of the maximum value as a list of 1 to 3 indices depending on the entity type.

Returns

This action returns the maximum value.

getMinimum

$examine getMinimum ?-entity entVar? ?-location locVar?

This action gets the minimum value computed during the last call to examine.

Parameters

-entity entVarThis optional parameter is a string variable name which will be assigned with the pw::Entity object which contains the minimum value.  For metrics that perform calculations at the boundaries of database surfaces, this will be a boundary.
-location locVarThis optional parameter is a string variable name which will be assigned with the location within the entity of the minimum value as a list of 1 to 3 indices depending on the entity type.

Returns

This action returns the minimum value.

getEntityCount

$examine getEntityCount ?-entities entsVar?

This action gets the number of entities being examined and optionally sets a variable to the list of entities.

Parameters

-entities entsVarThis optional parameter is a string variable name that will be assigned with a list of the pw::Entity objects being examined.

Returns

This action returns the integer number of entities.

addEntity

$examine addEntity entities

This action adds one or more entities to the examine object.

Parameters

entitiesThis parameter is a list of pw::Entity objects.

Returns

This action returns the integer total number of entities in the examine object.

removeEntity

$examine removeEntity entities

This action removes one or more entities from the examine object.

Parameters

entitiesThis parameter is a list of pw::Entity objects.

Returns

This action returns the integer total number of entities remaining in the examine object.

removeAll

$examine removeAll

This action removes all entities from the examine object.

Parameters

none

Returns

nothing

getRangeLimits

$examine getRangeLimits

This action returns the lower and upper cutoff limits.

Parameters

None

Info

When setting the range limits, they are only applied to the next examine call.  This function will return the current range limits.  If they were set since the last call to examine or refilter, these values will not correspond to the counts returned by the getAboveRange, getInRange, and getBelowRange functions.  Those values will have been computed from the range limits that were active at the time the examine or refilter function was last called.

Returns

This action returns a list comprised of the lower and upper cutoff limits, in that order, with each value being either the float number or the text “None” if no limit was specified.

setRangeLimits

$examine setRangeLimits < None | lower > < None | upper >

This action sets the lower and upper cutoff limits to be applied during the next call to examine or refilter.

Parameters

lowerThis parameter is the float lower cutoff limit.
upperThis parameter is the float upper cutoff limit (must be greater than or equal to lower if the lower limit was specified).

Returns

This action returns nothing.

getBelowRange

$examine getBelowRange

This action gets the number of cells or points that were below the lower cutoff range during the last examine or refilter call.

Parameters

None

Info

If the range limits are changed, the counts returned by this function will only be valid if examine or refilter is called after the limits are changed.  Otherwise, it returns the values based on the limits that were active at the time of the last examine or refilter call.

Returns

This action returns the integer count of the cells or points below the lower cutoff limit that was active during the last examine or refilter call.

getInRange

$examine getInRange

This action gets the number of cells or points between the lower and upper cutoff limits (inclusive) during the last examine or refilter call.

Parameters

None

Info

If the range limits are changed, the counts returned by this function will only be valid if examine or refilter is called after the limits are changed.  Otherwise, it returns the values based on the limits that were active at the time of the last examine or refilter call.

Returns

This action returns the integer count of the cells or points between the lower and upper cutoff limits that were active during the last examine or refilter call.

getAboveRange

$examine getAboveRange

This action gets the number of cells or points that were above the upper cutoff range during the last examine call.

Parameters

None

Info

If the range limits are changed, the counts returned by this function will only be valid if examine or refilter is called after the limits are changed.  Otherwise, it returns the values based on the limits that were active at the time of the last examine or refilter call.

Returns

This action returns the integer count of cells or points above the upper cutoff limit that was active during the last examine or refilter call.

getIntervalCount

$examine getIntervalCount

This action gets the number of intervals used for the histogram when examine or refilter was last run.

Parameters

None

Returns

This action returns the integer number of intervals used for the histogram during the last examine or refilter call.

setIntervalCount

$examine setIntervalCount count

This action sets the number of intervals to use for the histogram.

Parameters

countThis parameter is the integer number of intervals in the range [0, infinity).  A value of 0 turns off histogram reporting.

Returns

This action returns nothing.

getIntervalLimits

$examine getIntervalLimits

This action gets the limits of all intervals in the histogram.

Parameters

None

Info

If the range limits or interval counts are changed, the values returned by this function will only be valid if examine or refilter is called after the limits or interval counts are changed.  Otherwise, it returns the values based on the specifications that were active at the time of the last examine or refilter call.

Returns

This action returns a list of float values representing the interval limits with the first value representing the lower cutoff range, the next value representing the boundary between the first and second interval, etc., up to the last value which represent the upper cutoff range.

getIntervalTotal

$examine getIntervalTotal interval

This action gets the number of values in the specified interval.

Parameters

intervalThis parameter is the integer number of the interval to get the total of; [1, number of intervals].

Info

If the range limits or interval counts are changed, the values returned by this function will only be valid if examine or refilter is called after the limits or interval counts are changed.  Otherwise, it returns the values based on the specifications that were active at the time of the last examine or refilter call.

Returns

This action returns the integer number of values in the interval.

getIntervalTotals

$examine getIntervalTotals

This action gets the number of values in all intervals.

Parameters

None

Info

If the range limits or interval counts are changed, the values returned by this function will only be valid if examine or refilter is called after the limits or interval counts are changed.  Otherwise, it returns the values based on the specifications that were active at the time of the last examine or refilter call.

Returns

This action returns a list of integer number of values in each interval, starting with the lowest interval.

getValue

$examine getValue < entity | boundary > index

This action gets the computed value at a location within an entity.

Parameters

entityThis parameter is the pw::Entity object to query.
boundaryThis parameter is the boundary of a pw::Surface to query.  It is only allowed for metrics that perform calculations at the boundaries of database surfaces.
indexThis parameter is the point or cell index within the entity (will either be a 1-, 2-, or 3-integer value depending on the entity type).

Returns

This action returns a float representing the computed value at that point or cell.

getValueCount

$examine getValueCount ?< entity | boundary >?

This action gets the number of computed values either for a specific entity or for all entities.

Parameters

entityThis optional parameter is the pw::Entity object to query.
boundaryThis optional parameter is the boundary of a pw::Surface to query.  It is only allowed for metrics that perform calculations at the boundaries of database surfaces.

Returns

This action returns the integer count of computed values.  If an entity or boundary is specified, the value is the number of computed values for just that entity.  Otherwise, the value is the number of computed values for all examined entities.

getXYZ

$examine getXYZ < entity | boundary > index

This action gets the sample point at a location within an entity.  Note that this maps indices to points and does not necessarily have a direct correlation to indices used for non-point-based metrics.

Parameters

entityThis parameter is the pw::Entity object to query.
boundaryThis parameter is the boundary of a pw::Surface to query.  It is only allowed for metrics that perform calculations at the boundaries of database surfaces.
indexThis parameter is the point index within the entity (will either be a 1-, 2-, or 3-integer value depending on the entity type).

Returns

This action returns an XYZ vector.

getStencil

$examine getStencil ?-type typeVar? < entity | boundary > index

This action gets the grid or database coordinates for the examined element of an entity at a given point or cell index depending upon whether grid or database entities are being examined.  The values are returned as a list of point lists, with each point list representing an element of the stencil.  The number of values in each point list is interpreted according to the examine function type as returned by the -type flag.  The type value can be: Point, Line, Area, or Volume, or Wall.  For Point types, all elements will be a single point.  For Line types, all elements will be 2 points long.  For Area types, elements will be either 3 points long (a triangle) or 4 points long (a quadrangle, defined in counter-clockwise order by the right-hand rule).  For Volume types, elements will be either 4 points long (a tetrahedron), 5 points long (a pyramid with the base defined in counter-clockwise order as the first 4 points and the tip of the pyramid as the 5th point), 6 points long (prism with the first 3 points representing the base and the next 3 points representing the top in the same order as the bottom), or 8 points long (a hexahedron with one face represented in the first 4 points in counter-clockwise order and the next 4 points representing the opposite face in the same order).  For Wall types, elements will be 1 or 2 points long.

Parameters

-type typeVarThis optional parameter is a string variable name that will be assigned with the type of element used to measure the examine function.  It will be Point, Line, Area, Volume, or Wall.
entityThis parameter is the pw::Entity object to query.
boundaryThis parameter is the boundary of a pw::Surface to query.  It is only allowed for metrics that perform calculations at the boundaries of database surfaces.
indexThis parameter is the point or cell index within the entity.  It will either be a 1-, 2-, or 3-integer value depending on the entity type.

Returns

This action returns a list of coords.

getStencilXYZs

$examine getStencilXYZs ?-type type_var? < entity | boundary > index

This action gets the XYZ values for the examined element of an entity at a given point or cell index.  The values are returned as a list of point lists, with each point list representing an element of the stencil.  The number of values in each point list is interpreted according to the examine function type as returned by the -type flag.  The type value can be: Point, Line, Area, or Volume, or Wall.  For Point types, all elements will be a single point.  For Line types, all elements will be 2 points long.  For Area types, elements will be either 3 points long (a triangle) or 4 points long (a quadrangle, defined in counter-clockwise order by the right-hand rule).  For Volume types, elements will be either 4 points long (a tetrahedron), 5 points long (a pyramid with the base defined in counter-clockwise order as the first 4 points and the tip of the pyramid as the 5th point), 6 points long (prism with the first 3 points representing the base and the next 3 points representing the top in the same order as the bottom), or 8 points long (a hexahedron with one face represented in the first 4 points in counter-clockwise order and the next 4 points representing the opposite face in the same order).  For Wall types, elements will be 1 or 2 points long.

Parameters

-type typeVarThis optional parameter is a string variable name that will be assigned with the type of element used to measure the examine function.  It will be Point, Line, Area, Volume, or Wall.
entityThis parameter is the pw::Entity object to query.
boundaryThis parameter is the boundary of a pw::Surface to query.  It is only allowed for metrics that perform calculations at the boundaries of database surfaces.
indexThis parameter is the point or cell index within the entity.  It will either be a 1-, 2-, or 3-integer value depending on the entity type.

Returns

This action returns a list of vector XYZs.

getCategories

$examine getCategories

This action gets the list of categories for which separate counts are maintained.

Parameters

None

Returns

This action returns a list of strings representing the available categories.

getCategoryCount

$examine getCategoryCount category

This action gets the specified category count for the examine function.

Parameters

categoryThis parameter is a string representing the category name.  The full list can be retreived by calling the getCategories function.  Most examine functions will not have any categories.  The BlockJacobian function supports “Positive”, “PositiveSkew”, “Zero”, “Negative”, and “NegativeSkew”.  The OnDatabase functions support “Off” and “On”.  The OnDatabaseSources functions support “Off”, “On”, and any constraining database surface.  The BlockCellType functions support “Tet”, “Pryamid”, “Prism”, and “Hex”.

Returns

This action returns the integer count for that category.

setCurrentHighlighterPosition

$examine setCurrentHighlighterPosition point

This action gets the constant U and V lines for the examined entity at a given point.

Parameters

pointA point representing either a database coordinate on one of the examined database entities, or an XYZ value that will be projected to the closest database entity

Returns

nothing

getCurrentHighlighterPosition

$examine getCurrentHighlighterPosition

This action gets the value of the current highlighter position.  An error is raised if no position is set or if the function does not support a highlighter.

Parameters

none

Returns

point value indicating the highlighter position.

pw::Examine create type
This action creates an examine object.
pw::Examine getFunctionNames
This action gets a list of allowable function names.
pw::Examine addSavedCut type value <block | form> ?-excludeCellTypes type_list? ?user_normal?
This action adds a cut to the list of saved cuts for block examine.
pw::Examine removeSavedCut type value <block | form> ?-excludeCellTypes type_list? ?user_normal?
This action removes a cut from the list of saved cuts for block examine.
pw::Examine getSavedCutCount
This action gets the number of saved cuts for block examine.
pw::Examine getSavedCut index
This action gets the specified saved cut for block examine.
pw::Examine domainArea ?-intervals number? resultsVar domain_list
This action reports statistics about the cell area of domains.
pw::Examine domainSkewMinimum ?-intervals number? resultsVar domain_list
This action reports statistics about the minimum skew of domains.
pw::Examine domainSkewMaximum ?-intervals number? resultsVar domain_list
This action reports statistics about the maximum skew of domains.
pw::Examine domainSkewAngle ?-intervals number? resultsVar domain_list
This action reports statistics about the skew angle of domains.
pw::Examine blockVolume ?-intervals number? resultsVar block_list
This action reports statistics about the cell volume of blocks.
pw::Examine blockSkewMinimum ?-intervals number? resultsVar block_list
Thsi action reports statistics about the cell minimum skew of blocks.
pw::Examine blockSkewMaximum ?-intervals number? resultsVar block_list
This action reports statistics about the cell maximum skew of blocks.
pw::Examine blockSkewAngle ?-intervals number? resultsVar block_list
This action reports statistics about the cell skew angle of blocks.
pw::Examine blockJacobian ?-intervals number? resultsVar block_list
This action reports statistics about the blocks’ Jacobians.
$examine delete
This action deletes this examine object.
$examine clear
This action clears any computed data.
$examine examine ?-excludeCellTypes type_list?
This action executes the examine function for each entity added to the examine object.
$examine refilter
This action processes the computed examine data again with any modified values in the interval count or range limits without recalculating the examine functions on each entity.
$examine getAverage
This action gets the average value computed during the last call to examine.
$examine getMaximum ?-entity entVar? ?-location locVar?
This action gets the maximum value computed during the last call to examine.
$examine getMinimum ?-entity entVar? ?-location locVar?
This action gets the minimum value computed during the last call to examine.
$examine getEntityCount ?-entities entsVar?
This action gets the number of entities being examined and optionally sets a variable to the list of entities.
$examine addEntity entities
This action adds one or more entities to the examine object.
$examine removeEntity entities
This action removes one or more entities from the examine object.
$examine removeAll
This action removes all entities from the examine object.
$examine getRangeLimits
This action returns the lower and upper cutoff limits.
$examine setRangeLimits < None | lower > < None | upper >
This action sets the lower and upper cutoff limits to be applied during the next call to examine or refilter.
$examine getBelowRange
This action gets the number of cells or points that were below the lower cutoff range during the last examine or refilter call.
$examine getInRange
This action gets the number of cells or points between the lower and upper cutoff limits (inclusive) during the last examine or refilter call.
$examine getAboveRange
This action gets the number of cells or points that were above the upper cutoff range during the last examine call.
$examine getIntervalCount
This action gets the number of intervals used for the histogram when examine or refilter was last run.
$examine setIntervalCount count
This action sets the number of intervals to use for the histogram.
$examine getIntervalLimits
This action gets the limits of all intervals in the histogram.
$examine getIntervalTotal interval
This action gets the number of values in the specified interval.
$examine getIntervalTotals
This action gets the number of values in all intervals.
$examine getValue < entity | boundary > index
This action gets the computed value at a location within an entity.
$examine getValueCount ?< entity | boundary >?
This action gets the number of computed values either for a specific entity or for all entities.
$examine getXYZ < entity | boundary > index
This action gets the sample point at a location within an entity.
$examine getStencil ?-type typeVar? < entity | boundary > index
This action gets the grid or database coordinates for the examined element of an entity at a given point or cell index depending upon whether grid or database entities are being examined.
$examine getStencilXYZs ?-type type_var? < entity | boundary > index
This action gets the XYZ values for the examined element of an entity at a given point or cell index.
$examine getCategories
This action gets the list of categories for which separate counts are maintained.
$examine getCategoryCount category
This action gets the specified category count for the examine function.
$examine setCurrentHighlighterPosition point
This action gets the constant U and V lines for the examined entity at a given point.
$examine getCurrentHighlighterPosition
This action gets the value of the current highlighter position.
Base type for all glyph types
A string is an array of characters.
Examine type
A float is a fractional number.
An integer is a whole number.
Block type
A vector is a list of float values.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
Domain type
Entity type
A boundary is reference to either a database curve or the edge of a database surface.
Database surface type
A coord is a position in grid space.
A point is a position either in model space or database parameter space.