pw:: BoundaryCondition

CAE boundary condition type

Derives From

pw::Object

Summary
CAE boundary condition type
This action creates a new boundary condition object.
This action gets a boundary condition object with the given name.
This action returns a list of boundary conditions, one for each input entity or register.
This action gets a list of boundary condition names.
This action gets a list of physical type names.
This attribute is the name of the boundary condition.
This attribute is the integer id of the boundary condition.
This attribute is the physical type of the boundary condition.
This action deletes this boundary condition.
This action applies this boundary condition to a set of entities and/or entity registers.
This action returns the entities that this boundary condition has been applied to.
This action returns the number of entities that this boundary condition has been applied to.
This action returns the entities that this boundary condition has been applied to.
This action returns the number of free entities that this boundary condition has been applied to.
This action returns the registers that this boundary condition has been applied to.
This action returns the number of registers that this boundary condition has been applied to.
This action gets the boundary condition scalar names.
This action gets the value of a boundary condition scalar.
This action sets the value of a boundary condition scalar.
This action deletes a user-defined boundary condition scalar.
This action gets the collar body of a boundary condition (Suggar++ only).
This action sets the collar body of a boundary condition (Suggar++ only).

Static Actions

create

pw::BoundaryCondition create

This action creates a new boundary condition object.

Parameters

None

Returns

This action returns a new pw::BoundaryCondition object.

getByName

pw::BoundaryCondition getByName name

This action gets a boundary condition object with the given name.

Parameters

nameThis parameter is the string name of the boundary condition to get.

Returns

This action returns a pw::BoundaryCondition object.

getByEntities

pw::BoundaryCondition getByEntities register_or_entity_list

This action returns a list of boundary conditions, one for each input entity or register.

Parameters

register_or_entity_listThis parameter is a list of pw::Connector objects or connector usage registers in 2D CAE mode; and pw::Domain objects or domain usage registers in 3D CAE mode.

Returns

This action retuns a list of pw::BoundaryCondition objects.

getNames

pw::BoundaryCondition getNames

This action gets a list of boundary condition names.

Parameters

None

Returns

This action returns the boundary condition names as a list of strings.

getPhysicalTypes

pw::BoundaryCondition getPhysicalTypes ?-usage type?

This action gets a list of physical type names.

Parameters

usageThis parameter is used to get the boundary condition physical types for the intended usage < CAE | Overset >.

Returns

This action retuns the physical type names as a list of strings.

Instance Attributes

Name

$bc get/setName name

This attribute is the name of the boundary condition.

Type

This attribute is a string.

Default

The default for this attribute is a uniquely generated name.

Id

$bc get/setId bcid

This attribute is the integer id of the boundary condition.

Type

This attribute is an integer.

Default

The default for this attribute is the next available integer.

PhysicalType

$bc get/setPhysicalType ?-usage type? name

This attribute is the physical type of the boundary condition.

Type

nameThis parameter is the string name of the boundary condition.
usageThis parameter is used to set/get the boundary condition physical type for the intended usage < CAE | Overset >.

Default

The default name for this attribute is Unspecified.  The default usage is CAE.

Instance Actions

delete

$bc delete

This action deletes this boundary condition.

Parameters

None

Returns

This action returns nothing.

apply

$bc apply register_or_entity_list

This action applies this boundary condition to a set of entities and/or entity registers.  If an entity is specified, the default boundary condition for that entity is set, but no registers that use that entity are affected.  The default boundary condition for an entity is applied when the entity is used in a new higher-level entity.

When applying boundary conditions to an entity, this action only sets the “default” condition for that entity.  The “default” condition is applied to all subsequent uses (registers) of that entity.  In comparison, when a boundary condition is applied to a register, this action sets the condition for both the register and changes the “default” condition for the entity.

Parameters

register_or_entity_listThis parameter is a list of pw::Connector objects or connector usage registers in 2D CAE mode; and pw::Domain objects or domain usage registers in 3D CAE mode.

Returns

This action returns nothing.

Example

(Assumes $domain(1) is a domain used in a face of $block and $domain(2) is a free domain.)

Code

# create the boundary conditions
set bc(1) [pw::BoundaryCondition create]
set bc(2) [pw::BoundaryCondition create]

# set the default BC for both domains
$bc(1) apply $domain(1) $domain(2)

# this will change the default BC for $domain(1)
$bc(2) apply [list $block $domain(1)]

puts "$bc(1) Entities: [$bc(1) getEntityCount]"
puts "$bc(2) Entities: [$bc(2) getEntityCount]"
puts "$bc(1) Free Entities: [$bc(1) getFreeEntityCount]"
puts "$bc(2) Free Entities: [$bc(2) getFreeEntityCount]"
puts "$bc(1) Register Entities: [$bc(1) getRegisterCount]"
puts "$bc(2) Register Entities: [$bc(2) getRegisterCount]"

Output

::pw::BoundaryCondition_1 Entities: 1
::pw::BoundaryCondition_2 Entities: 1
::pw::BoundaryCondition_1 Free Entities: 1
::pw::BoundaryCondition_2 Free Entities: 0
::pw::BoundaryCondition_1 Register Entities: 0
::pw::BoundaryCondition_2 Register Entities: 1

getEntities

$bc getEntities ?-visibility onoff?

This action returns the entities that this boundary condition has been applied to.  The list will contain both free entities whose default boundary condition is this, and entities used in higher-level entities whose register boundary condition is this.

Parameters

-visibility onoffThis optional flag controls whether or not the entity list is filtered by the entities’ visibility attributes.  If onoff is true, only visible entities are returned.  If onoff is false, only hidden entities are returned.

