pw::Domain

pw::Domain getAdjacentDomains ?-maximumAngle angle? ?-all? ?-visibleOnly? domains

This action returns a list of domains adjacent to the given domains.

Parameters

Returns

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

Information

If the -all flag is specified, the process is repeated until no more adjacent domains are found.

The return list will not include any domains specified in the argument list.

Example

This example shows how to get all adjacent domains to the given domain and any other domains that are found and then find their total cell count.  $dom(1) is referencing an existing domain.

Code

set doms [pw::Domain getAdjacentDomains -all $dom(1)]
set count [$dom(1) getCellCount]
foreach d $doms {
    set count [expr {[$d getCellCount] + $count}]
}
puts "[expr {[llength $doms] + 1}] domains have $count cells."

Output

22 domains have 10978 cells.

pw::Domain getDomainsFromConnectors connectors

This action returns a list of domains that use the given connectors.

Parameters

Returns

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

Example

This example shows how to get the domains used by a list of given connectors and join as many of them as possible (for unstructured).  $con(1) and $con(2) are referencing existing connectors.

Code

set doms \
    [pw::Domain getDomainsFromConnectors [list $con(1) $con(2)]]
pw::DomainUnstructured join -reject rjDoms $doms
puts "[expr {[llength $doms]-[llength $rjDoms]}] domains of the \
    [llength $doms] found were joined."

Output

3 domains of the 3 found were joined.

pw::Domain setSortOrder domains

This action sets the user specified sort order of domains.

Parameters

Returns

This action returns nothing.

Information

Any domains that are not in the given list, or that are created after calling this command will be placed after these entities in the sort order by the pw::Entity.sort action.

See Also

pw::Entity.sort, pw::Block.setSortOrder

Example

This example shows how to set the sort order of several domains.  If the pw::Entity.sort command is called later after more domains are created, these domains will be sorted first and then the newer placed after them.  $dom(1), $dom(2) and $dom(3) are referencing existing domains.

Code

pw::Domain setSortOrder [list $dom(2) $dom(3) $dom(1)]

pw::Domain getIntersectingCells domains

This action determines the set of intersecting cells among the provided domains.

Parameters

Returns

This action returns a list of lists, where each list contains the cell indices for cells that intersect.  Lists are returned in the order the domains were provided in.

Example

This example looks for cell intersections across all domains.  If intersecting cells are detected, they are marked with a point that is placed at the centroid of the intersecting cell.

Code

set domains [pw::Grid getAll -type pw::Domain]
set cells [pw::Domain getIntersectingCells $domains]
for {set i 0} {$i < [llength $domains]} {incr i} {
  set domain [lindex $domains $i]
  set intersected [lindex $cells $i]
  foreach cell $intersected {
    set point [pw::Point create]
    $point setPoint [$domain getCellCentroid $cell]
  }
}

$dom delete ?-force? ?-connectors?

This action deletes this domain.

Parameters

Returns

This action returns nothing.

See Also

pw::Entity.delete

Example

This example shows how to delete a domain, as well as the blocks it is apart of.  $dom(1) is referencing an existing domain.

Code

$dom(1) delete -force

$dom initialize

This action initializes the interior points of this domain.

Parameters

This action has no parameters.

Returns

This action returns nothing.

Example

This example shows how to initialize a domain.  $dom(1) is referencing an existing domain.

Code

$dom(1) initialize

$dom getDimensions

This action gets the dimensions of this domain.

Parameters

This action has no parameters.

Returns

This action returns the domain dimensions as a two element integer list.  Unstructured domains have a second dimension of 1.

Example

This example shows how to get the dimension of an unstructured domain.  This will return the number of points in the unstructured domain as the first element.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) getDimensions]

Output

262 1

$dom getPoint ?-constrained constrainedVar? index

This action gets the position of a domain grid point.

Parameters

Returns

This action returns a point giving the grid point position (may be in the form “u v dbentity”).

Example

