:class:`RAMassFlowDynamicInlet` =============================== .. py:class:: ansys.rocky.app.ra_mass_flow_dynamic_inlet.RAMassFlowDynamicInlet(id: str, model_id: str | None = None) Bases: :py:obj:`ansys.rocky.app.api_element_item.ApiElementItem` Rocky PrePost Scripting wrapper for a single Mass Flow Dynamic Inlet input. This wrapper class corresponds to an individual entry under the "Inputs" item on the project's data tree. Mass Flow Dynamic Inlets can be retrieved from the :class:`RAStudy` or the :class:`RAInletsOutletsCollection` via: .. code-block:: python inlet = study.GetElement('Mass Flow Dynamic Inlet <1>') .. !! processed by numpydoc !! .. py:currentmodule:: RAMassFlowDynamicInlet 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 Mass Flow Dynamic Inlet input properties list. * - :py:attr:`~RemoveParticle` - Remove a particle from the Mass Flow Dynamic Inlet input properties list. * - :py:attr:`~GetName` - Get the value of "Name". * - :py:attr:`~SetName` - Set the value of "Name". * - :py:attr:`~GetInjectionVelocity` - Get the value of "Injection Velocity". * - :py:attr:`~SetInjectionVelocity` - Set the value of "Injection Velocity". * - :py:attr:`~GetMaximumInjectionTries` - Get the value of "Maximum Injection Tries". * - :py:attr:`~SetMaximumInjectionTries` - Set the value of "Maximum Injection Tries". * - :py:attr:`~GetPeriod` - Get the value of "Period". * - :py:attr:`~SetPeriod` - Set the value of "Period". * - :py:attr:`~GetRandomTravelExponent` - Get the value of "Random Travel Exponent". * - :py:attr:`~SetRandomTravelExponent` - Set the value of "Random Travel Exponent". * - :py:attr:`~GetSizeScaling` - Get the value of "Size Scaling". * - :py:attr:`~SetSizeScaling` - Set the value of "Size Scaling". * - :py:attr:`~GetStartTime` - Get the value of "Start Time". * - :py:attr:`~SetStartTime` - Set the value of "Start Time". * - :py:attr:`~GetStopTime` - Get the value of "Stop Time". * - :py:attr:`~SetStopTime` - Set the value of "Stop Time". * - :py:attr:`~GetVoidFraction` - Get the value of "Void Fraction". * - :py:attr:`~SetVoidFraction` - Set the value of "Void Fraction". Import detail ------------- .. code-block:: python from ansys.rocky.app.ra_mass_flow_dynamic_inlet import RAMassFlowDynamicInlet Method detail ------------- .. py:method:: GetWrappedClass() :classmethod: .. py:method:: GetClassName() -> str :classmethod: .. py:method:: GetInputPropertiesList() -> ansys.rocky.app.ra_mass_flow_dynamic_inlet_properties.RAMassFlowDynamicInletPropertiesList Return a list of input properties .. !! processed by numpydoc !! .. py:method:: AddParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) -> ansys.rocky.app.ra_mass_flow_dynamic_inlet_properties.RAMassFlowDynamicInletPropertiesList Add a new particle to the Mass Flow Dynamic Inlet input properties list. :return: A new :class:`RAMassFlowDynamicInletPropertiesList` object. .. !! processed by numpydoc !! .. py:method:: RemoveParticle(particle: ansys.rocky.app.ra_particle.RAParticle | str) -> None Remove a particle from the Mass Flow Dynamic 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:: GetInjectionVelocity(unit: str | None = None) -> float Get the value of "Injection 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:: SetInjectionVelocity(value: str | float, unit: str | None = None) -> None Set the value of "Injection 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:: GetMaximumInjectionTries() -> int Get the value of "Maximum Injection Tries". .. !! processed by numpydoc !! .. py:method:: SetMaximumInjectionTries(value: str | int) -> None Set the value of "Maximum Injection Tries". :param value: The value to set. This value can be an expression with input variables or int type. .. !! 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:: GetRandomTravelExponent() -> float Get the value of "Random Travel Exponent". .. !! processed by numpydoc !! .. py:method:: SetRandomTravelExponent(value: str | float) -> None Set the value of "Random Travel Exponent". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !! .. py:method:: GetSizeScaling() -> float Get the value of "Size Scaling". .. !! processed by numpydoc !! .. py:method:: SetSizeScaling(value: str | float) -> None Set the value of "Size Scaling". :param value: The value to set. This value can be an expression with input variables or float type. .. !! 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:: 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:: GetVoidFraction() -> float Get the value of "Void Fraction". .. !! processed by numpydoc !! .. py:method:: SetVoidFraction(value: str | float) -> None Set the value of "Void Fraction". :param value: The value to set. This value can be an expression with input variables or float type. .. !! processed by numpydoc !!