RAVolumetricInlet

class ansys.rocky.app.ra_volumetric_inlet.RAVolumetricInlet(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem, ansys.rocky.app._ra_orientation_mixin._RAOrientationMixin

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().

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetInputPropertiesList	Return a list of input properties
AddParticle	Add a new particle to the Volumetric Inlet input properties list.
RemoveParticle	Remove a particle from the Particle Inlet input properties list.
GetBoxCenter	Get the value of “Box Center”.
SetBoxCenter	Set the values of “Box Center”.
GetBoxDimensions	Get the value of “Box Dimensions”.
SetBoxDimensions	Set the values of “Box Dimensions”.
GetUseGeometriesToCompute	Get the value of “Use Geometries To Compute”.
SetUseGeometriesToCompute	Set the value of “Use Geometries To Compute”.
GetGapScaleFactor	Get the value of “Gap Scale Factor”.
SetGapScaleFactor	Set the value of “Gap Scale Factor”.
GetInitialVelocity	Get the value of “Initial Velocity”.
SetInitialVelocity	Set the values of “Initial Velocity”.
GetPeriodic	Get the value of “Periodic”.
SetPeriodic	Set the value of “Periodic”.
EnablePeriodic	Set the value of “Periodic” to True.
DisablePeriodic	Set the value of “Periodic” to False.
IsPeriodicEnabled	Check if the “Periodic” is enabled.
GetName	Get the value of “Name”.
SetName	Set the value of “Name”.
GetPeriod	Get the value of “Period”.
SetPeriod	Set the value of “Period”.
GetSeedCoordinates	Get the value of “Seed Coordinates”.
SetSeedCoordinates	Set the values of “Seed Coordinates”.
GetInjectionTime	Get the value of “Injection Time”.
SetInjectionTime	Set the value of “Injection Time”.
GetStopTime	Get the value of “Stop Time”.
SetStopTime	Set the value of “Stop Time”.
GetSphMass	Get the value of “Sph Mass”.
SetSphMass	Set the value of “Sph Mass”.
GetSphTemperature	Get the value of “Sph Temperature”.
SetSphTemperature	Set the value of “Sph Temperature”.
GetUseBoxCenterAsSeedPoint	Get the value of “Use Box Center As Seed Point”.
SetUseBoxCenterAsSeedPoint	Set the value of “Use Box Center As Seed Point”.
EnableUseBoxCenterAsSeedPoint	Set the value of “Use Box Center As Seed Point” to True.
DisableUseBoxCenterAsSeedPoint	Set the value of “Use Box Center As Seed Point” to False.
IsUseBoxCenterAsSeedPointEnabled	Check if the “Use Box Center As Seed Point” is enabled.
GetGeometries	Get the “Geometries”.
SetGeometries	Set the “Geometries”.
GetAvailableGeometries	Get all available Geometries.

Import detail

from ansys.rocky.app.ra_volumetric_inlet import RAVolumetricInlet

Method detail

classmethod RAVolumetricInlet.GetWrappedClass() → type[rocky30.models.input.volume_fill.VolumeFill]

classmethod RAVolumetricInlet.GetClassName() → str

RAVolumetricInlet.GetInputPropertiesList() → ansys.rocky.app.ra_volumetric_inlet_properties.RAVolumetricInletPropertiesList

Return a list of input properties

RAVolumetricInlet.AddParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) → ansys.rocky.app.ra_volumetric_inlet_properties.RAVolumetricInletProperties

Add a new particle to the Volumetric Inlet input properties list.

: return: A new RAVolumetricInletProperties object that can be used to set

RAVolumetricInlet.RemoveParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) → None

Remove a particle from the Particle Inlet input properties list.

Parameters:

particle – The particle to remove, either as an RAParticle object or by name.

RAVolumetricInlet.GetBoxCenter(unit: str | None = None) → list[float]

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

RAVolumetricInlet.SetBoxCenter(values: collections.abc.Sequence[str | float], unit: str | None = None) → 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.

RAVolumetricInlet.GetBoxDimensions(unit: str | None = None) → list[float]

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

RAVolumetricInlet.SetBoxDimensions(values: collections.abc.Sequence[str | float], unit: str | None = None) → 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.

RAVolumetricInlet.GetUseGeometriesToCompute() → bool

Get the value of “Use Geometries To Compute”.

RAVolumetricInlet.SetUseGeometriesToCompute(value: bool) → None

Set the value of “Use Geometries To Compute”.

Parameters:

value – The value to set.

RAVolumetricInlet.GetGapScaleFactor() → float

Get the value of “Gap Scale Factor”.

RAVolumetricInlet.SetGapScaleFactor(value: str | float) → None

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.

RAVolumetricInlet.GetInitialVelocity(unit: str | None = None) → list[float]

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

RAVolumetricInlet.SetInitialVelocity(values: collections.abc.Sequence[str | float], unit: str | None = None) → 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.

RAVolumetricInlet.GetPeriodic() → bool

Get the value of “Periodic”.

RAVolumetricInlet.SetPeriodic(value: bool) → None

Set the value of “Periodic”.

Parameters:

value – The value to set.

RAVolumetricInlet.EnablePeriodic() → None

Set the value of “Periodic” to True.

RAVolumetricInlet.DisablePeriodic() → None

Set the value of “Periodic” to False.

RAVolumetricInlet.IsPeriodicEnabled() → bool

Check if the “Periodic” is enabled.

RAVolumetricInlet.GetName() → str

Get the value of “Name”.

RAVolumetricInlet.SetName(value: str) → None

Set the value of “Name”.

Parameters:

value – The value to set.

RAVolumetricInlet.GetPeriod(unit: str | None = None) → float

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

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

RAVolumetricInlet.GetSeedCoordinates(unit: str | None = None) → list[float]

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

RAVolumetricInlet.SetSeedCoordinates(values: collections.abc.Sequence[str | float], unit: str | None = None) → 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.

RAVolumetricInlet.GetInjectionTime(unit: str | None = None) → float

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

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

RAVolumetricInlet.GetStopTime(unit: str | None = None) → float

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

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

RAVolumetricInlet.GetSphMass(unit: str | None = None) → float

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

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

RAVolumetricInlet.GetSphTemperature(unit: str | None = None) → float

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

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

RAVolumetricInlet.GetUseBoxCenterAsSeedPoint() → bool

Get the value of “Use Box Center As Seed Point”.

RAVolumetricInlet.SetUseBoxCenterAsSeedPoint(value: bool) → None

Set the value of “Use Box Center As Seed Point”.

Parameters:

value – The value to set.

RAVolumetricInlet.EnableUseBoxCenterAsSeedPoint() → None

Set the value of “Use Box Center As Seed Point” to True.

RAVolumetricInlet.DisableUseBoxCenterAsSeedPoint() → None

Set the value of “Use Box Center As Seed Point” to False.

RAVolumetricInlet.IsUseBoxCenterAsSeedPointEnabled() → bool

Check if the “Use Box Center As Seed Point” is enabled.

RAVolumetricInlet.GetGeometries()

Get the “Geometries”.

Return type:

List[RAWall] A list of RAWall.

RAVolumetricInlet.SetGeometries(values) → None

Set the “Geometries”.

:param List[str, RAWall] values:

A list with names, RAWall.

RAVolumetricInlet.GetAvailableGeometries()

Get all available Geometries.

Return type:

List[RAWall] A list of RAWall.