pw::GridEntity

pw::GridEntity getByName ?-path path? name

This action gets a grid entity using the name.

Parameters

Returns

This action returns a pw::GridEntity object.

Example

This 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"]
puts "[$block(1) getName] has [$block(1) getCellCount] cells."

Output

blk-1 has 23440 cells.

pw::GridEntity project ?-type proj_type? ?-direction direction? ?-center center? ?-axis point normal? ?-fit tolerance? ?<-interior | -shape>? entities ?dbentities?

This action projects grid entities onto database entities.

Parameters

Returns

This action returns nothing.

Note

If the entities parameter contains any pw::Domain objects, it is an error to include any pw::Curve objects in the dbentities parameter.

Example

This 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 \
    -axis "0 0 0" "0 0 1" $con(1)

pw::GridEntity getAdjacentEntities ?-maximumAngle angle? ?-all? entities

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

Returns

This action returns a list of adjacent pw::GridEntity objects.

Example

This 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)] {
    puts [$ge getName]
}

Output

blk-2
blk-4

pw::GridEntity getUniquePointCount <-type type | 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.

Parameters

Information

Either -type or entities must be specified.

Returns

This action returns an integer value.

pw::GridEntity get/setDefault SizeFieldDecay decay

This default is the size field decay factor of a grid entity when it is created.

Type

A float in the range [0.0, 1.0].

Default

The default value is 0.85.

pw::GridEntity get/setDefault SizeFieldBackgroundSpacing spacing

This default is the size field background spacing of a grid entity when it is created.

Type

A float in the range [0.0, infinity).

Default

The default value is 0.0.

pw::GridEntity get/setDefault SizeFieldCalculationMethod method

This default is the size field calculation method of a grid entity when it is created.

Type

A string with options < MinimumDistance | InverseDistance | BlendDistance | MinimumValue >

Default

The default for this attribute is MinimumDistance

$entity get/setIgnoreAllSources ignore

This attribute is a flag that controls whether the influence of sources should be ignored when determining grid point locations.

Type

This attribute is a boolean.

Default

The default for this attribute is false.

$entity get/setIgnoreAllSizeFieldEntities ignore

This attribute is a flag that controls whether the influence of explicitly included entities should be ignored when determining grid point locations.

Type

This attribute is a boolean.

Default

The default value of this attribute is false.

$entity get/setSizeFieldDecay decay

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.

Type

A float in the range [0.0, 1.0].

Default

The default for this attribute is the value of the SizeFieldDecay (Default) default when the grid entity was created.

$entity get/setSizeFieldDelayMultiplier delayMultiplier

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.

Type

A float in the range [0.0, 1.0].

Default

The default for this attribute is the value of the <SizeFieldDelayMultiplier (Default)> default when the grid entity was created.

$entity get/setSizeFieldBackgroundSpacing spacing

This attribute is the size background spacing when a size field is generated for this entity.

Type

A float in the range [0.0, infinity).

Default

The default for this attribute is the value in the SizeFieldBackgroundSpacing (Default) default when the grid entity was created.

$entity get/setSizeFieldCalculationMethod method

This attribute is a string that controls how spacing is calculated for size field point primitives.

Type

A string with options < MinimumDistance | InverseDistance | BlendDistance | MinimumValue >

Default

The default for this attribute is the value in the SizeFieldCalculationMethod (Default) default when the grid entity was created.

$entity get/setSizeFieldIgnoreEntityBoundary ignore

This attribute controls whether the boundary of the entity should be ignored when the size field is generated for this entity.

Type

This attribute is a boolean.

Default

The default for this attribute is false.

$entity getGridShape

This action gets the pw::GridShape object that was used to create this grid entity using the <updateGridEntities> action.

Parameters

none

Returns

This action returns a pw::GridShape object if a grid shape was used to create this entity, otherwise it returns an empty string.

$entity getPointCount ?-constrained constrainedVar? ?-owned?

This action gets the number of grid points in the given entity.

Parameters

Returns

This action returns the integer number of points.

Example

This 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]
puts $onDB

Output

640
0

$entity getUsageTopology

This action gets the grid entity’s usage topology type.

Parameters

none

Returns

This action returns one of <Free|Lamina|Manifold|NonManifold>.

Example

Code

puts [llength [$dom getUsageTopology]]
puts [llength [$con getUsageTopology]]

Output

Free
Lamina

$entity closestCoordinate ?-boundary? ?-distance distVar? point ?dir?

This action gets the grid coordinate that is closest to the given point.

Parameters

Returns

This action returns a grid coordinate on this entity.

Example

This 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 \
    [$dom(1) closestCoordinate -boundary "0 0 -5"]]

Output

dom-18 11

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

Parameters

none

Returns

This action returns a pw::BoundaryCondition object.

Information

An 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 Also

pw::BoundaryCondition, register

Example

This 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]
set bc [pw::BoundaryCondition create]
$bc setName Wall
$bc setId 2
$bc setPhysicalType "Wall Viscous"
$bc apply $dom(1)
puts [[$dom(1) getAutomaticBoundaryCondition] getName]

