pw:: TRexCondition

pw::TRexCondition create

This action creates a new T-Rex condition object.

Parameters

None

Returns

This action returns a new pw::TRexCondition object.

pw::TRexCondition getByName name

This action gets a T-Rex condition object with the given name.

Parameters

Returns

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.

Parameters

Returns

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

Information

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.

Parameters

None

Returns

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.

Type

This default is a string with values < Off | Wall | Angle | Match | AdjacentGrid | AspectRatio | MaximumAspectRatio >.

Default

The default is Off.

pw::TRexCondition get/setDefault Adaptation type

This default is the adaptation of a T-Rex condition when created.

Type

This default is a string with values < Off | On >.

Default

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.

Type

This attribute is a float with the range [0, infinity).

Default

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.

Type

This attribute is a float with the range [0, 45].

Default

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.

Type

This attribute is a float with the range (0, infinity).

Default

The default for this attribute is 10.0.

$tc get/setName name

This attribute is the name of the T-Rex condition.

Type

This attribute is a string.

Default

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.

Type

This attribute is a string with values < Off | Wall | Angle | Match | AdjacentGrid | AspectRatio | MaximumAspectRatio >.

Default

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.

Type

This attribute is a string with values < Off | On >.

Default

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.

Type

This attribute is a float with the range [1.0, infinity) or 0.0.

Default

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.

Type

This attribute is an integer with the range [0, infinity).

Default

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.

Type

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

Default

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.

Type

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

Default

The default for this attribute is 0.

Information

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.

Type

This attribute is the float initial layer height for a boundary of type Wall with the range (0, infinity).

Default

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.

Type

This attribute is the float minimum distance allowed between points [0, infinity).  A value of 0 disables the constraint.

Default

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.

Type

This attribute is the float minimum radius of curvature allowed [0, infinity).  A value of 0 disables the constraint.

Default

The default for this attribute is 0.

$tc delete

This action deletes this T-Rex condition.

Parameters

None

Returns

This action returns nothing.

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

Parameters

Returns

This action returns nothing.

$bc getRegisters ?-visibility onoff?

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

Parameters

Returns

This action returns a list of registers.

Information

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.

Parameters

Returns

This action returns an integer value.

Information

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.