Base type for all source entities
| pw:: | Base type for all source entities |
| Static Actions | |
| getByName | This action gets a source entity using the name. |
| getBySequence | This action gets a source entity using the sequence number. |
| Static Defaults | |
| BeginDecay | This default is the begin decay of a source when it is created. |
| EndSpacing | This default is the end spacing of a source when it is created. |
| EndDecay | This default is the end decay of a source when it is created. |
| Instance Attributes | |
| SpecificationType | This attribute is the specification type of the entity. |
| BeginSpacing | This attribute is the begin spacing of a source. |
| BeginDecay | This attribute is the begin decay of a source. |
| EndSpacing | This attribute is the end spacing of a source. |
| EndDecay | This attribute is the end decay of a source. |
| TRexConditionType | This attribute is the T-Rex condition type of the source entity. |
| TRexValue | This attribute is the value associated with the T-Rex condition. |
| TRexGrowthRate | This attribute is the growth rate associated with the T-Rex condition. |
| TRexGrowthRateDelay | This attribute is the number of layers to delay applying the growth rate or growth rate profile of T-Rex. |
| Instance Actions | |
| delete | This action deletes this entity. |
| transform | This action transforms this entity by the given matrix. |
| isValidSpecificationType | This action returns whether the given specification type is valid for this entity. |
| getValidSpecificationTypes | This action returns the valid specification types for this entity. |
| getSpecificationXYZs | This action gets the representative xyz locations of specified spacing and decay values for this source |
| isDefined | This action checks if this entity is defined. |
| isOGAAdaptation | This action checks if this entity was generated from overset assembly data. |
| getDescription | This action gets the description of how this entity was defined. |
pw::SourceEntity getByName ?-path path? name
This action gets a source entity using the name.
| name | This parameter is a name string. |
| -path path | This 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. |
This action returns a pw::SourceEntity object.
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.
| number | This parameter is the integer sequence number with the range [1, entity count]. |
This action returns a pw::SourceEntity object.
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.
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 BeginDecay value
This default is the begin decay of a source when it is created.
float; [0.0, 1.0]
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.
float; (0.0, infinity)
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.
float; [0.0, 1.0]
The default value is 0.5.
$entity get/setSpecificationType type
This attribute is the specification type of the entity.
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.
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.
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.
| General | The begin and end values are ignored, with source information supplied through other means. |
| Constant | The begin values will be used throughout the source. |
| Parametric | The 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. |
| AxisToPerimeter | The begin values will be used along the axis and the end values will be used at the perimeter of the source. |
| CenterToPerimeter | The begin values will be used at the center and the end values will be used at the perimeter of the source. |
| PointDensity | The begin values are used, with the begin spacing as a scalar of the point density. The end values are ignored. |
| AlignOnly | The begin and end values are ignored. The source shape is used to align the mesh only. |
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.
float; (0.0, infinity)
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.
float; [0.0, 1.0]
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.
float; (0.0, infinity)
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.
float; [0.0, 1.0]
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.
This attribute is a string with values < Off | Wall | Angle | AspectRatio | MaximumAspectRatio >.
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.
This attribute is a float.
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.
This attribute is a float with the range [1.0, infinity) or 0.0.
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.
This attribute is an integer with the range [0, infinity).
The default for this attribute is 0.
$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.
| matrix | This parameter is the 4x4 transform matrix. |
This action returns nothing.
$entity isValidSpecificationType type
This action returns whether the given specification type is valid for this entity.
| type | This parameter is a string with options < General | Constant | Parametric | AxisToPerimeter | CenterToPerimeter | PointDensity | AlignOnly > |
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.
None
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
none
This action returns a list of xyz vector values.
$entity isDefined
This action checks if this entity is defined.
This action has no parameters.
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.
This action has no parameters.
This action returns a boolean, true if the entity was generated from overset assembly data.
This action gets a source entity using the name.
pw::SourceEntity getByName ?-path path? name
This action gets a source entity using the sequence number.
pw::SourceEntity getBySequence number
This default is the begin decay of a source when it is created.
pw::SourceEntity get/setDefault BeginDecay value
This default is the end spacing of a source when it is created.
pw::SourceEntity get/setDefault EndSpacing value
This default is the end decay of a source when it is created.
pw::SourceEntity get/setDefault EndDecay value
This attribute is the specification type of the entity.
$entity get/setSpecificationType type
This attribute is the begin spacing of a source.
$entity get/setBeginSpacing value
This attribute is the T-Rex condition type of the source entity.
$entity get/setTRexConditionType type
This attribute is the value associated with the T-Rex condition.
$entity get/setTRexValue value
This attribute is the growth rate associated with the T-Rex condition.
$entity get/setTRexGrowthRate rate
This attribute is the number of layers to delay applying the growth rate or growth rate profile of T-Rex.
$entity get/setTRexGrowthRateDelay delay
This action deletes this entity.
$entity delete
This action transforms this entity by the given matrix.
$entity transform matrix
This action returns whether the given specification type is valid for this entity.
$entity isValidSpecificationType type
This action returns the valid specification types for this entity.
$entity getValidSpecificationTypes
This action gets the representative xyz locations of specified spacing and decay values for this source
$entity getSpecificationXYZs
This action checks if this entity is defined.
$entity isDefined
This action checks if this entity was generated from overset assembly data.
$entity isOGAAdaptation
This action gets the description of how this entity was defined.
$entity getDescription
This action gets a list of all source entities.
pw::Source getAll ?< -grid entities | -shape entities >? ?-framework framework? ?-global?