Glyph Version 7.22.2 |
pw:: GridEntityBase type for all grid entities. A grid entity is a zero-, one-, two- or three-dimensional collection of discrete cell elements, defined by discrete point locations and connectivity in space. Derives FromSummary
getByName
This action gets a grid entity using the name. Parameters
ReturnsThis action returns a pw::GridEntity object. ExampleThis example shows how to get a grid entity named blk-1 and then find the cell count. Code set block(1) [pw::GridEntity getByName "blk-1"] Output blk-1 has 23440 cells. project
This action projects grid entities onto database entities. Parameters
ReturnsThis action returns nothing. NoteIf the entities parameter contains any pw::Domain objects, it is an error to include any pw::Curve objects in the dbentities parameter. ExampleThis example shows how to project a grid entity cylindrically out from the Z-axis and onto the first database entities it encounters in that path. $con(1) is referencing an existing connector. Code pw::GridEntity project -type CylindricalOut \ getAdjacentEntities
This action gets a list of entities adjacent to the given entities. If the -all flag is specified, the process is repeated until no more adjacent entities are found. The return list will not include any entities specified in the argument list. Parameters
ReturnsThis action returns a list of adjacent pw::GridEntity objects. ExampleThis example shows how to get a list of all adjacent grid entities using a given grid entity. $block(1) is referencing an existing block. Code foreach ge [pw::GridEntity getAdjacentEntities $block(1)] { Output blk-2 getUniquePointCount
This action returns the number of unique points among the specified node, connector, domain and/or block entities (contained in a list of entities) or identified by specifying the entity type. Parameters
InformationEither -type or entities must be specified. ReturnsThis action returns an integer value. SizeFieldDecay (Default)
This default is the size field decay factor of a grid entity when it is created. TypeA float in the range [0.0, 1.0]. DefaultThe default value is 0.85. SizeFieldBackgroundSpacing (Default)
This default is the size field background spacing of a grid entity when it is created. TypeA float in the range [0.0, infinity). DefaultThe default value is 0.0. SizeFieldCalculationMethod (Default)
This default is the size field calculation method of a grid entity when it is created. TypeA string with options < MinimumDistance | InverseDistance | BlendDistance | MinimumValue > DefaultThe default for this attribute is MinimumDistance IgnoreAllSources
This attribute is a flag that controls whether the influence of sources should be ignored when determining grid point locations. TypeThis attribute is a boolean. DefaultThe default for this attribute is false. IgnoreAllSizeFieldEntities
This attribute is a flag that controls whether the influence of explicitly included entities should be ignored when determining grid point locations. TypeThis attribute is a boolean. DefaultThe default value of this attribute is false. SizeFieldDecay
This attribute is the size field decay factor used as the decay when a size field is generated for this entity. The size field will use this decay for entities added to the size field that don’t have a explicitly assigned decay. TypeA float in the range [0.0, 1.0]. DefaultThe default for this attribute is the value of the SizeFieldDecay (Default) default when the grid entity was created. SizeFieldBackgroundSpacing
This attribute is the size background spacing when a size field is generated for this entity. TypeA float in the range [0.0, infinity). DefaultThe default for this attribute is the value in the SizeFieldBackgroundSpacing (Default) default when the grid entity was created. SizeFieldCalculationMethod
This attribute is a string that controls how spacing is calculated for size field point primitives. TypeA string with options < MinimumDistance | InverseDistance | BlendDistance | MinimumValue > DefaultThe default for this attribute is the value in the SizeFieldCalculationMethod (Default) default when the grid entity was created. SizeFieldIgnoreEntityBoundary
This attribute controls whether the boundary of the entity should be ignored when the size field is generated for this entity. TypeThis attribute is a boolean. DefaultThe default for this attribute is false. getGridShape
This action gets the pw::GridShape object that was used to create this grid entity using the <updateGridEntities> action. Parametersnone ReturnsThis action returns a pw::GridShape object if a grid shape was used to create this entity, otherwise it returns an empty string. getPointCount
This action gets the number of grid points in the given entity. Parameters
ReturnsThis action returns the integer number of points. ExampleThis example shows how to find the point count in a domain, as well as the point count that is constrained to database entities. $dom(1) is referencing an existing domain. Code puts [$dom(1) getPointCount -constrained onDB] Output 640 closestCoordinate
This action gets the grid coordinate that is closest to the given point. Parameters
ReturnsThis action returns a grid coordinate on this entity. ExampleThis example shows how to find the closest coordinate on the boundary of a domain to the given point. $dom(1) is referencing an existing domain. Code puts [pw::Application getDescription \ Output dom-18 11 getAutomaticBoundaryCondition
This action gets the boundary condition that will automatically be applied to a register when this entity is added to a higher level entity (an edge register if this is a connector, and a face register if this is a domain). Parametersnone ReturnsThis action returns a pw::BoundaryCondition object. InformationAn error will occur if this is called for anything other than a pw::Connector object in 2D mode and anything other than a pw::Domain object in 3D mode. See Alsopw::BoundaryCondition, register ExampleThis example shows how to get the boundary condition that will be applied when this entity is added to a higher level entity. If a boundary condition is created and applied to an entity, that means that it becomes the default boundary condition for that entity. $dom(1) is referencing an existing domain. Code puts [[$dom(1) getAutomaticBoundaryCondition] getName] Output Unspecified getRegisterBoundaryConditions
This action returns the register boundary conditions for all registers in which this entity is used. Parametersnone ReturnsThis action returns a list of lists, each containing the register and boundary condition, in the form [list register pw::BoundaryCondition]. If the CAE mode is 2D the registers will be connector usage registers, and if the CAE mode is 3D the registers will be domain usage registers. InformationAn error will occur if this is called for anything other than a pw::Connector object in 2D mode and anything other than a pw::Domain object in 3D mode. See Alsoregister, pw::BoundaryCondition ExampleThis example shows how to find the boundary conditions for all registers which include the given entity. $dom(1) is referencing an existing domain. Code set n 1 Output The register blk-2 dom-18 Opposite has an Unspecified boundary getVolumeCondition
This action gets the volume condition of this entity. Parametersnone ReturnsThis action returns a pw::VolumeCondition object. InformationAn error will occur if this is called for anything other than a pw::Domain object in 2D mode and anything other than a pw::Block object in 3D mode. See AlsoExampleThis example shows how to get the volume condition for a block while in 3D mode. $block(1) is referencing an existing block. Code puts [[$block(1) getVolumeCondition] getName] Output Unspecified transform
This action transforms this entity by the given matrix. Parameters
ReturnsThis action returns nothing. See AlsoExampleThis example shows how to rotate grid entities using a transform utility command that sets an anchor point and the new vectors of the X-axis (1 1 0) and Y-axis (1 0 1). $block(1) is referencing an existing block. Code $block(1) transform \ getDatabaseEntities
This action gets all database entities the grid entity is using. Parametersnone ReturnsThis action returns a list of pw::DatabaseEntity objects. See AlsoExampleThis example shows how to get the number of database entities the given grid entity is using. $dom(1) is referencing an existing domain. Code puts [llength [$dom(1) getDatabaseEntities]] Output 2 getExcludedSources
This action gets all source entities that are being explicitly excluded from affecting the grid of this entity Parametersnone ReturnsThis action returns a list of pw::SourceEntity objects. See AlsoexcludeSource
This action explicitly excludes a source from affecting the grid of this entity Parameters
Returnsnothing See AlsogetIncludedSizeFieldEntities
This action gets all entities that are being explicitly included in the size field that affects the grid of this entity. Parameters
ReturnsThis action returns a list of pw::Entity objects or a list of pw::Framework and pw::Entity objects. See Alsopw::SourceEntity, excludeSource, getExcludedSources, includeSizeFieldEntity includeSizeFieldEntity
This action explicitly includes an entity in the size field source that affects the grid of this entity Parameters
Returnsnothing See AlsogetSizeFieldPointCount
This action gets the number of point primitives that will be used when generating the size field that affects this entity. Parametersnone ReturnsThis action returns an integer count of the source points. InfoWhen this value is large (greater than 300,000) the time to apply the size field to the grid entity will increase dramatically. getOutOfSyncWithSources
This action checks if the grid entity is currently out of sync with its sources. This can happen when a source is changed but the grid entity has not been updated since the change occurred. Parametersnone ReturnsThis action returns a boolean value where true indicates that the grid entity is out of sync with its associated sources. See AlsogetOutOfSyncAttributes
This action checks if the grid entity is currently out of sync with its attributes. This can happen when an attribute is changed but the grid entity has not been updated since the change occurred. Parametersnone ReturnsThis action returns a boolean value where true indicates that the grid entity is out of sync with its attributes. See AlsoclearOutOfSync
This action clears the out of sync flags for this grid entity, even though the grid points may be out of sync with it’s sources or attributes. This should only be used when the entity is understood to be out of sync and will be updated at a later time, but it shouldn’t be displayed as out of sync in the list panel. Parametersnone ReturnsThis action returns nothing See AlsocanReExtrude
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:" setOversetObjectVisibility
This action sets the named overset render attribute. Parameters
InformationOverset object visibility will be turned on for the type flag(s) included in the parameter list, and will be turned off for missing type flag(s). If all flags are missing, the visibility of all overset objects will be turned off. An error will occur if this is called for anything other than a pw::Block object in 3D mode. ReturnsThis action returns nothing. ExampleThis example shows how to turn on fringe and orphan objects, implicitly turning off hole and orphan donor candidate objects. Code $blk setOversetObjectVisibility -fringe -orphan getOversetObjectVisibility
This action returns the named overset render attribute. Parameters
InformationAn error will occur if this is called for anything other than a pw::Block object in 3D mode. ReturnsThis action returns a list of boolean indicating the visibility state of fringe, hole, orphan and orphan donor candidate objects for this entity. ExampleThis example shows how to retrieve the overset object visibility states for an entity. Code $blk getOversetObjectVisibility Output {1 0 1 0} |
This action gets a grid entity using the name.
pw::GridEntity getByName ?-path path? name
This action projects grid entities onto database entities.
pw::GridEntity project ?-type proj_type? ?-direction direction? ?-center center? ?-axis point normal? ?-fit tolerance? ?<-interior | -shape>? entities ?dbentities?
This action gets a list of entities adjacent to the given entities.
pw::GridEntity getAdjacentEntities ?-maximumAngle angle? ?-all? entities
This action returns the number of unique points among the specified node, connector, domain and/or block entities (contained in a list of entities) or identified by specifying the entity type.
pw::GridEntity getUniquePointCount <-type type | entities>
This default is the size field decay factor of a grid entity when it is created.
pw::GridEntity get/setDefault SizeFieldDecay decay
This default is the size field background spacing of a grid entity when it is created.
pw::GridEntity get/setDefault SizeFieldBackgroundSpacing spacing
This default is the size field calculation method of a grid entity when it is created.
pw::GridEntity get/setDefault SizeFieldCalculationMethod method
This attribute is a flag that controls whether the influence of sources should be ignored when determining grid point locations.
$entity get/setIgnoreAllSources ignore
This attribute is a flag that controls whether the influence of explicitly included entities should be ignored when determining grid point locations.
$entity get/setIgnoreAllSizeFieldEntities ignore
This attribute is the size field decay factor used as the decay when a size field is generated for this entity.
$entity get/setSizeFieldDecay decay
This attribute is the size background spacing when a size field is generated for this entity.
$entity get/setSizeFieldBackgroundSpacing spacing
This attribute is a string that controls how spacing is calculated for size field point primitives.
$entity get/setSizeFieldCalculationMethod method
This attribute controls whether the boundary of the entity should be ignored when the size field is generated for this entity.
$entity get/setSizeFieldIgnoreEntityBoundary ignore
This action gets the pw::GridShape object that was used to create this grid entity using the updateGridEntities action.
$entity getGridShape
This action gets the number of grid points in the given entity.
$entity getPointCount ?-constrained constrainedVar? ?-owned?
This action gets the grid entity’s usage topology type.
$entity getUsageTopology
This action gets the grid coordinate that is closest to the given point.
$entity closestCoordinate ?-boundary? ?-distance distVar? point ?dir?
This action gets the boundary condition that will automatically be applied to a register when this entity is added to a higher level entity (an edge register if this is a connector, and a face register if this is a domain).
$ent getAutomaticBoundaryCondition
This action returns the register boundary conditions for all registers in which this entity is used.
$ent getRegisterBoundaryConditions
This action gets the volume condition of this entity.
$ent getVolumeCondition
This action transforms this entity by the given matrix.
$entity transform matrix
This action gets all database entities the grid entity is using.
$entity getDatabaseEntities
This action gets all source entities that are being explicitly excluded from affecting the grid of this entity
$entity getExcludedSources
This action explicitly excludes a source from affecting the grid of this entity
$entity excludeSource source ?exclude?
This action gets all entities that are being explicitly included in the size field that affects the grid of this entity.
$entity getIncludedSizeFieldEntities ?-global? ?-recursive?
This action explicitly includes an entity in the size field source that affects the grid of this entity
$entity includeSizeFieldEntity ?-reject rejectVar? entity ?include?
This action explicitly clears all entities in the size field source from affecting the grid of this entity
$entity clearSizeFieldEntities
This action gets the number of point primitives that will be used when generating the size field that affects this entity.
$entity getSizeFieldPointCount
This action checks if the grid entity is currently out of sync with its sources.
$entity getOutOfSyncWithSources
This action checks if the grid entity is currently out of sync with its attributes.
$entity getOutOfSyncAttributes
This action clears the out of sync flags for this grid entity, even though the grid points may be out of sync with it’s sources or attributes.
$entity clearOutOfSync
This action returns true if the entity can be re-extruded.
$entity canReExtrude
This action sets the named overset render attribute.
$entity setOversetObjectVisibility ?-path path? ?-fringe? ?-hole? ?-orphan? ?-orphanDonorCandidates?
This action returns the named overset render attribute.
$entity getOversetObjectVisibility ?-path path?
This action gets the default projection direction for this connector.
$con getDefaultProjectDirection
This action gets the default projection direction for this domain.
$dom getDefaultProjectDirection