:class:`RAConstantOneWayCoupling` ================================= .. py:class:: ansys.rocky.app.ra_cfd_coupling.RAConstantOneWayCoupling Bases: :py:obj:`RABaseCFDCoupling` Rocky PrePost Scripting wrapper for One-Way Constant CFD coupling properties. This wrapper can be accessed via the project's :class:`RACFDCoupling`: .. code-block:: python cfd_coupling = study.GetCFDCoupling() cfd_coupling.SetupOneWayConstant() constant_one_way = cfd_coupling.GetCouplingProcess() .. !! processed by numpydoc !! .. py:currentmodule:: RAConstantOneWayCoupling 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:`~GetDensity` - Get the value of "Density". * - :py:attr:`~SetDensity` - Set the value of "Density". * - :py:attr:`~GetSpecificHeat` - Get the value of "Specific Heat". * - :py:attr:`~SetSpecificHeat` - Set the value of "Specific Heat". * - :py:attr:`~GetStartTime` - Get the value of "Start Time". * - :py:attr:`~SetStartTime` - Set the value of "Start Time". * - :py:attr:`~GetTemperature` - Get the value of "Temperature". * - :py:attr:`~SetTemperature` - Set the value of "Temperature". * - :py:attr:`~GetThermalConductivity` - Get the value of "Thermal Conductivity". * - :py:attr:`~SetThermalConductivity` - Set the value of "Thermal Conductivity". * - :py:attr:`~GetTurbulentDissipationRate` - Get the value of "Turbulent Dissipation Rate". * - :py:attr:`~SetTurbulentDissipationRate` - Set the value of "Turbulent Dissipation Rate". * - :py:attr:`~GetTurbulentKineticEnergy` - Get the value of "Turbulent Kinetic Energy". * - :py:attr:`~SetTurbulentKineticEnergy` - Set the value of "Turbulent Kinetic Energy". * - :py:attr:`~GetUseTurbulentDispersion` - Get the value of "Use Turbulent Dispersion". * - :py:attr:`~SetUseTurbulentDispersion` - Set the value of "Use Turbulent Dispersion". * - :py:attr:`~EnableTurbulentDispersion` - Set the value of "Turbulent Dispersion" to True. * - :py:attr:`~DisableTurbulentDispersion` - Set the value of "Turbulent Dispersion" to False. * - :py:attr:`~IsTurbulentDispersionEnabled` - Check if the "Turbulent Dispersion" is enabled. * - :py:attr:`~GetVelocity` - Get the value of "Velocity". * - :py:attr:`~SetVelocity` - Set the values of "Velocity". * - :py:attr:`~GetViscosity` - Get the value of "Viscosity". * - :py:attr:`~SetViscosity` - Set the value of "Viscosity". Import detail ------------- .. code-block:: python from ansys.rocky.app.ra_cfd_coupling import RAConstantOneWayCoupling Method detail ------------- .. py:method:: GetWrappedClass() :classmethod: .. py:method:: GetClassName() :classmethod: .. py:method:: GetDensity(unit: str | None = None) -> float Get the value of "Density". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "kg/m3". .. !! processed by numpydoc !! .. py:method:: SetDensity(value: str | float, unit: str | None = None) -> None Set the value of "Density". :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 "kg/m3". .. !! processed by numpydoc !! .. py:method:: GetSpecificHeat(unit: str | None = None) -> float Get the value of "Specific Heat". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "J/kg.K". .. !! processed by numpydoc !! .. py:method:: SetSpecificHeat(value: str | float, unit: str | None = None) -> None Set the value of "Specific Heat". :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 "J/kg.K". .. !! 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:: GetTemperature(unit: str | None = None) -> float Get the value of "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:: SetTemperature(value: str | float, unit: str | None = None) -> None Set the value of "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:: GetThermalConductivity(unit: str | None = None) -> float Get the value of "Thermal Conductivity". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "W/m.K". .. !! processed by numpydoc !! .. py:method:: SetThermalConductivity(value: str | float, unit: str | None = None) -> None Set the value of "Thermal Conductivity". :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 "W/m.K". .. !! processed by numpydoc !! .. py:method:: GetTurbulentDissipationRate(unit: str | None = None) -> float Get the value of "Turbulent Dissipation Rate". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "W/kg". .. !! processed by numpydoc !! .. py:method:: SetTurbulentDissipationRate(value: str | float, unit: str | None = None) -> None Set the value of "Turbulent Dissipation Rate". :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 "W/kg". .. !! processed by numpydoc !! .. py:method:: GetTurbulentKineticEnergy(unit: str | None = None) -> float Get the value of "Turbulent Kinetic Energy". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "J/kg". .. !! processed by numpydoc !! .. py:method:: SetTurbulentKineticEnergy(value: str | float, unit: str | None = None) -> None Set the value of "Turbulent Kinetic Energy". :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 "J/kg". .. !! processed by numpydoc !! .. py:method:: GetUseTurbulentDispersion() -> bool Get the value of "Use Turbulent Dispersion". .. !! processed by numpydoc !! .. py:method:: SetUseTurbulentDispersion(value: bool) -> None Set the value of "Use Turbulent Dispersion". :param value: The value to set. .. !! processed by numpydoc !! .. py:method:: EnableTurbulentDispersion() -> None Set the value of "Turbulent Dispersion" to True. .. !! processed by numpydoc !! .. py:method:: DisableTurbulentDispersion() -> None Set the value of "Turbulent Dispersion" to False. .. !! processed by numpydoc !! .. py:method:: IsTurbulentDispersionEnabled() -> bool Check if the "Turbulent Dispersion" is enabled. .. !! processed by numpydoc !! .. py:method:: GetVelocity(unit: str | None = None) -> list[float] Get the value of "Velocity". :param unit: The unit for the returned values. If no unit is provided, the returned values will be in "m/s". .. !! processed by numpydoc !! .. py:method:: SetVelocity(values: collections.abc.Sequence[str | float], unit: str | None = None) -> None Set the values of "Velocity". :param 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. :param 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. .. !! processed by numpydoc !! .. py:method:: GetViscosity(unit: str | None = None) -> float Get the value of "Viscosity". :param unit: The unit for the returned value. If no unit is provided, the returned value will be in "Pa.s". .. !! processed by numpydoc !! .. py:method:: SetViscosity(value: str | float, unit: str | None = None) -> None Set the value of "Viscosity". :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 "Pa.s". .. !! processed by numpydoc !!