## On this page

  

 

 # RAFluidMaterial

 Last update: 16.07.2025 

<a id="generated.RAFluidMaterial"></a>

### *class* RAFluidMaterial

Rocky PrePost Scripting wrapper for individual fluid materials in a project.

Retrieve individual materials from the [`RAStudy`](RAStudy.md#generated.RAStudy)or the [`RAMaterialCollection`](RAMaterialCollection.md#generated.RAMaterialCollection) via:

```python
material_1 = study.GetElement('fluid material 1')
material_2 = material_collection.GetMaterial('fluid material 2')
material_3 = material_collection[2]

```

**Methods:**

NameDescription[`GetDensity`](#generated.RAFluidMaterial.GetDensity)(\[unit\])Get the value of "Density".[`GetModuleProperties`](#generated.RAFluidMaterial.GetModuleProperties)()Get the names of the module properties.[`GetModuleProperty`](#generated.RAFluidMaterial.GetModuleProperty)(property\_name\[, unit\])Get the value of a module property.[`GetSoundSpeed`](#generated.RAFluidMaterial.GetSoundSpeed)(\[unit\])Deprecated: Use this method from RASPHSettings instead[`GetSpecificHeat`](#generated.RAFluidMaterial.GetSpecificHeat)(\[unit\])Get the value of "Specific Heat".[`GetThermalConductivity`](#generated.RAFluidMaterial.GetThermalConductivity)(\[unit\])Get the value of "Thermal Conductivity".[`GetValidOptionsForModuleProperty`](#generated.RAFluidMaterial.GetValidOptionsForModuleProperty)(property\_name)Get all valid options only for properties that have a list of possible options.[`GetViscosity`](#generated.RAFluidMaterial.GetViscosity)(\[unit\])Get the value of "Viscosity".[`SetDensity`](#generated.RAFluidMaterial.SetDensity)(value\[, unit\])Set the value of "Density".[`SetModuleProperty`](#generated.RAFluidMaterial.SetModuleProperty)(property\_name, value\[, unit\])Set the value of a module property.[`SetSoundSpeed`](#generated.RAFluidMaterial.SetSoundSpeed)(value\[, unit\])Deprecated: Use this method from RASPHSettings instead[`SetSpecificHeat`](#generated.RAFluidMaterial.SetSpecificHeat)(value\[, unit\])Set the value of "Specific Heat".[`SetThermalConductivity`](#generated.RAFluidMaterial.SetThermalConductivity)(value\[, unit\])Set the value of "Thermal Conductivity".[`SetViscosity`](#generated.RAFluidMaterial.SetViscosity)(value\[, unit\])Set the value of "Viscosity".<a id="generated.RAFluidMaterial.GetDensity"></a>

#### GetDensity(unit: str | None = None)

Get the value of “Density”.

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

<a id="generated.RAFluidMaterial.GetModuleProperties"></a>

#### GetModuleProperties()

Get the names of the module properties.

- **Return type:**tuple(ModulePropertyIdentifier)

<a id="generated.RAFluidMaterial.GetModuleProperty"></a>

#### GetModuleProperty(property\_name: str | ModulePropertyIdentifier, unit: str | None = None)

Get the value of a module property.

- **Parameters:**
    - **property\_name** (*Union* \*\[\**str* *,* *ModulePropertyIdentifier* *\]*) – The name of the module property to get.
    - **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, the returned value will be in the unit that was set before (via SetModuleProperty()).
- **Return type:**float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList)
- **Returns:**
    - For basic module properties like numbers and booleans, the returned value is a basic Python type (float, bool, or string)
    - For input files, the returned value is the string of the full path to the file
    - For properties that are lists of other properties, the returned value is a : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList).

<a id="generated.RAFluidMaterial.GetSoundSpeed"></a>

#### GetSoundSpeed(unit: str | None = None)

Deprecated: Use this method from RASPHSettings instead

<a id="generated.RAFluidMaterial.GetSpecificHeat"></a>

#### GetSpecificHeat(unit: str | None = None)

Get the value of “Specific Heat”.

- **Parameters:****unit** – The unit for the returned value. If no unit is provided, the returned value will be in “J/kg.K”.

<a id="generated.RAFluidMaterial.GetThermalConductivity"></a>

#### GetThermalConductivity(unit: str | None = None)

Get the value of “Thermal Conductivity”.

- **Parameters:****unit** – The unit for the returned value. If no unit is provided, the returned value will be in “W/m.K”.

<a id="generated.RAFluidMaterial.GetValidOptionsForModuleProperty"></a>

#### GetValidOptionsForModuleProperty(property\_name)

Get all valid options only for properties that have a list of possible options.

- **Parameters:****property\_name** (*str*) – The name of the module property.
- **Return type:**List\[str\]

<a id="generated.RAFluidMaterial.GetViscosity"></a>

#### GetViscosity(unit: str | None = None)

Get the value of “Viscosity”.

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

<a id="generated.RAFluidMaterial.SetDensity"></a>

#### SetDensity(value: str | float, unit: str | None = None)

Set the value of “Density”.

- **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/m3”.

<a id="generated.RAFluidMaterial.SetModuleProperty"></a>

#### SetModuleProperty(property\_name: str | ModulePropertyIdentifier, value: float | bool | str, unit: str | None = None)

Set the value of a module property.

- **Parameters:**
    - **property\_name** (*Union* \*\[\**str* *,* *ModulePropertyIdentifier* *\]*) – The name of the module property to set.
    - **value** (*float* *,* *bool* *or* *str*) – The value to set. If the property\_name references to an enum property then value must be an str value.
    - **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, value is assumed to be the unit was set before.

<a id="generated.RAFluidMaterial.SetSoundSpeed"></a>

#### SetSoundSpeed(value: str | float, unit: str | None = None)

Deprecated: Use this method from RASPHSettings instead

<a id="generated.RAFluidMaterial.SetSpecificHeat"></a>

#### SetSpecificHeat(value: str | float, unit: str | None = None)

Set the value of “Specific Heat”.

- **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 “J/kg.K”.

<a id="generated.RAFluidMaterial.SetThermalConductivity"></a>

#### SetThermalConductivity(value: str | float, unit: str | None = None)

Set the value of “Thermal Conductivity”.

- **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 “W/m.K”.

<a id="generated.RAFluidMaterial.SetViscosity"></a>

#### SetViscosity(value: str | float, unit: str | None = None)

Set the value of “Viscosity”.

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