Output

Unspecified
Wall

$ent getRegisterBoundaryConditions

This action returns the register boundary conditions for all registers in which this entity is used.

Parameters

none

Returns

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

Information

An 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 Also

register, pw::BoundaryCondition

Example

This 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
foreach regBCs [$dom(1) getRegisterBoundaryConditions] {
    lassign $regBCs reg($n) bc($n)
    lappend r($n) [[lindex $reg($n) 0] getName]
    lappend r($n) [[lindex $reg($n) 1] getName]
    lappend r($n) [lindex $reg($n) 2]
    lappend b($n) [$bc($n) getName]
    puts "The register $r($n) has an $b($n) boundary condition."
    incr n
}

Output

The register blk-2 dom-18 Opposite has an Unspecified boundary
condition.
The register blk-3 dom-18 Same has an Unspecified boundary
condition.

$ent getVolumeCondition

This action gets the volume condition of this entity.

Parameters

none

Returns

This action returns a pw::VolumeCondition object.

Information

An 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 Also

pw::VolumeCondition

Example

This 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

$entity transform matrix

This action transforms this entity by the given matrix.

Parameters

Returns

This action returns nothing.

See Also

pwu::Transform

Example

This 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 \
    [pwu::Transform rotation -anchor "0 10 5" "1 1 0" "1 0 1"]

$entity getDatabaseEntities

This action gets all database entities the grid entity is using.

Parameters

none

Returns

This action returns a list of pw::DatabaseEntity objects.

See Also

pw::DatabaseEntity

Example

This 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

$entity getExcludedSources

This action gets all source entities that are being explicitly excluded from affecting the grid of this entity

Parameters

none

Returns

This action returns a list of pw::SourceEntity objects.

See Also

pw::SourceEntity

$entity excludeSource source ?exclude?

This action explicitly excludes a source from affecting the grid of this entity

Parameters

Returns

nothing

See Also

pw::SourceEntity

$entity getIncludedSizeFieldEntities ?-global? ?-recursive?

This action gets all entities that are being explicitly included in the size field that affects the grid of this entity.

Parameters

Returns

This action returns a list of pw::Entity objects or a list of pw::Framework and pw::Entity objects.

See Also

pw::SourceEntity, excludeSource, getExcludedSources, includeSizeFieldEntity

$entity includeSizeFieldEntity ?-reject rejectVar? entity ?include?

This action explicitly includes an entity in the size field source that affects the grid of this entity

Parameters

Returns

nothing

See Also

getIncludedSizeFieldEntities, clearSizeFieldEntities

$entity clearSizeFieldEntities

This action explicitly clears all entities in the size field source from affecting the grid of this entity

Parameters

none

Returns

nothing

See Also

includeSizeFieldEntity, getIncludedSizeFieldEntities

$entity getSizeFieldPointCount

This action gets the number of point primitives that will be used when generating the size field that affects this entity.

Parameters

none

Returns

This action returns an integer count of the source points.

Info

When this value is large (greater than 300,000) the time to apply the size field to the grid entity will increase dramatically.

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

Parameters

none

Returns

This action returns a boolean value where true indicates that the grid entity is out of sync with its associated sources.

See Also

clearOutOfSync

$entity getOutOfSyncAttributes

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.

Parameters

none

Returns

This action returns a boolean value where true indicates that the grid entity is out of sync with its attributes.

See Also

clearOutOfSync

$entity clearOutOfSync

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.

Parameters

none

Returns

This action returns nothing

See Also

getOutOfSyncWithSources, getOutOfSyncAttributes

$entity canReExtrude

This action returns true if the entity can be re-extruded.

Parameters

none

Returns

This action returns a boolean value indicating if the entity can be re-extruded.

Example

This example shows how to get a list of all entities that can be re-extruded.

Code

puts "Entities valid for re-extrusion:"
set reExtEnts [list]
foreach ent [pw::Grid getAll] {
  if {[$ent canReExtrude]} {
    lappend reExtEnts $ent
    puts "   [$ent getName]"
  }
}

$entity setOversetObjectVisibility ?-path path? ?-fringe? ?-hole? ?-orphan? ?-orphanDonorCandidates?

This action sets the named overset render attribute.

Parameters

Information

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

Returns

This action returns nothing.

Example

This example shows how to turn on fringe and orphan objects, implicitly turning off hole and orphan donor candidate objects.

Code

$blk setOversetObjectVisibility -fringe -orphan

$entity getOversetObjectVisibility ?-path path?

This action returns the named overset render attribute.

Parameters

Information

An error will occur if this is called for anything other than a pw::Block object in 3D mode.

Returns

This action returns a list of boolean indicating the visibility state of fringe, hole, orphan and orphan donor candidate objects for this entity.

Example

This example shows how to retrieve the overset object visibility states for an entity.

Code

$blk getOversetObjectVisibility

Output

{1 0 1 0}