:class:`RAParticleInlet` ======================== .. py:class:: ansys.rocky.app.ra_particle_inlet.RAParticleInlet(id: str, model_id: str | None = None) Bases: :py:obj:`ansys.rocky.app.api_element_item.ApiElementItem` Rocky PrePost Scripting wrapper for a single Continuous Injection 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 :class:`RAStudy` or the :class:`RAInletsOutletsCollection` via: .. code-block:: python input_1 = study.GetElement('Continuous Injection <1>') input_2 = input_collection.GetParticleInput('Continuous Injection <2>') Instances of :class:`RAParticleInlet` comprise two parts: Properties that can be manipulated directly, such as the input's name and the particle entry point, and the input properties list that describe which particles enter via this input and with each mass flow rate, temperature, etc. This list must be manipulated via the :class:`RAParticleInputPropertiesList` returned by :meth:`GetInputPropertiesList()`. .. !! processed by numpydoc !! .. py:currentmodule:: RAParticleInlet Overview -------- .. tab-set:: .. tab-item:: Constructors .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~GetWrappedClass` - * - :py:attr:`~GetClassName` - .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~GetInputPropertiesList` - Return a list of input properties * - :py:attr:`~AddParticle` - Add a new particle to the Particle Inlet input properties list. * - :py:attr:`~RemoveParticle` - Remove a particle from the Particle Inlet input properties list. * - :py:attr:`~GetName` - Get the value of "Name". * - :py:attr:`~SetName` - Set the value of "Name". * - :py:attr:`~GetInjectionDuration` - Get the value of "Injection Duration". * - :py:attr:`~SetInjectionDuration` - Set the value of "Injection Duration". * - :py:attr:`~GetForcePacking` - Get the value of "Force Packing". * - :py:attr:`~SetForcePacking` - Set the value of "Force Packing". * - :py:attr:`~EnableForcePacking` - Set the value of "Force Packing" to True. * - :py:attr:`~DisableForcePacking` - Set the value of "Force Packing" to False. * - :py:attr:`~IsForcePackingEnabled` - Check if the "Force Packing" is enabled. * - :py:attr:`~GetPeriod` - Get the value of "Period". * - :py:attr:`~SetPeriod` - Set the value of "Period". * - :py:attr:`~GetPeriodic` - Get the value of "Periodic". * - :py:attr:`~SetPeriodic` - Set the value of "Periodic". * - :py:attr:`~EnablePeriodic` - Set the value of "Periodic" to True. * - :py:attr:`~DisablePeriodic` - Set the value of "Periodic" to False. * - :py:attr:`~IsPeriodicEnabled` - Check if the "Periodic" is enabled. * - :py:attr:`~GetStartTime` - Get the value of "Start Time". * - :py:attr:`~SetStartTime` - Set the value of "Start Time". * - :py:attr:`~GetStopAllAtStopTime` - Get the value of "Stop All At Stop Time". * - :py:attr:`~SetStopAllAtStopTime` - Set the value of "Stop All At Stop Time". * - :py:attr:`~EnableStopAllAtStopTime` - Set the value of "Stop All At Stop Time" to True. * - :py:attr:`~DisableStopAllAtStopTime` - Set the value of "Stop All At Stop Time" to False. * - :py:attr:`~IsStopAllAtStopTimeEnabled` - Check if the "Stop All At Stop Time" is enabled. * - :py:attr:`~GetStopTime` - Get the value of "Stop Time". * - :py:attr:`~SetStopTime` - Set the value of "Stop Time". * - :py:attr:`~GetTargetNormalVelocity` - Get the value of "Target Normal Velocity". * - :py:attr:`~SetTargetNormalVelocity` - Set the value of "Target Normal Velocity". * - :py:attr:`~GetUseTargetNormalVelocity` - Get the value of "Use Target Normal Velocity". * - :py:attr:`~SetUseTargetNormalVelocity` - Set the value of "Use Target Normal Velocity". * - :py:attr:`~EnableUseTargetNormalVelocity` - Set the value of "Use Target Normal Velocity" to True. * - :py:attr:`~DisableUseTargetNormalVelocity` - Set the value of "Use Target Normal Velocity" to False. * - :py:attr:`~IsUseTargetNormalVelocityEnabled` - Check if the "Use Target Normal Velocity" is enabled. * - :py:attr:`~GetUxLocal` - Get the value of "Ux Local". * - :py:attr:`~SetUxLocal` - Set the value of "Ux Local". * - :py:attr:`~GetUzLocal` - Get the value of "Uz Local". * - :py:attr:`~SetUzLocal` - Set the value of "Uz Local". * - :py:attr:`~GetSphInjectionEnabled` - Get the value of "Sph Injection Enabled". * - :py:attr:`~SetSphInjectionEnabled` - Set the value of "Sph Injection Enabled". * - :py:attr:`~GetSphTemperature` - Get the value of "Sph Temperature". * - :py:attr:`~SetSphTemperature` - Set the value of "Sph Temperature". * - :py:attr:`~GetEntryPoint` - Get the "Entry Point". * - :py:attr:`~SetEntryPoint` - Set the "Entry Point". * - :py:attr:`~GetAvailableEntryPoints` - Get all available Entry Points. Import detail ------------- .. code-block:: python from ansys.rocky.app.ra_particle_inlet import RAParticleInlet Method detail ------------- .. py:method:: GetWrappedClass() :classmethod: .. py:method:: GetClassName() -> str :classmethod: .. py:method:: GetInputPropertiesList() -> ansys.rocky.app.ra_particle_inlet_properties.RAParticleInletPropertiesList Return a list of input properties .. !! processed by numpydoc !! .. py:method:: AddParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) -> ansys.rocky.app.ra_particle_inlet_properties.RAParticleInletPropertiesList Add a new particle to the Particle Inlet input properties list. : return: A new :class:`RAParticleInletPropertiesList` object that can be used to set .. !! processed by numpydoc !! .. py:method:: RemoveParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) -> None Remove a particle from the Particle Inlet input properties list. :param particle: The particle to remove, either as an :class:`RAParticle` object or by name. .. !! processed by numpydoc !! .. py:method:: GetName() -> str Get the value of "Name". .. !! processed by numpydoc !! .. py:method:: SetName(value: str) -> None Set the value of "Name". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetInjectionDuration(unit: str | None = None) -> float Get the value of "Injection Duration". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "s". .. !! processed by numpydoc !! .. py:method:: SetInjectionDuration(value: str | float, unit: str | None = None) -> None Set the value of "Injection Duration". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "s". .. !! processed by numpydoc !! .. py:method:: GetForcePacking() -> bool Get the value of "Force Packing". .. !! processed by numpydoc !! .. py:method:: SetForcePacking(value: bool) -> None Set the value of "Force Packing". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableForcePacking() -> None Set the value of "Force Packing" to True. .. !! processed by numpydoc !! .. py:method:: DisableForcePacking() -> None Set the value of "Force Packing" to False. .. !! processed by numpydoc !! .. py:method:: IsForcePackingEnabled() -> bool Check if the "Force Packing" is enabled. .. !! processed by numpydoc !! .. py:method:: GetPeriod(unit: str | None = None) -> float Get the value of "Period". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "s". .. !! processed by numpydoc !! .. py:method:: SetPeriod(value: str | float, unit: str | None = None) -> None Set the value of "Period". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "s". .. !! processed by numpydoc !! .. py:method:: GetPeriodic() -> bool Get the value of "Periodic". .. !! processed by numpydoc !! .. py:method:: SetPeriodic(value: bool) -> None Set the value of "Periodic". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnablePeriodic() -> None Set the value of "Periodic" to True. .. !! processed by numpydoc !! .. py:method:: DisablePeriodic() -> None Set the value of "Periodic" to False. .. !! processed by numpydoc !! .. py:method:: IsPeriodicEnabled() -> bool Check if the "Periodic" is enabled. .. !! processed by numpydoc !! .. py:method:: GetStartTime(unit: str | None = None) -> float Get the value of "Start Time". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "s". .. !! processed by numpydoc !! .. py:method:: SetStartTime(value: str | float, unit: str | None = None) -> None Set the value of "Start Time". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "s". .. !! processed by numpydoc !! .. py:method:: GetStopAllAtStopTime() -> bool Get the value of "Stop All At Stop Time". .. !! processed by numpydoc !! .. py:method:: SetStopAllAtStopTime(value: bool) -> None Set the value of "Stop All At Stop Time". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableStopAllAtStopTime() -> None Set the value of "Stop All At Stop Time" to True. .. !! processed by numpydoc !! .. py:method:: DisableStopAllAtStopTime() -> None Set the value of "Stop All At Stop Time" to False. .. !! processed by numpydoc !! .. py:method:: IsStopAllAtStopTimeEnabled() -> bool Check if the "Stop All At Stop Time" is enabled. .. !! processed by numpydoc !! .. py:method:: GetStopTime(unit: str | None = None) -> float Get the value of "Stop Time". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "s". .. !! processed by numpydoc !! .. py:method:: SetStopTime(value: str | float, unit: str | None = None) -> None Set the value of "Stop Time". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "s". .. !! processed by numpydoc !! .. py:method:: GetTargetNormalVelocity(unit: str | None = None) -> float Get the value of "Target Normal Velocity". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m/s". .. !! processed by numpydoc !! .. py:method:: SetTargetNormalVelocity(value: str | float, unit: str | None = None) -> None Set the value of "Target Normal Velocity". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m/s". .. !! processed by numpydoc !! .. py:method:: GetUseTargetNormalVelocity() -> bool Get the value of "Use Target Normal Velocity". .. !! processed by numpydoc !! .. py:method:: SetUseTargetNormalVelocity(value: bool) -> None Set the value of "Use Target Normal Velocity". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableUseTargetNormalVelocity() -> None Set the value of "Use Target Normal Velocity" to True. .. !! processed by numpydoc !! .. py:method:: DisableUseTargetNormalVelocity() -> None Set the value of "Use Target Normal Velocity" to False. .. !! processed by numpydoc !! .. py:method:: IsUseTargetNormalVelocityEnabled() -> bool Check if the "Use Target Normal Velocity" is enabled. .. !! processed by numpydoc !! .. py:method:: GetUxLocal(unit: str | None = None) -> float Get the value of "Ux Local". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m/s". .. !! processed by numpydoc !! .. py:method:: SetUxLocal(value: str | float, unit: str | None = None) -> None Set the value of "Ux Local". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m/s". .. !! processed by numpydoc !! .. py:method:: GetUzLocal(unit: str | None = None) -> float Get the value of "Uz Local". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "m/s". .. !! processed by numpydoc !! .. py:method:: SetUzLocal(value: str | float, unit: str | None = None) -> None Set the value of "Uz Local". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "m/s". .. !! processed by numpydoc !! .. py:method:: GetSphInjectionEnabled() -> bool Get the value of "Sph Injection Enabled". .. !! processed by numpydoc !! .. py:method:: SetSphInjectionEnabled(value: bool) -> None Set the value of "Sph Injection Enabled". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: GetSphTemperature(unit: str | None = None) -> float Get the value of "Sph Temperature". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "K". .. !! processed by numpydoc !! .. py:method:: SetSphTemperature(value: str | float, unit: str | None = None) -> None Set the value of "Sph Temperature". :param value: The value to set. This value can be an expression with input variables or float type. :param unit: The unit for `value`. If no unit is provided, `value` is assumed to be in "K". .. !! processed by numpydoc !! .. py:method:: GetEntryPoint() Get the "Entry Point". :rtype: :class:`RAInletGeometry`, :class:`RAFeedConveyor`, :class:`RARectangularSurface`, :class:`RACircularSurface`, :class:`RASurface` .. !! processed by numpydoc !! .. py:method:: SetEntryPoint(value) -> None Set the "Entry Point". :param unicode, :class:`RAInletGeometry`, :class:`RAFeedConveyor`, :class:`RARectangularSurface`, :class:`RACircularSurface`, :class:`RASurface` value: Either the API object wrapping the desired entity or its name. .. !! processed by numpydoc !! .. py:method:: GetAvailableEntryPoints() Get all available Entry Points. :rtype: List[:class:`RAInletGeometry`, :class:`RAFeedConveyor`, :class:`RARectangularSurface`, :class:`RACircularSurface`, :class:`RASurface`] A list of :class:`RAInletGeometry`, :class:`RAFeedConveyor`, :class:`RARectangularSurface`, :class:`RACircularSurface`, :class:`RASurface`. .. !! processed by numpydoc !!