pw:: SourceEntity

pw::SourceEntity getByName ?-path path? name

This action gets a source entity using the name.

Parameters

Returns

This action returns a pw::SourceEntity object.

Example

This example shows how to get a source entity named src-1 in order to find the begin spacing of the source

Code

set src(1) [pw::SourceEntity getByName "src-1"]
puts "[$src(1) getName] has begin spacing of [$src(1) getBeginSpacing]."

Output

src-1 has begin spacing of 0.1.

pw::SourceEntity getBySequence number

This action gets a source entity using the sequence number.

Parameters

Returns

This action returns a pw::SourceEntity object.

Notes

This function is extremely inefficient for querying the entire source system.  It is much more efficient to call pw::Source.getAll and simply index into the returned list.

Example

Code

set src [pw::SourceEntity getBySequence 11]
puts "[$src getName] is of the type [$src getType]."

Output

src-1 is of the type pw::SourcePoint.

pw::SourceEntity get/setDefault BeginSpacing value

This default is the begin spacing of a source when it is created.

Type

float; (0.0, infinity)

Default

The default value is 0.1.

pw::SourceEntity get/setDefault BeginDecay value

This default is the begin decay of a source when it is created.

Type

float; [0.0, 1.0]

Default

The default value is 0.5.

pw::SourceEntity get/setDefault EndSpacing value

This default is the end spacing of a source when it is created.

Type

float; (0.0, infinity)

Default

The default value is 0.1.

pw::SourceEntity get/setDefault EndDecay value

This default is the end decay of a source when it is created.

Type

float; [0.0, 1.0]

Default

The default value is 0.5.

$entity get/setSpecificationType type

This attribute is the specification type of the entity.

Type

string with options < General | Constant | Parametric | AxisToPerimeter | CenterToPerimeter | PointDensity | AlignOnly >.  Not all options are valid for all entities and setting this attribute to an invalid setting for these entities will have no effect.

Default

The default specification type differs depending on the type of source, but usually it is Parametric.  If that is not a valid type for the entity, then the default will be Constant.

Note

The current value of this attribute controls how the BeginSpacing, BeginDecay, EndSpacing and EndDecay attributes are used to control the size field produced by the source.

See Also

Use isValidSpecificationType to check if a specification type is valid for an entity.

$entity get/setBeginSpacing value

This attribute is the begin spacing of a source.

Type

float; (0.0, infinity)

Default

The default for this attribute is the value in the BeginSpacing default when the source was created.

$entity get/setBeginDecay value

This attribute is the begin decay of a source.

Type

float; [0.0, 1.0]

Default

The default for this attribute is the value in the BeginDecay default when the source was created.

$entity get/setEndSpacing value

This attribute is the end spacing of a source.

Type

float; (0.0, infinity)

Default

The default for this attribute is the value in the EndSpacing default when the source was created.

$entity get/setEndDecay value

This attribute is the end decay of a source.

Type

float; [0.0, 1.0]

Default

The default for this attribute is the value in the EndDecay default when the source was created.

$entity get/setTRexConditionType type

This attribute is the T-Rex condition type of the source entity.

Type

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

Default

The default for this attribute is Off.

$entity get/setTRexValue value

This attribute is the value associated with the T-Rex condition.  If the condition type is Wall, the value is the spacing.  If the condition type is Angle, the value is the angle.  If the condition type is AspectRatio or MaximumAspectRatio, the value is the aspect ratio.

Type

This attribute is a float.

Default

The default for this attribute is 0.0.

$entity get/setTRexGrowthRate rate

This attribute is the growth rate associated with 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.

$entity get/setTRexGrowthRateDelay 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.

$entity delete

This action deletes this entity.

Returns

This action returns nothing.

$entity transform matrix

This action transforms this entity by the given matrix.  The matrix is a list of 16 values, but in practice, the utility functions for transform matrices are generally used instead.

Parameters

Returns

This action returns nothing.

See Also

pwu::Transform

$entity isValidSpecificationType type

This action returns whether the given specification type is valid for this entity.

Parameters

Returns

This action returns a boolean, which is True if the specification type is supported.

$entity getValidSpecificationTypes

This action returns the valid specification types for this entity.

Parameters

None

Returns

This action returns a list of strings, where the strings will be from among the list of General, Constant, Parametric, AxisToPerimeter CenterToPerimeter, PointDensity, AlignOnly.

$entity getSpecificationXYZs

This action gets the representative xyz locations of specified spacing and decay values for this source

Parameters

none

Returns

This action returns a list of xyz vector values.

$entity isDefined

This action checks if this entity is defined.

Parameters

This action has no parameters.

Returns

This action returns a boolean, true if the entity is defined.

$entity isOGAAdaptation

This action checks if this entity was generated from overset assembly data.

Parameters

This action has no parameters.

Returns

This action returns a boolean, true if the entity was generated from overset assembly data.

$entity getDescription

This action gets the description of how this entity was defined.

Parameters

This action has no parameters.

Returns

This action returns a string description.

Information

All possible string returns: Point, Unknown.