pw:: Examine

pw::Examine create type

This action creates an examine object.

Parameters

Returns

This action returns a new pw::Examine object.

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.

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

Returns

This action returns the integer cut index.

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

Returns

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

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.

pw::Examine getSavedCut index

This action gets the specified saved cut for block examine.

Parameters

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.

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

This action reports statistics about the cell area of domains.

Parameters

Returns

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

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

This action reports statistics about the minimum skew of domains.

Parameters

Returns

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

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

This action reports statistics about the maximum skew of domains.

Parameters

Returns

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

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

This action reports statistics about the skew angle of domains.

Parameters

Returns

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

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

This action reports statistics about the centroid X coordinate of domains.

Parameters

Returns

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

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

This action reports statistics about the centroid Y coordinate of domains.

Parameters

Returns

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

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

This action reports statistics about the centroid Z coordinate of domains.

Parameters

Returns

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

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

This action reports statistics about the cell volume of blocks.

Parameters

Returns

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

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

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

Parameters

Returns

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

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

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

Parameters

Returns

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

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

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

Parameters

Returns

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

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

This action reports statistics about the cell centroid X coordinate of blocks.

Parameters

Returns

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

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

This action reports statistics about the cell centroid Y coordinate of blocks.

Parameters

Returns

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

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

This action reports statistics about the cell centroid Z coordinate of blocks.

Parameters

Returns

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

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

This action reports statistics about the blocks’ Jacobians.

Parameters

Returns

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

$examine delete

This action deletes this examine object.

Parameters

None

Returns

This action returns nothing.

$examine clear

This action clears any computed data.

Parameters

None

Returns

This action returns nothing.

$examine examine ?-excludeCellTypes type_list?

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

Parameters

Returns

This action returns nothing.

$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.

$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.

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

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

Parameters

Returns

This action returns the maximum value.

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

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

Parameters

Returns

This action returns the minimum value.

$examine getEntityCount ?-entities entsVar?

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

Parameters

Returns

This action returns the integer number of entities.

$examine getEntities

This action the list of entities being examined.

Parameters

None.

Returns

This action returns a list of entities.

$examine addEntity entities

This action adds one or more entities to the examine object.  If successful, the metric data is cleared.

Parameters

Returns

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

$examine removeEntity entities

This action removes one or more entities from the examine object.  The metric data will be cleared if the last entity is removed.

Parameters

Returns

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

$examine removeAll

This action removes all entities from the examine object.  The metric data will be cleared.

Parameters

none

Returns

nothing

$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.

$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

Returns

This action returns nothing.

$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.

$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.

$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.

$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.

$examine setIntervalCount count

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

Parameters

Returns

This action returns nothing.

$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.

$examine getIntervalTotal interval

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

Parameters

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.

$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.

$examine getValue < entity | boundary > index

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

Parameters

Returns

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

$examine getValues < entity | boundary >

This action gets the list of computed values within an entity.

Parameters

Returns

This action returns a list of floats representing the computed values for an entity.

$examine getValueAtPoint entity index

This action gets the computed value at a grid point location within an entity.  Values are interpolated to the point if the examine element type is cell based or edge based.

Parameters

Returns

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

$examine getValueCount ?< entity | boundary >?

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

Parameters

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.

$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

Returns

This action returns an XYZ vector.

$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, Wall, Voxel, UnsVoxel, ControlVolume, or Deviation.  For Point, Voxel, and UnsVoxel types, all elements will be a single point.  For Line types, all elements will be 2 points long.  For Area and Deviation 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.  For Control Volume types, the first and only element in the list will be 1 point long (indicating the node for which the control volume was created).

Parameters

Returns

This action returns a list of coords.

$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, Wall, Voxel, UnsVoxel, ControlVolume, or Deviation.  For Point, Voxel, and UnsVoxel 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.  For Control Volume types, the first element in the list will be 1 point long (indicating the node for which the control volume was created) and remaining elements will be 4 points long (a quadrangle, defined in counter-clockwise order by the right-hand rule) defining the control volume.  For Deviation types, elements will be 2 points long: the first is the base point on the linear cell and the second is the projected point on the constrained database.

Parameters

Returns

This action returns a list of vector XYZs.

$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.

$examine getCategoryCount category

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

Parameters

Returns

This action returns the integer count for that category.

$examine setCurrentHighlighterPosition point

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

Parameters

Returns

nothing

$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.