RASizeDistribution

class ansys.rocky.app.ra_size_distribution.RASizeDistribution(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

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)

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetCumulativePercentage	Get the value of “Cumulative Percentage”.
SetCumulativePercentage	Set the value of “Cumulative Percentage”.
GetScaleFactor	Get the value of “Scale Factor”.
SetScaleFactor	Set the value of “Scale Factor”.
GetSize	Get the value of “Size”.
SetSize	Set the value of “Size”.

Import detail

from ansys.rocky.app.ra_size_distribution import RASizeDistribution

Method detail

classmethod RASizeDistribution.GetWrappedClass()

classmethod RASizeDistribution.GetClassName()

RASizeDistribution.GetCumulativePercentage() → float

Get the value of “Cumulative Percentage”.

RASizeDistribution.SetCumulativePercentage(value: str | float) → None

Set the value of “Cumulative Percentage”.

Parameters:

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

RASizeDistribution.GetScaleFactor(unit: str | None = None) → float

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

RASizeDistribution.SetScaleFactor(value: str | float, unit: str | None = None) → 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 “-“.

RASizeDistribution.GetSize(unit: str | None = None) → float

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

RASizeDistribution.SetSize(value: str | float, unit: str | None = None) → 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”.