T-Rex condition type
| pw:: | T-Rex condition type |
| Static Actions | |
| create | This action creates a new T-Rex condition object. |
| getByName | This action gets a T-Rex condition object with the given name. |
| getByEntities | This action returns a list of T-Rex condition objects, one for each input register. |
| getNames | This action gets a list of T-Rex condition names. |
| Static Defaults | |
| ConditionType (Default) | This default is the condition type of a T-Rex condition when created. |
| Adaptation (Default) | This default is the adaptation of a T-Rex condition when created. |
| Static Attributes | |
| AutomaticWallValue | This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall. |
| AutomaticAngleValue | This attribute is the angle to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to Angle. |
| AutomaticAspectRatioValue | This attribute is the aspect ratio to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to AspectRatio or MaximumAspectRatio. |
| Instance Attributes | |
| Name | This attribute is the name of the T-Rex condition. |
| ConditionType | This attribute is the condition type of the T-Rex condition. |
| Adaptation | This attribute is the adaptation type of the T-Rex condition. |
| GrowthRate | This attribute is the growth rate of the T-Rex condition. |
| GrowthRateDelay | This attribute is the number of layers to delay applying the growth rate or growth rate profile of T-Rex. |
| GrowthAngle | This attribute is the growth angle associated with a boundary filter of type Angle. |
| GrowthAspectRatio | This attribute is the aspect ratio associated with a boundary filter. |
| GrowthWallSpacing | This attribute is the growth angle associated with a boundary filter of type Wall. |
| MinimumSubdivisionLength | This attribute is the minimum distance allowed between points modified by the boundary condition. |
| MinimumRadiusOfCurvature | This attribute is the minimum radius of curvature that will be accepted when evaluating curve or surface curvature. |
| Instance Actions | |
| delete | This action deletes this T-Rex condition. |
| apply | This action applies this TRex boundary condition to a set of entities and/or entity registers. |
| 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. |
pw::TRexCondition create
This action creates a new T-Rex condition object.
None
This action returns a new pw::TRexCondition object.
pw::TRexCondition getByName name
This action gets a T-Rex condition object with the given name.
| name | This parameter is the string name of the T-Rex condition to get. |
This action returns a pw::TRexCondition object.
pw::TRexCondition getByEntities register_list
This action returns a list of T-Rex condition objects, one for each input register.
| register_list | This parameter is a list of registers. |
This action retuns a list of pw::TRexCondition objects.
If a given register does not have a T-Rex condition assigned to it, the “Unspecified” T-Rex condition will be returned. However calling the getRegisters action on the “Unspecified” T-Rex condition will only return the register if it is currently part of an active UnstructuredSolver mode.
pw::TRexCondition getNames
This action gets a list of T-Rex condition names.
None
This action returns the T-Rex condition names as a list of strings.
pw::TRexCondition get/setDefault ConditionType type
This default is the condition type of a T-Rex condition when created.
This default is a string with values < Off | Wall | Angle | Match | AdjacentGrid | AspectRatio | MaximumAspectRatio >.
The default is Off.
pw::TRexCondition get/setDefault Adaptation type
This default is the adaptation of a T-Rex condition when created.
This default is a string with values < Off | On >.
The default is Off.
pw::TRexCondition get/setAutomaticWallValue spacing
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.
This attribute is a float with the range [0, infinity).
The default for this attribute is 0.1.
pw::TRexCondition get/setAutomaticAngleValue angle
This attribute is the angle to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to Angle.
This attribute is a float with the range [0, 45].
The default for this attribute is 0.0.
pw::TRexCondition get/setAutomaticAspectRatioValue ratio
This attribute is the aspect ratio to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to AspectRatio or MaximumAspectRatio.
This attribute is a float with the range (0, infinity).
The default for this attribute is 10.0.
$tc get/setName name
This attribute is the name of the T-Rex condition.
This attribute is a string.
The default for this attribute is a uniquely generated name.
$tc get/setConditionType type
This attribute is the condition type of the T-Rex condition.
This attribute is a string with values < Off | Wall | Angle | Match | AdjacentGrid | AspectRatio | MaximumAspectRatio >.
The default for this attribute is the value in the ConditionType default when the T-Rex condition was created.
$tc get/setAdaptation adapt
This attribute is the adaptation type of the T-Rex condition.
This attribute is a string with values < Off | On >.
The default for this attribute is the value in the Adaptation default when the T-Rex condition was created.
$tc get/setGrowthRate rate
This attribute is the growth rate of the T-Rex condition. If the growth rate is set to 0.0, the growth rate specified by the <TRexGrowthRate> and <TRexGrowthProfile> unstructured solver attributes will be used.
This attribute is a float with the range [1.0, infinity) or 0.0.
The default for this attribute is 0.0.
$tc get/setGrowthRateDelay delay
This attribute is the number of layers to delay applying the growth rate or growth rate profile of T-Rex.
This attribute is an integer with the range [0, infinity).
The default for this attribute is 0.
$tc get/setGrowthAngle angle
This attribute is the growth angle associated with a boundary filter of type Angle.
This attribute is the float angle in degrees to use to determine the initial layer height for a boundary of type Angle with the range [0, 90].
The default for this attribute is 0.
$tc get/setGrowthAspectRatio angle
This attribute is the aspect ratio associated with a boundary filter. If the type is AspectRatio or MaximumAspectRatio, this is the value used. For Wall and Angle, this limits the initial layer height so that the maximum aspect ratio is less than the given value.
This attribute is the float maximum aspect ratio allowed when determining the initial step size based on the transverse spacing for types MaximumAspectRatio, Angle, and Wall. It is the target aspect ratio for type AspectRatio. The valid range is 0.0 to disable or [1.0, infinity).
The default for this attribute is 0.
Maximum aspect ratio applies to all filter types, including Angle and Wall, to limit the maximum allowable aspect ratio in the initial growth layer.
$tc get/setGrowthWallSpacing spacing
This attribute is the growth angle associated with a boundary filter of type Wall.
This attribute is the float initial layer height for a boundary of type Wall with the range (0, infinity).
The default for this attribute is 0.
$tc get/setMinimumSubdivisionLength length
This attribute is the minimum distance allowed between points modified by the boundary condition.
This attribute is the float minimum distance allowed between points [0, infinity). A value of 0 disables the constraint.
The default for this attribute is 0.
$tc get/setMinimumRadiusOfCurvature radius
This attribute is the minimum radius of curvature that will be accepted when evaluating curve or surface curvature.
This attribute is the float minimum radius of curvature allowed [0, infinity). A value of 0 disables the constraint.
The default for this attribute is 0.
$tc apply register_or_entity_list
This action applies this TRex 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; and pw::Domain objects or domain usage registers. |
This action returns nothing.
$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 registers.
If this is the “Unspecified” T-Rex condition, the registers that will be returned are only those registers that are currently part of an active UnstructuredSolver mode. If this is called during an active solver mode, it will return only the registers that are active in the solver. This means that is may be an incomplete list of the registers using the boundary condition.
$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.
This returns a count of all registers that use the boundary condition. If this is called while a solver mode is active, it includes both the registers that are active in the solver and registers not active in the solver. Note that the getRegisters function only returns the former and not the latter.
This action creates a new T-Rex condition object.
pw::TRexCondition create
This action gets a T-Rex condition object with the given name.
pw::TRexCondition getByName name
This action returns a list of T-Rex condition objects, one for each input register.
pw::TRexCondition getByEntities register_list
This action gets a list of T-Rex condition names.
pw::TRexCondition getNames
This default is the condition type of a T-Rex condition when created.
pw::TRexCondition get/setDefault ConditionType type
This default is the adaptation of a T-Rex condition when created.
pw::TRexCondition get/setDefault Adaptation type
This attribute is the spacing to automatically apply whenever the type of a T-Rex condition is set to Wall.
pw::TRexCondition get/setAutomaticWallValue spacing
This attribute is the angle to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to Angle.
pw::TRexCondition get/setAutomaticAngleValue angle
This attribute is the aspect ratio to automatically determine the local spacing apply whenever the type of a T-Rex condition is set to AspectRatio or MaximumAspectRatio.
pw::TRexCondition get/setAutomaticAspectRatioValue ratio
This attribute is the name of the T-Rex condition.
$tc get/setName name
This attribute is the condition type of the T-Rex condition.
$tc get/setConditionType type
This attribute is the adaptation type of the T-Rex condition.
$tc get/setAdaptation adapt
This attribute is the growth rate of the T-Rex condition.
$tc get/setGrowthRate rate
This attribute is the number of layers to delay applying the growth rate or growth rate profile of T-Rex.
$tc get/setGrowthRateDelay delay
This attribute is the growth angle associated with a boundary filter of type Angle.
$tc get/setGrowthAngle angle
This attribute is the aspect ratio associated with a boundary filter.
$tc get/setGrowthAspectRatio angle
This attribute is the growth angle associated with a boundary filter of type Wall.
$tc get/setGrowthWallSpacing spacing
This attribute is the minimum distance allowed between points modified by the boundary condition.
$tc get/setMinimumSubdivisionLength length
This attribute is the minimum radius of curvature that will be accepted when evaluating curve or surface curvature.
$tc get/setMinimumRadiusOfCurvature radius
This action deletes this T-Rex condition.
$tc delete
This action applies this TRex boundary condition to a set of entities and/or entity registers.
$tc apply register_or_entity_list
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?