Glyph Version 3.18.3 |
pw:: BlockExtrudedExtruded block type Derives Frompw::Object pw::Entity pw::GridEntity pw::Block Summary
create
This action creates a new extruded block object. ParametersThere are no parameters. ReturnsThis action returns a new pw::BlockExtruded object. createFromPoints
This action, given at least one cell-type array and an extruded path of a list of lists of <xyz> values, creates an extruded block. No extruded block will be created if the cell-type array(s) define more than one face. ParametersThe following optional cell array parameters (at least one of which is required) are each a list of lists. The sub-lists represent indices into the points list for each vertex of the particular cell. For example, there are 3 vertices for each triangle. Therefore, the ‘triCellArray’ will consist of N sub-lists, where each sub-list has 3 indices representing the three vertices of the triangle. The indices are 1-based. These arrays describe the base face layer of the block.
The next two parameters are additional optional parameters, neither of which is required. They are used when creating the domain(s) for the base face of the new extruded block.
This is a required parameter
ReturnsThis action returns the newly created extruded block. ExampleThis example shows how a rotated extruded block can be created from a set of points and quadrilateral connectivity. Code # Rotate a list of points an angle about an axis getPoint
This action gets the position of a block grid point. Parameters
ReturnsThis action returns a point giving the grid point position (may be in the form “u v dbentity”). setPoint
This action sets the position of a block interior grid point. Parameters
ReturnsThis action returns nothing. InformationBlock points are not currently db-constrained, so any database information in the point argument is converted to pure XYZ data before being stored. setPoints
This action extrudes the block along the path specified by the extrudePoints list. Parameters
ReturnsThis action returns nothing. ExampleThis example shows how a rotated extruded block can be created from a set of points and triangle connectivity. Code # Rotate a list of points an angle about an axis isInteriorIndex
This action checks to see if an index corresponds to a point in the interior of the block. Parameters
ReturnsThis action returns true if the index is an interior point. getAdjacentIndices
This action returns the indices that are directly connected to the specified index. Parameters
ReturnsThis action returns a list of indices representing the adjacent coordinates. The form of each index will be the same as the input form. If index is used or -linear is specified, the result will be a list of integer linear indices. If ijk_index is used and -linear is not specified, the result will be a list of ijk indices. getCellsUsingIndex
This action returns the indices that are directly connected to the specified index. Parameters
ReturnsThis action returns a list of cell entries using the specified point. Each cell entry will be a list of point indices comprising the cell. The form of each point index will be the same as the input form. If index is used or -linear is specified, each cell entry will be a list of integer linear indices. If ijk_index is used and -linear is not specified, each cell entry will be a list of ijk indices. getPosition
This action gets the position in the defining space of the block at the given index. Parameters
ReturnsThis action returns a point giving the position on the block (may be in the form “u v dbentity”). InformationEven though it is not needed, the -grid switch is included here to be consistent with the other grid entity getPosition methods. The following calls are equivalent: $extblk1 getPosition -grid [list 1 2 3] See Alsopw::Block.getPosition pw::BlockStructured.getPosition pw::Connector.getPosition pw::Domain.getPosition pw::DomainStructured.getPosition getXYZ
This action gets the position of the block in model space at the given index. Parameters
ReturnsThis action returns an XYZ vector. InformationEven though it is not needed, the -grid switch is included here to be consistent with the other grid entity getPosition methods. The following calls are equivalent: $extblk1 getXYZ -grid 22 See Alsopw::Block.getXYZ pw::BlockStructured.getXYZ pw::Connector.getXYZ pw::Domain.getXYZ pw::DomainStructured.getXYZ getCell
This action gets the indices of the given cell. Parameters
ReturnsThis action returns an integer list of linear point indicies if the index parameter is used, or list of ijk point indicies if the ijk_index parameter is used. getFace
This action gets the face at the given index or computational boundary. Parameters
ReturnsThis action returns a pw::FaceUnstructured object. addFace
This action adds a face to the block. Only a single face can be added to the block, and it must be added prior to extrusion. Parameters
ReturnsThis action returns nothing. canReExtrude
This action returns true if the entity can be re-extruded. Parametersnone ReturnsThis action returns a boolean value indicating if the entity can be re-extruded. ExampleThis example shows how to get a list of all entities that can be re-extruded. Code puts "Entities valid for re-extrusion:" getExtrusionSolverAttribute
This action gets the named extrusion solver attribute. Parameters
ReturnsThe action returns the actual or default value of the attribute. The returned data-type is dependent on the target attribute. See AlsoGeneric Extrusion Solver Attributes, Translational Extrusion Solver Attributes, Path Extrusion Solver Attributes, Rotational Extrusion Solver Attributes, Normal Extrusion Solver Attributes, Spacing Extrusion Solver Attributes setExtrusionSolverAttribute
This action sets the named extrusion solver attribute. Parameters
ReturnsThis actioin returns nothing. getExtrusionBoundaryCondition
This action gets the boundary condition at a given connector region. Parameters
ReturnsThis action returns the name of the boundary condition, except in the case of DatabaseConstrained and AdjacentGrid. In those cases, this action returns a list containing the name of the boundary condition and the pertinent entities (pw::DatabaseEntity or pw::DomainStructured). Boundary Conditions
setExtrusionBoundaryCondition
This action sets the boundary condition at a given connector region. Parameters
ReturnsThis action returns nothing. See AlsoMode
This gets/sets the extrusion mode of this block. TypeThis attribute is of type string; < NormalAlgebraic | Path | Rotate | Translate >. DefaultThe default for this attribute is NormaAlgebraic. StopAtPositiveSkewJacobian
This enables / disables the positive skew jacobian stop condition. TypeThis attribute is a boolean property with a default value (i.e., “Default” = true) that can be set with the string “Off” (false) or any boolean value. DefaultThe default for this attribute is true. StopAtZeroJacobian
This enables / disables the zero jacobian stop condition. TypeThis attribute is a boolean property with a default value (i.e., “Default” = true) that can be set with the string “Off” (false) or any boolean value. DefaultThe default for this attribute is true. StopAtNegativeSkewJacobian
This enables / disables the negative skew jacobian stop condition. TypeThis attribute is a boolean property with a default value (i.e., “Default” = true) that can be set with the string “Off” (false) or any boolean value. DefaultThe default for this attribute is true. StopAtNegativeJacobian
This enables / disables the negative jacobian stop condition. TypeThis attribute is a boolean property with a default value (i.e., “Default” = true) that can be set with the string “Off” (false) or any boolean value. DefaultThe default for this attribute is true. DirectionFlipped
This specifies whether the extrusion direction is flipped. TypeThis attribute is a boolean. DefaultThe default for this attribute is false. PlaneAngleTolerance
This specifies the angle tolerance for determining when an arbitrary plane BC is considered equal to a Cartesian plane BC. TypeThis attribute is of type float with a range of [0.0, 90.0). DefaultThe default for this attribute is defined in the GgBlockExtrudeNormalAtts class. PlaneDeviationTolerance
This specifies the deviation tolerance for determining when an arbitrary plane BC is considered to be planar. TypeThis attribute is of type float with a range of [0.0, inf). DefaultThe default for this attribute is defined in the GgBlockExtrudeNormalAtts class. TranslateDirection
This gets/sets the direction vector for translate extrusion. TypeThis attribute is of type vector. DefaultThe default for this attribute is (1, 0, 0). TranslateDistance
This gets/sets the distance for translate extrusion. TypeThis attribute is of type float. DefaultThe default for this attribute is 1.0. PathConnectors
This gets/sets a list of connectors for the path. Type
DefaultThe default for this attribute is an empty list. PathMaximumSteps
This is the maximum number of steps available as the path extrusion is configured. TypeThis is of type integer. InformationThis attribute is read only. PathUseTangent
This gets/sets the flag indicating if the path extrusion should be rotated tangentally to the path connector. TypeThis attribure is of type boolean. DefaultThe default for this attribute is true. RotateAxisStart
This gets/sets the starting axis vector for rotate extrusion. TypeThis attribute is of type vector. DefaultThe default for this attribute is (0, 0, 0). RotateAxisEnd
This gets/sets the ending axis vector for rotate extrusion. TypeThis attribute is of type vector. DefaultThe default for this attribute is (1, 0, 0). RotateAngle
This gets/sets the angle (degrees) for rotational extrusion. TypeThis attribute is of type float with the range [0.0, 360]. DefaultThe default for this attribute is 0.0. NormalInitialStepSize
This gets/sets the size of the first marching step to value. TypeThis attribute is of type float with the range (0.0, infinity). DefaultThe default for this attribute is 0.01. NormalMaximumStepSize
This gets/sets the upper limit for the marching step size. TypeThis attribute is of typw float with the range [0, infinity); use 0 to disable limit. DefaultThe default for this attribute is 0.0. NormalMinimumStepSize
This gets/sets a upper limit for the marching step size. TypeThis attribute is of type float with the range [0, infinity); use 0 to disable limit. DefaultThe defaule for this attribute is 0.0. NormalCornerFactor
This gets/sets a scale factor for reducing the local marching step in convex regions and increasing the marching step size in concave regions. TypeThis attribute is of type float with the range [1, 100). DefaultThe default for this attribute is 0.0. InformationThis attribute only affects algebraic normal extrusion. NormalDirectionRelaxation
The normals in the marching direction are smoothed locally using a LaPlace filter. This option gets/sets the relaxation factor for the filter. TypeThis attribute is of type float with the range [0.0, 1.0]. DefaultThe default for this attribute is Default. InformationThis attribute only affects algebraic normal extrusion. NormalDirectionRelaxationIterations
The normals in the marching direction are smoothed locally using a Lalace filter. This option gets/sets the number of marching iterations for the filter. TypeThis attribute is of type integer with the range [0, infinity). DefaultThe default for this attribute is Default. InformationThis attribute only affects algebraic normal extrusion. NormalStepSizeRelaxation
This gets/sets the relaxation smoothing factor. The marching step size is smoothed locally using a LaPlace filter. TypeThis attribute is of type float with the range [0.0, 1.0]. DefaultThe default for this attribute is Default. InformationThis attribute only affects algebraic normal extrusion. NormalStepSizeRelaxationIterations
This gets/sets the number of marching iterations for the LaPlace filter. The marching step size is smoothed locally using a LaPlace filter. TypeThis attribute is of type integer with the range [0, infinity). DefaultThe default for this attribute is Default. InformationThis attribute only affects algebraic normal extrusion. NormalFeatureSmoothing
This specifies whether knife edge features are smoothed. TypeThis attribute is of type boolean. DefaultThe default for this attribute is true. NormalQualitySmoothing
This enables/disables normal smoothing based on a quality metric. TypeThis attribute is of type boolean. DefaultThe default for this attribute is true. NormalInteriorOnlySmoothing
This enables/disables interior only quality based smoothing. TypeThis attribute is of type boolean. DefaultThe default for this attribute is false. NormalMaximumIterationsSmoothing
This specifies/retrieves the maximum number of smoothing iterations. TypeThis attribute is of type integer with the range (1, infinity). DefaultThe default for this attribute is 5. NormalBlendExponentSmoothing
This specifies/retrieves the blend exponent for smoothing. A value of zero uses the local minimum cell quality metric at the node normal. A value of 2 uses the average cell quality metric at the node normal. A value in between is a blending of the two approaches. TypeThis attribute is of type float with the range (0.0, 2.0). DefaultThe default for this attribute is 2.0. SpacingMode
This gets/sets the spacing configuration for the extrusion. “Algebraic” mode uses a linear spacing for translational, rotational and path extrusions. For normal extrusions, the “Algebraic” mode spaces the grid by applying a geometric growth controlled by SpacingGrowthFactor. TypeThis attribute is of type string; < Algebraic | Connector >. DefaultThe default for this attribute is Algebraic. SpacingGrowthFactor
This specifies how the marching step size will grow from its initial value. TypeThis attribute is of type float with the range (0.0, infinity). DefaultThe default for this attribute is 1.10. SpacingConnectors
This gets/sets the collection of connector-object and subconnector- index pairs that specify how the marching step size will grow from its initial value. TypeThis attribute is of type subcon_list which is a list of subconnectors where each entry is a pw::Connector object and subconnector index. If the pw::Connector only has one subconnector, the index can be omitted. The direction of the chain of subconnectors can be specified by using either the word ‘Forward’ or the word ‘Reverse’ as the very first entry. This is only necessary when the list of subconnectors is comprised of a single subconnector. Otherwise, the direction can be determined from the order of the subconnectors. DefaultThe default for this attribute is an empty list. See Also |
This action creates a new extruded block object.
pw::BlockExtruded create
This action, given at least one cell-type array and an extruded path of a list of lists of xyz values, creates an extruded block.
pw::BlockExtruded createFromPoints ?-triangles tricellArray? ?-quadrilaterals quadCellArray? ?-splitAngle angle? ?-splitMultiLoop? extrudePoints
This action gets the position of a block grid point.
$block getPoint ?-constrained constrainedVar? < index | ijk_index >
This action sets the position of a block interior grid point.
$block setPoint < index | ijk_index > point
This action extrudes the block along the path specified by the extrudePoints list.
$block setPoints extrudePoints
This action checks to see if an index corresponds to a point in the interior of the block.
$block isInteriorIndex < index | ijk_index >
This action returns the indices that are directly connected to the specified index.
$block getAdjacentIndices ?-linear? < index | ijk_index >
This action returns the indices that are directly connected to the specified index.
$block getCellsUsingIndex ?-linear? < index | ijk_index >
This converts a block’s ijk index to a linear index.
$blk getLinearIndex ijk_index
This action gets the position in the defining space of the block at the given index.
$block getPosition ?-grid? < index | ijk_index >
This action gets the position of the block in model space at the given index.
$block getXYZ ?-grid? < index | ijk_index >
This action gets the indices of the given cell.
$block getCell < index | ijk_index >
This action gets the face at the given index or computational boundary.
$block getFace < index | boundary >
This action adds a face to the block.
$block addFace face
This action returns true if the entity can be re-extruded.
$entity canReExtrude
This action gets the named extrusion solver attribute.
$block getExtrusionSolverAttribute att_name ?value_type?
This action sets the named extrusion solver attribute.
$block setExtrusionSolverAttribute att_name att_value
This action gets the boundary condition at a given connector region.
$block getExtrusionBoundaryCondition edge_con_pair
This action sets the boundary condition at a given connector region.
$block setExtrusionBoundaryCondition edge_con_pair boundary_condition ?entity_list?
This gets/sets the extrusion mode of this block.
$block get/setExtrusionSolverAttribute Mode mode
This specifies or disables the height stop condition.
$block get/setExtrusionSolverAttribute StopAtHeight < height | Off | Default >
This specifies or disables the max aspect ratio stop condition.
$block get/setExtrusionSolverAttribute StopAtAspectRatio < ratio | Off | Default >
This specifies or disables the min skew angle stop condition.
$block get/setExtrusionSolverAttribute StopAtSkewAngle < angle | Off | Default >
This enables / disables the positive skew jacobian stop condition.
$block get/setExtrusionSolverAttribute StopAtPositiveSkewJacobian < Default | Off | bool_value >
This enables / disables the zero jacobian stop condition.
$block get/setExtrusionSolverAttribute StopAtZeroJacobian < Default | Off | bool_value >
This enables / disables the negative skew jacobian stop condition.
$block get/setExtrusionSolverAttribute StopAtNegativeSkewJacobian < Default | Off | bool_value >
This enables / disables the negative jacobian stop condition.
$block get/setExtrusionSolverAttribute StopAtNegativeJacobian < Default | Off | bool_value >
This specifies whether the extrusion direction is flipped.
$block get/setExtrusionSolverAttribute DirectionFlipped flipped
This specifies the angle tolerance for determining when an arbitrary plane BC is considered equal to a Cartesian plane BC.
$block get/setExtrusionSolverAttribute PlaneAngleTolerance < Default | tolerance >
This specifies the deviation tolerance for determining when an arbitrary plane BC is considered to be planar.
$block get/setExtrusionSolverAttribute PlaneDeviationTolerance < Default | tolerance >
This gets/sets the direction vector for translate extrusion.
$block get/setExtrusionSolverAttribute TranslateDirection direction
This gets/sets the distance for translate extrusion.
$block get/setExtrusionSolverAttribute TranslateDistance distance
This gets/sets a list of connectors for the path.
$block get/setExtrusionSolverAttribute PathConnectors <con_list>
This is the maximum number of steps available as the path extrusion is configured.
$block getExtrusionSolverAttribute PathMaximumSteps steps
This gets/sets the flag indicating if the path extrusion should be rotated tangentally to the path connector.
$block get/setExtrusionSolverAttribute PathUseTangent use
This gets/sets the starting axis vector for rotate extrusion.
$block get/setExtrusionSolverAttribute RotateAxisStart axis
This gets/sets the ending axis vector for rotate extrusion.
$block get/setExtrusionSolverAttribute RotateAxisEnd axis
This gets/sets the angle (degrees) for rotational extrusion.
$block get/setExtrusionSolverAttribute RotateAngle degrees
This gets/sets the size of the first marching step to value.
$block get/setExtrusionSolverAttribute NormalInitialStepSize < Default | size >
This gets/sets the upper limit for the marching step size.
$block get/setExtrusionSolverAttribute NormalMaximumStepSize < Default | size >
This gets/sets a upper limit for the marching step size.
$block get/setExtrusionSolverAttribute NormalMinimumStepSize < Default | size >
This gets/sets a scale factor for reducing the local marching step in convex regions and increasing the marching step size in concave regions.
$block get/setExtrusionSolverAttribute NormalCornerFactor factor
The normals in the marching direction are smoothed locally using a LaPlace filter.
$block get/setExtrusionSolverAttribute NormalDirectionRelaxation < Default | factor >
The normals in the marching direction are smoothed locally using a Lalace filter.
$block get/setExtrusionSolverAttribute NormalDirectionRelaxationIterations < Default | iterations >
This gets/sets the relaxation smoothing factor.
$block get/setExtrusionSolverAttribute NormalStepSizeRelaxation < Default | factor >
This gets/sets the number of marching iterations for the LaPlace filter.
$block get/setExtrusionSolverAttribute NormalStepSizeRelaxationIterations < Default | iterations >
This specifies whether knife edge features are smoothed.
$block get/setExtrusionSolverAttribute NormalFeatureSmoothing < Default | bool_value >
This enables/disables normal smoothing based on a quality metric.
$block get/setExtrusionSolverAttribute NormalQualitySmoothing < Default | bool_value >
This enables/disables interior only quality based smoothing.
$block get/setExtrusionSolverAttribute NormalInteriorOnlySmoothing < Default | bool_value >
This specifies/retrieves the maximum number of smoothing iterations.
$block get/setExtrusionSolverAttribute NormalMaximumIterationsSmoothing < Default | maxIters >
This specifies/retrieves the blend exponent for smoothing.
$block get/setExtrusionSolverAttribute NormalBlendExponentSmoothing < Default | blendExp >
This gets/sets the spacing configuration for the extrusion.
$block get/setExtrusionSolverAttribute SpacingMode < Algebraic | Connector | Default >
This specifies how the marching step size will grow from its initial value.
$block get/setExtrusionSolverAttribute SpacingGrowthFactor < Default | factor >
This gets/sets the collection of connector-object and subconnector- index pairs that specify how the marching step size will grow from its initial value.
$block get/setExtrusionSolverAttribute SpacingConnectors spacing_pairs
This action gets the position in the defining space of the block at the given index.
$block getPosition ?-grid? index
This action gets the position in the defining space of the block at the given index.
$block getPosition ?-grid? < index | ijk_index >
This action gets a position on a connector in the defining space of the connector.
$con getPosition ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value
This action gets a position in the defining space of the domain.
$dom getPosition ?-grid? value
This action gets the position in the defining space of the domain at the given index.
$dom getPosition ?-grid? value
This action gets the position of the block in model space at the given index.
$block getXYZ ?-grid? index
This action gets the position of the block in model space at the given index.
$block getXYZ ?-grid? < index | ijk_index >
This action gets the model space position on a connector.
$con getXYZ ?< -grid | -control | -parameter | -arc | -X | -Y | -Z | -closest >? value
This action gets a position of the domain in model space.
$dom getXYZ ?-grid? value
This action gets the position of the domain in model space at the given index.
$dom getXYZ ?-grid? value