pw:: DistributionGrowth

pw::DistributionGrowth create

This action creates a new shape distribution function object.

Parameters

This action has no parameters.

Returns

This action returns a new pw::DistributionGrowth object.

$dist get/setBeginMode mode

This attribute is the mode that is used in calculating the layer growth at the start of the distribution.

Type

This attribute is a string with options < LayersAndRate | HeightAndRate | LayersAndHeight >.

Default

The default for this attribute is LayersAndRate

Information

Depending on the mode, one of the other begin attributes will be ignored when the distribution is calculated: BeginHeight when mode is LayersAndRate, BeginLayers when mode is HeightAndRate, and BeginRate when mode is LayersAndHeight.

$dist get/setBeginHeight height

This attribute is the requested total height of layers at the start of the distribution.

Type

This attribute is a float with the range [0, infinity) where 0 means there should be no layers at the start of the distribution.

Default

The default for this attribute is 0.

$dist get/setBeginLayers layers

This attribute is the requested number of layers at the start of the distribution.

Type

This attribute is an integer with the range [0, infinity) where 0 means there should be no layers at the start of the distribution.

Default

The default for this attribute is 0.

$dist get/setBeginRate rate

This attribute is the growth rate of layers at the start of the distribution.

Type

This attribute is a float with the range [0, infinity) where 0 means there should be no layers at the start of the distribution.

Default

The default for this attribute is 0.

$dist get/setBeginRateDelay delay

This attribute is the number of layers to delay the growth rate at the start of the distribution.

Type

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

Default

The default for this attribute is 0.

$dist get/setBeginRateProfile profile

This attribute is the growth rate profile of layers at the start of the distribution.

Type

This attribute is a list of float indicating the growth rate to apply to each spacing to compute the next spacing.  Each float in the list must be greater than zero.  If this attribute is specified as a non-empty list, the BeginRate attribute is ignored.  If the length of this list is less than the prescribed number of BeginLayers, the last element is used as the growth rate for all subsequent spacings.

Default

The default for this attribute is an empty list, indicating that BeginRate be used for all spacing calculations.

$dist get/setEndMode mode

This attribute is the mode that is used in calculating the layer growth at the end of the distribution.

Type

This attribute is a string with options < LayersAndRate | HeightAndRate | LayersAndHeight >.

Default

The default for this attribute is LayersAndRate

Information

Depending on the mode, one of the other end attributes will be ignored when the distribution is calculated: EndHeight when mode is LayersAndRate, EndLayers when mode is HeightAndRate, and EndRate when mode is LayersAndHeight.

$dist get/setEndHeight height

This attribute is the requested total height of layers at the end of the distribution.

Type

This attribute is a float with the range [0, infinity) where 0 means there should be no layers at the start of the distribution.

Default

The default for this attribute is 0.

$dist get/setEndLayers layers

This attribute is the requested number of layers at the end of the distribution.

Type

This attribute is an integer with the range [0, infinity) where 0 means there should be no layers at the end of the distribution.

Default

The default for this attribute is 0.

$dist get/setEndRate rate

This attribute is the growth rate of layers at the end of the distribution.

Type

This attribute is a float with the range [0, infinity) where 0 means there should be no layers at the end of the distribution.

Default

The default for this attribute is 0.

$dist get/setEndRateDelay delay

This attribute is the number of layers to delay the growth rate at the end of the distribution.

Type

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

Default

The default for this attribute is 0.

$dist get/setEndRateProfile profile

This attribute is the growth rate profile of layers at the start of the distribution.

Type

This attribute is a list of float indicating the growth rate to apply to each spacing to compute the next spacing.  Each float in the list must be greater than zero.  If this attribute is specified as a non-empty list, the EndRate attribute is ignored.  If the length of this list is less than the prescribed number of EndLayers, the last element is used as the growth rate for all subsequent spacings.

Default

The default for this attribute is an empty list, indicating that EndRate be used for all spacing calculations.

$dist get/setMiddleMode mode

This attribute is the requested behavior when transitioning from the beginning or ending section of the distribution to the middle of the distribution.

Type

This attribute is a string with options < SwitchToTanh | ContinueGrowth >.

Default

The default for this attribute is SwitchToTanh

Information

The mode SwitchToTanh will immediately change the distribution from Growth to Tanh when the requested number of layers are met, and the MiddleSpacing parameter represents the spacing to use on both sides of this Tanh section.  If MiddleSpacing is 0, the last layer spacing will be used for both sides of the Tanh section.  The mode ContinueGrowth will keep the growth distribution until the spacing is greater than the MiddleSpacing parameter at which time the distribution will change to Tanh.

$dist get/setMiddleSpacing spacing

This attribute is the requested spacing when transitioning from the beginning or ending section of the distribution to the middle of the distribution.

Type

This attribute is a float with the range [0, infinity) where 0 means that the middle spacing should be equal to the height of the last layer of the beginning or ending section of the distribution.

Default

The default for this attribute is 0.

Note

The spacing for the middle of the connector is clamped to 3x the last growth layer of the distribution in order to create a smooth transition between the growth layers and the middle of the distribution