Rocky PrePost scripting 2025 R1

RAVolumetricInlet

Last update: 17.07.2025

class RAVolumetricInlet

Rocky PrePost Scripting wrapper for a single Volume Fill input.

This wrapper class corresponds to an individual entry under the “Inputs” item on the project’s data tree. Particle inputs can be retrieved from the RAStudy or the RAInletsOutletsCollection via:

input_1 = study.GetElement('Volume Fill 1>')
input_2 = input_collection.GetParticleInput('Volume Fill 2>')

Instances of RAVolumetricInlet comprise two parts: Properties that can be manipulated directly, such as the input’s name and the seed point, and the input properties list that describe which particles enter via this input and with its mass, temperature, etc. This list must be manipulated via the RAParticleInputPropertiesList returned by GetInputPropertiesList().

Methods:

Name Description
DisablePeriodic() Set the value of "Periodic" to False.
EnablePeriodic() Set the value of "Periodic" to True.
GetAvailableGeometries() Get all available Geometries.
GetBoxCenter([unit]) Get the value of "Box Center".
GetBoxDimensions([unit]) Get the value of "Box Dimensions".
GetGapScaleFactor() Get the value of "Gap Scale Factor".
GetGeometries() Get the "Geometries".
GetInitialVelocity([unit]) Get the value of "Initial Velocity".
GetInjectionTime([unit]) Get the value of "Injection Time".
GetInputPropertiesList() Return a list of input properties
GetPeriod([unit]) Get the value of "Period".
GetPeriodic() Get the value of "Periodic".
GetSeedCoordinates([unit]) Get the value of "Seed Coordinates".
GetSphMass([unit]) Get the value of "Sph Mass".
GetSphTemperature([unit]) Get the value of "Sph Temperature".
GetStopTime([unit]) Get the value of "Stop Time".
GetUseGeometriesToCompute() Get the value of "Use Geometries To Compute".
IsPeriodicEnabled() Check if the "Periodic" is enabled.
SetBoxCenter(values[, unit]) Set the values of "Box Center".
SetBoxDimensions(values[, unit]) Set the values of "Box Dimensions".
SetGapScaleFactor(value) Set the value of "Gap Scale Factor".
SetGeometries(values) Set the "Geometries".
SetInitialVelocity(values[, unit]) Set the values of "Initial Velocity".
SetInjectionTime(value[, unit]) Set the value of "Injection Time".
SetPeriod(value[, unit]) Set the value of "Period".
SetPeriodic(value) Set the value of "Periodic".
SetSeedCoordinates(values[, unit]) Set the values of "Seed Coordinates".
SetSphMass(value[, unit]) Set the value of "Sph Mass".
SetSphTemperature(value[, unit]) Set the value of "Sph Temperature".
SetStopTime(value[, unit]) Set the value of "Stop Time".
SetUseGeometriesToCompute(value) Set the value of "Use Geometries To Compute".

DisablePeriodic()

Set the value of “Periodic” to False.

EnablePeriodic()

Set the value of “Periodic” to True.

GetAvailableGeometries()

Get all available Geometries.

GetBoxCenter(unit: Optional[str] = None)

Get the value of “Box Center”.

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

GetBoxDimensions(unit: Optional[str] = None)

Get the value of “Box Dimensions”.

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

GetGapScaleFactor()

Get the value of “Gap Scale Factor”.

GetGeometries()

Get the “Geometries”.

GetInitialVelocity(unit: Optional[str] = None)

Get the value of “Initial Velocity”.

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

GetInjectionTime(unit: Optional[str] = None)

Get the value of “Injection Time”.

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

GetInputPropertiesList()

Return a list of input properties

GetPeriod(unit: Optional[str] = None)

Get the value of “Period”.

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

GetPeriodic()

Get the value of “Periodic”.

GetSeedCoordinates(unit: Optional[str] = None)

Get the value of “Seed Coordinates”.

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

GetSphMass(unit: Optional[str] = None)

Get the value of “Sph Mass”.

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

GetSphTemperature(unit: Optional[str] = None)

Get the value of “Sph Temperature”.

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

GetStopTime(unit: Optional[str] = None)

Get the value of “Stop Time”.

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

GetUseGeometriesToCompute()

Get the value of “Use Geometries To Compute”.

IsPeriodicEnabled()

Check if the “Periodic” is enabled.

SetBoxCenter(values: Sequence[Union[str, float]], unit: Optional[str] = None)

Set the values of “Box Center”.

  • Parameters:
    • values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.
    • unit – The unit for values. If no unit is provided, values is assumed to be in “m”.
  • Raises: RockyApiError – If values doesn’t have exactly 3 elements.

SetBoxDimensions(values: Sequence[Union[str, float]], unit: Optional[str] = None)

Set the values of “Box Dimensions”.

  • Parameters:
    • values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.
    • unit – The unit for values. If no unit is provided, values is assumed to be in “m”.
  • Raises: RockyApiError – If values doesn’t have exactly 3 elements.

SetGapScaleFactor(value: Union[str, float])

Set the value of “Gap Scale Factor”.

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

SetGeometries(values)

Set the “Geometries”.

:param List[str, RAWall] values: : A list with names, RAWall.

SetInitialVelocity(values: Sequence[Union[str, float]], unit: Optional[str] = None)

Set the values of “Initial Velocity”.

  • Parameters:
    • values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.
    • unit – The unit for values. If no unit is provided, values is assumed to be in “m/s”.
  • Raises: RockyApiError – If values doesn’t have exactly 3 elements.

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

Set the value of “Injection Time”.

  • 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 “s”.

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

Set the value of “Period”.

  • 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 “s”.

SetPeriodic(value: bool)

Set the value of “Periodic”.

  • Parameters: value – The value to set.

SetSeedCoordinates(values: Sequence[Union[str, float]], unit: Optional[str] = None)

Set the values of “Seed Coordinates”.

  • Parameters:
    • values – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.
    • unit – The unit for values. If no unit is provided, values is assumed to be in “m”.
  • Raises: RockyApiError – If values doesn’t have exactly 3 elements.

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

Set the value of “Sph Mass”.

  • 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 “kg”.

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

Set the value of “Sph Temperature”.

  • 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 “K”.

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

Set the value of “Stop Time”.

  • 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 “s”.

SetUseGeometriesToCompute(value: bool)

Set the value of “Use Geometries To Compute”.

  • Parameters: value – The value to set.

Connect with Ansys