RASizeDistribution

class RASizeDistribution

Rocky PrePost Scripting wrapper for a single entry in a single Particle’s size distribution list.

Access this wrapper from a given RAParticle with:

size_distribution_list = particle.GetSizeDistributionList()
distribution_1 = size_distribution_list.New()
distribution_1.SetSize(1.0, 'm')
distribution_1.SetCumulativePercentage(100)

Methods:

GetCumulativePercentage()

Get the value of “Cumulative Percentage”.

GetScaleFactor(unit: Optional[str] = None)

Get the value of “Scale Factor”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “-“.

GetSize(unit: Optional[str] = None)

Get the value of “Size”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

SetCumulativePercentage(value: Union[str, float])

Set the value of “Cumulative Percentage”.

• Parameters: value – The value to set. This value can be an expression with input variables or float type.

SetScaleFactor(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Scale Factor”.

• Parameters:
  • value – The value to set. This value can be an expression with input variables or float type.
  • unit – The unit for value. If no unit is provided, value is assumed to be in “-“.

SetSize(value: Union[str, float], unit: Optional[str] = None)

Set the value of “Size”.

• Parameters:
  • value – The value to set. This value can be an expression with input variables or float type.
  • unit – The unit for value. If no unit is provided, value is assumed to be in “m”.