Returns

This action returns a list of pw::Domain objects when in 3D mode, and a list of pw::Connector objects when in 2D mode.

getEntityCount

$bc getEntityCount ?-visibility onoff?

This action returns the number of entities that this boundary condition has been applied to.  The count will include both free entities whose default boundary condition is this, and entities used in higher-level entities whose register boundary condition is this.

Parameters

-visibility onoffThis optional flag controls whether or not the entity count is filtered by the entities’ visibility attributes.  If onoff is true, only visible entities are counted.  If onoff is false, only hidden entities are counted.

Returns

This action returns an integer value.

getFreeEntities

$bc getFreeEntities ?-visibility onoff?

This action returns the entities that this boundary condition has been applied to.

Parameters

-visibility onoffThis optional flag controls whether or not the entity list is filtered by the entities’ visibility attributes.  If onoff is true, only visible entities are returned.  If onoff is false, only hidden entities are returned.

Returns

This action returns a list of pw::Domain objects when in 3D mode, and a list of pw::Connector objects when in 2D mode.

getFreeEntityCount

$bc getFreeEntityCount ?-visibility onoff?

This action returns the number of free entities that this boundary condition has been applied to.

Parameters

-visibility onoffThis optional flag controls whether or not the entity count is filtered by the entities’ visibility attributes.  If onoff is true, only visible entities are counted.  If onoff is false, only hidden entities are counted.

Returns

This action returns an integer value.

getRegisters

$bc getRegisters ?-visibility onoff?

This action returns the registers that this boundary condition has been applied to.

Parameters

-visibility onoffThis optional flag controls whether or not the register list is filtered by the entities’ visibility attributes.  If onoff is true, only registers with visible entities are returned.  If onoff is false, only registers with hidden entities are returned.

Returns

This action returns a list of domain usage registers when in 3D CAE mode, and a list of connector usage registers when in 2D CAE mode.

getRegisterCount

$bc getRegisterCount ?-visibility onoff?

This action returns the number of registers that this boundary condition has been applied to.

Parameters

-visibility onoffThis optional flag controls whether or not the register count is filtered by the visibility of the register entities.  If onoff is true, only the count of registers with visible entities are counted.  If onoff is false, only registers with hidden entities are counted.

Returns

This action returns an integer value.

getScalarNames

$bc getScalarNames

This action gets the boundary condition scalar names.

Parameters

None

Returns

This action returns the scalar names as list of strings.

getScalarValue

$bc getScalarValue name

This action gets the value of a boundary condition scalar.

Parameters

nameThis parameter is the string name of the scalar to get the value of.

Returns

This action returns the string value of the scalar.

setScalarValue

$bc setScalarValue name value

This action sets the value of a boundary condition scalar.

Parameters

nameThis parameter is the string name of the scalar to set the value of.
valueThis parameter is the new scalar value as a string.

Returns

This action returns nothing.

deleteScalar

$bc deleteScalar name

This action deletes a user-defined boundary condition scalar.

Parameters

nameThis parameter is the string name of the scalar to delete.

Returns

This action returns nothing.

getCollarBody

$bc getCollarBody

This action gets the collar body of a boundary condition (Suggar++ only).

Parameters

None

Returns

This action returns the string name of the collar body

setCollarBody

$bc setCollarBody ?bodyName?

This action sets the collar body of a boundary condition (Suggar++ only).

Parameters

nameThis parameter is the string name of a pw::OversetNode object to set as the collar body

Returns

This action returns nothing.

pw::BoundaryCondition create
This action creates a new boundary condition object.
pw::BoundaryCondition getByName name
This action gets a boundary condition object with the given name.
pw::BoundaryCondition getByEntities register_or_entity_list
This action returns a list of boundary conditions, one for each input entity or register.
A register is the usage of a lower level entity in a higher level entity.
pw::BoundaryCondition getNames
This action gets a list of boundary condition names.
pw::BoundaryCondition getPhysicalTypes ?-usage type?
This action gets a list of physical type names.
$bc get/setName name
This attribute is the name of the boundary condition.
$bc get/setId bcid
This attribute is the integer id of the boundary condition.
$bc get/setPhysicalType ?-usage type? name
This attribute is the physical type of the boundary condition.
$bc delete
This action deletes this boundary condition.
$bc apply register_or_entity_list
This action applies this boundary condition to a set of entities and/or entity registers.
$bc getEntities ?-visibility onoff?
This action returns the entities that this boundary condition has been applied to.
$bc getEntityCount ?-visibility onoff?
This action returns the number of entities that this boundary condition has been applied to.
$bc getFreeEntities ?-visibility onoff?
This action returns the entities that this boundary condition has been applied to.
$bc getFreeEntityCount ?-visibility onoff?
This action returns the number of free entities that this boundary condition has been applied to.
$bc getRegisters ?-visibility onoff?
This action returns the registers that this boundary condition has been applied to.
$bc getRegisterCount ?-visibility onoff?
This action returns the number of registers that this boundary condition has been applied to.
$bc getScalarNames
This action gets the boundary condition scalar names.
$bc getScalarValue name
This action gets the value of a boundary condition scalar.
$bc setScalarValue name value
This action sets the value of a boundary condition scalar.
$bc deleteScalar name
This action deletes a user-defined boundary condition scalar.
$bc getCollarBody
This action gets the collar body of a boundary condition (Suggar++ only).
$bc setCollarBody ?bodyName?
This action sets the collar body of a boundary condition (Suggar++ only).
Base type for all glyph types
CAE boundary condition type
A string is an array of characters.
Connector type
Domain type
An integer is a whole number.
OGA Define