pw::SourceEntity

Base type for all source entities

Derives From

pw::Object pw::Entity

Summary
pw::SourceEntityBase type for all source entities
Static Actions
getByNameThis action gets a source entity using the name.
getBySequenceThis action gets a source entity using the sequence number.
Static Defaults
BeginSpacing (Default)This default is the begin spacing of a source when it is created.
BeginDecay (Default)This default is the begin decay of a source when it is created.
EndSpacing (Default)This default is the end spacing of a source when it is created.
EndDecay (Default)This default is the end decay of a source when it is created.
Instance Attributes
SpecificationTypeThis attribute is the specification type of the entity.
BeginSpacingThis attribute is the begin spacing of a source.
BeginDecayThis attribute is the begin decay of a source.
EndSpacingThis attribute is the end spacing of a source.
EndDecayThis attribute is the end decay of a source.
TRexConditionTypeThis attribute is the T-Rex condition type of the source entity.
TRexValueThis attribute is the value associated with the T-Rex condition.
TRexGrowthRateThis attribute is the growth rate associated with the T-Rex condition.
TRexGrowthRateDelayThis attribute is the number of layers to delay applying the growth rate or growth rate profile of T-Rex.
Instance Actions
deleteThis action deletes this entity.
transformThis action transforms this entity by the given matrix.
isValidSpecificationTypeThis action returns whether the given specification type is valid for this entity.
getValidSpecificationTypesThis action returns the valid specification types for this entity.
getSpecificationXYZsThis action gets the representative xyz locations of specified spacing and decay values for this source
isDefinedThis action checks if this entity is defined.
isOGAAdaptationThis action checks if this entity was generated from overset assembly data.
getDescriptionThis action gets the description of how this entity was defined.

Static Actions

getByName

pw::SourceEntity getByName ?-path path? name

This action gets a source entity using the name.

Parameters

nameThis parameter is a name string.
-path pathThis parameter and its argument specify the path to the framework in which the source entity resides.  The path argument must be a list of either pw::Framework objects or framework names.  The path must start at the root framework, start at the active framework, or start at a child of the active framework.  The active framework is used as the default if this parameter is not specified.

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.

getBySequence

pw::SourceEntity getBySequence number

This action gets a source entity using the sequence number.

Parameters

numberThis parameter is the integer sequence number with the range [1, entity count].

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.

Static Defaults

BeginSpacing (Default)

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.

BeginDecay (Default)

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.

EndSpacing (Default)

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.

EndDecay (Default)

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.

Instance Attributes

SpecificationType

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

GeneralThe begin and end values are ignored, with source information supplied through other means.
ConstantThe begin values will be used throughout the source.
ParametricThe begin values will be used at the minimum parametric limits and the end values will be used at the maximum parametric limits of the source.
AxisToPerimeterThe begin values will be used along the axis and the end values will be used at the perimeter of the source.
CenterToPerimeterThe begin values will be used at the center and the end values will be used at the perimeter of the source.
PointDensityThe begin values are used, with the begin spacing as a scalar of the point density.  The end values are ignored.
AlignOnlyThe begin and end values are ignored.  The source shape is used to align the mesh only.

See Also

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

BeginSpacing

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

BeginDecay

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

EndSpacing

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

EndDecay

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

TRexConditionType

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

TRexValue

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

TRexGrowthRate

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

TRexGrowthRateDelay

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

Instance Actions

delete

$entity delete

This action deletes this entity.

Returns

This action returns nothing.

transform

$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

matrixThis parameter is the 4x4 transform matrix.

Returns

This action returns nothing.

See Also

pwu::Transform

isValidSpecificationType

$entity isValidSpecificationType type

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

Parameters

typeThis parameter is a string with options < General | Constant | Parametric | AxisToPerimeter | CenterToPerimeter | PointDensity | AlignOnly >

Returns

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

getValidSpecificationTypes

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

getSpecificationXYZs

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

isDefined

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

isOGAAdaptation

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

getDescription

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

pw::SourceEntity getByName ?-path path? name
This action gets a source entity using the name.
pw::SourceEntity getBySequence number
This action gets a source entity using the sequence number.
pw::SourceEntity get/setDefault BeginSpacing value
This default is the begin spacing of a source when it is created.
pw::SourceEntity get/setDefault BeginDecay value
This default is the begin decay of a source when it is created.
pw::SourceEntity get/setDefault EndSpacing value
This default is the end spacing of a source when it is created.
pw::SourceEntity get/setDefault EndDecay value
This default is the end decay of a source when it is created.
$entity get/setSpecificationType type
This attribute is the specification type of the entity.
$entity get/setBeginSpacing value
This attribute is the begin spacing of a source.
$entity get/setBeginDecay value
This attribute is the begin decay of a source.
$entity get/setEndSpacing value
This attribute is the end spacing of a source.
$entity get/setEndDecay value
This attribute is the end decay of a source.
$entity get/setTRexConditionType type
This attribute is the T-Rex condition type of the source entity.
$entity get/setTRexValue value
This attribute is the value associated with the T-Rex condition.
$entity get/setTRexGrowthRate rate
This attribute is the growth rate associated with the T-Rex condition.
$entity get/setTRexGrowthRateDelay delay
This attribute is the number of layers to delay applying the growth rate or growth rate profile of T-Rex.
$entity delete
This action deletes this entity.
$entity transform matrix
This action transforms this entity by the given matrix.
$entity isValidSpecificationType type
This action returns whether the given specification type is valid for this entity.
$entity getValidSpecificationTypes
This action returns the valid specification types for this entity.
$entity getSpecificationXYZs
This action gets the representative xyz locations of specified spacing and decay values for this source
$entity isDefined
This action checks if this entity is defined.
$entity isOGAAdaptation
This action checks if this entity was generated from overset assembly data.
$entity getDescription
This action gets the description of how this entity was defined.
Base type for all glyph types
Entity type
A string is an array of characters.
Framework type
Base type for all source entities
An integer is a whole number.
pw::Source getAll ?< -grid entities | -shape entities >? ?-framework framework? ?-global?
This action gets a list of all source entities.
A float is a fractional number.
Utility functions for transform matrices, which are represented as a list of sixteen real values.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
A vector is a list of float values.
Close