CAE boundary condition type
pw:: | CAE boundary condition type |
Static Actions | |
create | This action creates a new boundary condition object. |
getByName | This action gets a boundary condition object with the given name. |
getByEntities | This action returns a list of boundary conditions, one for each input entity or register. |
getNames | This action gets a list of boundary condition names. |
getPhysicalTypes | This action gets a list of physical type names. |
Instance Attributes | |
Name | This attribute is the name of the boundary condition. |
Id | This attribute is the integer id of the boundary condition. |
PhysicalType | This attribute is the physical type of the boundary condition. |
Instance Actions | |
delete | This action deletes this boundary condition. |
apply | This action applies this boundary condition to a set of entities and/or entity registers. |
getEntities | This action returns the entities that this boundary condition has been applied to. |
getEntityCount | This action returns the number of entities that this boundary condition has been applied to. |
getFreeEntities | This action returns the entities that this boundary condition has been applied to. |
getFreeEntityCount | This action returns the number of free entities that this boundary condition has been applied to. |
getRegisters | This action returns the registers that this boundary condition has been applied to. |
getRegisterCount | This action returns the number of registers that this boundary condition has been applied to. |
getScalarNames | This action gets the boundary condition scalar names. |
getScalarValue | This action gets the value of a boundary condition scalar. |
setScalarValue | This action sets the value of a boundary condition scalar. |
deleteScalar | This action deletes a user-defined boundary condition scalar. |
getCollarBody | This action gets the collar body of a boundary condition (Suggar++ only). |
setCollarBody | This action sets the collar body of a boundary condition (Suggar++ only). |
pw::BoundaryCondition create
This action creates a new boundary condition object.
None
This action returns a new pw::BoundaryCondition object.
pw::BoundaryCondition getByName name
This action gets a boundary condition object with the given name.
name | This parameter is the string name of the boundary condition to get. |
This action returns a pw::BoundaryCondition object.
pw::BoundaryCondition getByEntities register_or_entity_list
This action returns a list of boundary conditions, one for each input entity or register.
register_or_entity_list | This 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. |
This action retuns a list of pw::BoundaryCondition objects.
pw::BoundaryCondition getNames
This action gets a list of boundary condition names.
None
This action returns the boundary condition names as a list of strings.
pw::BoundaryCondition getPhysicalTypes ?-usage type?
This action gets a list of physical type names.
usage | This parameter is used to get the boundary condition physical types for the intended usage < CAE | Overset >. |
This action retuns the physical type names as a list of strings.
$bc get/setName name
This attribute is the name of the boundary condition.
This attribute is a string.
The default for this attribute is a uniquely generated name.
$bc get/setPhysicalType ?-usage type? name
This attribute is the physical type of the boundary condition.
name | This parameter is the string name of the boundary condition. |
usage | This parameter is used to set/get the boundary condition physical type for the intended usage < CAE | Overset >. |
The default name for this attribute is Unspecified. The default usage is CAE.
$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.
register_or_entity_list | This 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. |
This action returns nothing.
(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
$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.
-visibility onoff | This 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. |
This action returns a list of pw::Domain objects when in 3D mode, and a list of pw::Connector objects when in 2D mode.
$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.
-visibility onoff | This 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. |
This action returns an integer value.
$bc getFreeEntities ?-visibility onoff?
This action returns the entities that this boundary condition has been applied to.
-visibility onoff | This 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. |
This action returns a list of pw::Domain objects when in 3D mode, and a list of pw::Connector objects when in 2D mode.
$bc getFreeEntityCount ?-visibility onoff?
This action returns the number of free entities that this boundary condition has been applied to.
-visibility onoff | This 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. |
This action returns an integer value.
$bc getRegisters ?-visibility onoff?
This action returns the registers that this boundary condition has been applied to.
-visibility onoff | This 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. |
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.
$bc getRegisterCount ?-visibility onoff?
This action returns the number of registers that this boundary condition has been applied to.
-visibility onoff | This 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. |
This action returns an integer value.
$bc getScalarNames
This action gets the boundary condition scalar names.
None
This action returns the scalar names as list of strings.
$bc deleteScalar name
This action deletes a user-defined boundary condition scalar.
name | This parameter is the string name of the scalar to delete. |
This action returns nothing.
$bc getCollarBody
This action gets the collar body of a boundary condition (Suggar++ only).
None
This action returns the string name of the collar body
$bc setCollarBody ?bodyName?
This action sets the collar body of a boundary condition (Suggar++ only).
name | This parameter is the string name of a pw::OversetNode object to set as the collar body |
This action returns nothing.
This action creates a new boundary condition object.
pw::BoundaryCondition create
This action gets a boundary condition object with the given name.
pw::BoundaryCondition getByName name
This action returns a list of boundary conditions, one for each input entity or register.
pw::BoundaryCondition getByEntities register_or_entity_list
This action gets a list of boundary condition names.
pw::BoundaryCondition getNames
This action gets a list of physical type names.
pw::BoundaryCondition getPhysicalTypes ?-usage type?
This attribute is the name of the boundary condition.
$bc get/setName name
This attribute is the integer id of the boundary condition.
$bc get/setId bcid
This attribute is the physical type of the boundary condition.
$bc get/setPhysicalType ?-usage type? name
This action deletes this boundary condition.
$bc delete
This action applies this boundary condition to a set of entities and/or entity registers.
$bc apply register_or_entity_list
This action returns the entities that this boundary condition has been applied to.
$bc getEntities ?-visibility onoff?
This action returns the number of entities that this boundary condition has been applied to.
$bc getEntityCount ?-visibility onoff?
This action returns the entities that this boundary condition has been applied to.
$bc getFreeEntities ?-visibility onoff?
This action returns the number of free entities that this boundary condition has been applied to.
$bc getFreeEntityCount ?-visibility onoff?
This action returns the registers that this boundary condition has been applied to.
$bc getRegisters ?-visibility onoff?
This action returns the number of registers that this boundary condition has been applied to.
$bc getRegisterCount ?-visibility onoff?
This action gets the boundary condition scalar names.
$bc getScalarNames
This action gets the value of a boundary condition scalar.
$bc getScalarValue name
This action sets the value of a boundary condition scalar.
$bc setScalarValue name value
This action deletes a user-defined boundary condition scalar.
$bc deleteScalar name
This action gets the collar body of a boundary condition (Suggar++ only).
$bc getCollarBody
This action sets the collar body of a boundary condition (Suggar++ only).
$bc setCollarBody ?bodyName?