This example shows how to get position of a domain grid point.  The first output is from a domain that is not database constrained; the second is from a domain that is database constrained.  $dom(1) is referencing an existing domain.

Code

puts [pw::Application getDescription [$dom(1) getPoint 35]]

Output

(26.2092,-10.3035,11.6549)
Outer-Surf-3 (1,0.571429)

$dom setPoint index point

This action sets the position of a domain interior grid point.

Parameters

Returns

This action returns nothing.

Example

This example shows how to set an interior grid point on a domain; it checks to see if it is an interior grid point first.  $dom(1) is referencing an existing domain.

Code

if [$dom(1) isInteriorIndex 35] {
    $dom(1) setPoint 35 "26 -5 13"
}

$dom isInteriorIndex index

This action checks to see if an index corresponds to a point in the interior of the domain.

Parameters

Returns

This action returns boolean true if the index is an interior point.

Example

This example shows how to check to see if an index is an interior point.  In this case, it is not.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) isInteriorIndex 35]

Output

0

$dom getAdjacentIndices ?-linear? < index | ij_index >

This action returns the indices that are directly connected to the specified index.

Parameters

Information

Either index or ij_index must be specified.

Returns

This action returns a list of integer 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 ij_index is used and -linear is not specified, the result will be a list of ij indices.

Example

This example shows how to get the adjacent indices on an unstructured domain.  The ij_index for an unstructured domain has a second index of 1.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) getAdjacentIndices {150 1}]

Output

{151 1} {152 1} {182 1} {184 1} {198 1}

$dom getPosition ?-grid? value

This action gets a position in the defining space of the domain.

Parameters

Returns

This action returns a point giving the position on the domain (may be in the form “u v dbentity”).

Example

This example shows how to get the position of a grid point in a domain.  $dom(1) is referencing an existing domain.

Code

puts [pw::Application getDescription \
    [$dom(1) getPosition -grid 100]]

Output

Outer-Surf-3 (0.393111,0.0775636)

$dom getXYZ ?-grid? value

This action gets a position of the domain in model space.

Parameters

Returns

This action returns an XYZ vector.

Example

This example shows how to get the XYZ vector of a grid point in a domain.  $dom(1) references an existing domain.

Code

puts [$dom(1) getXYZ -grid 100]]

Output

0 7.86223 1.55127

$dom getCellCount

This action gets the number of cells in this domain.

Parameters

This action has no parameters.

Returns

This action returns the integer number of cells.

Example

This example shows how to get the number of cells in a domain.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) getCellCount]

Output

466

$dom getCell index

This action gets the indices of the given cell.

Parameters

Returns

This action returns a list of integer point indices.

Example

This example shows how to get the indices for a cell.  The first output is for unstructured and the second is for structured.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) getCell 55]

Output

78 135 136
56 57 87 86

$dom getCellsUsingIndex ?-linear? index

Returns the indices of the cells whose connectivity includes the specified index.

Parameters

Returns

This action returns a list of cell entries using the specified point.  Each cell entry is a list of integer point indices comprising the cell.

$dom getCellAverageEdgeLength index

This action gets the average edge length of the given cell.

Parameters

Returns

This action returns a float.

$dom getCellCentroid index

This action gets the centroid of the given cell.

Parameters

Returns

This action returns an XYZ vector.

$dom getCellArea index

This action gets the area of the given cell.

Parameters

Returns

This action returns a float.

$dom getEdgeCount

This action gets the number of edges in this domain.

Parameters

This action has no parameters.

Returns

This action returns the integer number of edges.

Example

This example shows how to get the number of edges in a domain.  In this case, the domain is structured.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) getEdgeCount]

Output

4

$dom getEdge index

This action gets the edge at the given index.

Parameters

Returns

This action returns a pw::Edge object.

Example

This example shows how to get a edge and then find the connector count of that edge.  In this case, the domain is unstructured, so the single edge has multiple connectors.  $dom(1) is referencing an existing domain.

Code

puts [[$dom(1) getEdge 1] getConnectorCount]

Output

6

$dom getEdges

This action gets the edges of the domain.

Parameters

This action has no parameters.

Returns

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

Example

This example shows how to get the edges and then find the connector count of an edge.  In this case, the domain is unstructured, so an edge can have multiple connectors.  $dom(1) is referencing an existing domain.

Code

puts [[[$dom(1) getEdges 1] lindex 0] getConnectorCount]

Output

6

$dom addEdge edge

This action adds an edge to the domain.

Parameters

Returns

This action returns nothing.

See Also

pw::Edge

Example

This example shows how to add edges to a structured domain.  $edge(1), $edge(2), $edge(3) and $edge(4) are referencing existing edges.

Code

set dom(1) [pw::DomainStructured create]
$dom(1) addEdge $edge(1)
$dom(1) addEdge $edge(2)
$dom(1) addEdge $edge(3)
$dom(1) addEdge $edge(4)

$dom removeLastEdge

This action removes the last edge added to this domain.

Parameters

This action has no parameters.

Returns

This action returns nothing.

Example

This example shows how to remove the last edge added to a structured domain and then add a different edge in its place.  $dom(1) and $edge(5) are referencing an existing domain and edge.

Code

$dom(1) removeLastEdge
$dom(1) addEdge $edge(5)

$dom getDefaultProjectDirection

This action gets the default projection direction for this domain.

Parameters

This action has no parameters.

Returns

This action returns a normalized vector.

Example

This example shows how to get the default projection direction for the given domain.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) getDefaultProjectDirection]

Output

6.948464792806903e-17 0.0 1.0

$dom createPeriodic < -translate vector | -rotate point normal angle >

This action creates a periodic copy of this domain.  This action will fail if the domain is already part of a periodic pair or if any of its connectors are part of a different periodic transformation.

Parameters

Returns

This action returns a new pw::Domain object.  Under certain circumstances (such as the transform resulting in conflicting mappings in the domain’s connectors), the copy will be created but the periodic link will be broken.  Call getPeriodic to verify the periodicity.

Information

One of either -translate or -rotate options must be specified with appropriate arguments.

Example

This example shows how to create a periodic copy of a domain via translation and find the layer it is in.  $dom(1) is referencing an existing domain.

Code

set dom(2) [$dom(1) createPeriodic -translate "5 5 0"]
puts [$dom(2) getLayer]

Output

0

$dom getPeriodic ?-transform matrixVar?

This action gets the domain that shares a periodic link with this domain.

Parameters

Returns

This action returns a pw::Domain object if there is a periodic link, or an empty string if there is no periodic link.

Example

This example shows how to get the domain that has a periodic link with the given domain.  $dom(1) is referencing an existing domain.

Code

puts [[$dom(2) getPeriodic] getName]

Output

dom-1

$dom breakPeriodic

This action breaks the periodic link that this domain has with another domain.  This action has no effect if the domain was not part of a periodic pair.

Parameters

This action has no parameters.

Returns

This action returns nothing.

Example

This example shows how to break a periodic link between domains.  $dom(1) is referencing an existing domain.

Code

$dom(1) breakPeriodic

$dom isValid

This action checks to see if the domain has a valid edge definition.

Parameters

This action has no parameters.

Returns

This action returns a boolean.

Example

This examples shows how to check to see if a domain has a valid edge distribution.  This returns invalid because the structured domain only has 3 edges added to it.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) isValid]

Output

0

$dom isConstrained

This action checks to see if the domain is database constrained.

Parameters

This action has no parameters.

Returns

This action returns a boolean.

Example

This example checks to see if the domain is database constrained.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) isConstrained]

Output

0

$domain getInteriorState

This action gets the interior state of this domain.

Parameters

This action has no parameters.

Returns

This action returns a string interior state with options < Empty | Initialized | Refined >.

Example

This example shows how to get the state of a domain.  $dom(1) is referencing an existing domain.

Code

puts [$dom(1) getInteriorState]

Output

Initialized

$entity getDatabaseEntities

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

Parameters

Returns

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

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