## On this page

  

 

 # RASolidMaterial

 Last update: 17.07.2025 

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

### *class* RASolidMaterial

Rocky PrePost Scripting wrapper for individual 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('Default Particles')
material_2 = material_collection.GetMaterial('Default Boundaries')
material_3 = material_collection[2]

```

**Methods:**

NameDescription[`GetBulkDensity`](#generated.RASolidMaterial.GetBulkDensity)(\[unit\])Get the value of "Bulk Density".[`GetCurrentDensity`](#generated.RASolidMaterial.GetCurrentDensity)(\[unit\])Get the value of "Current Density".[`GetDensity`](#generated.RASolidMaterial.GetDensity)(\[unit\])Get the value of "Density".[`GetModuleProperties`](#generated.RASolidMaterial.GetModuleProperties)()Get the names of the module properties.[`GetModuleProperty`](#generated.RASolidMaterial.GetModuleProperty)(property\_name\[, unit\])Get the value of a module property.[`GetPoissonRatio`](#generated.RASolidMaterial.GetPoissonRatio)(\[unit\])Get the value of "Poisson Ratio".[`GetSpecificHeat`](#generated.RASolidMaterial.GetSpecificHeat)(\[unit\])Get the value of "Specific Heat".[`GetThermalConductivity`](#generated.RASolidMaterial.GetThermalConductivity)(\[unit\])Get the value of "Thermal Conductivity".[`GetUseBulkDensity`](#generated.RASolidMaterial.GetUseBulkDensity)()Get the value of "Use Bulk Density".[`GetValidOptionsForModuleProperty`](#generated.RASolidMaterial.GetValidOptionsForModuleProperty)(property\_name)Get all valid options only for properties that have a list of possible options.[`GetYoungsModulus`](#generated.RASolidMaterial.GetYoungsModulus)(\[unit\])Get the value of "Youngs Modulus".[`SetBulkDensity`](#generated.RASolidMaterial.SetBulkDensity)(value\[, unit\])Set the value of "Bulk Density".[`SetCurrentDensity`](#generated.RASolidMaterial.SetCurrentDensity)(value\[, unit\])Set the value of "Current Density".[`SetDensity`](#generated.RASolidMaterial.SetDensity)(value\[, unit\])Set the value of "Density".[`SetModuleProperty`](#generated.RASolidMaterial.SetModuleProperty)(property\_name, value\[, unit\])Set the value of a module property.[`SetPoissonRatio`](#generated.RASolidMaterial.SetPoissonRatio)(value\[, unit\])Set the value of "Poisson Ratio".[`SetSpecificHeat`](#generated.RASolidMaterial.SetSpecificHeat)(value\[, unit\])Set the value of "Specific Heat".[`SetThermalConductivity`](#generated.RASolidMaterial.SetThermalConductivity)(value\[, unit\])Set the value of "Thermal Conductivity".[`SetUseBulkDensity`](#generated.RASolidMaterial.SetUseBulkDensity)(value)Set the value of "Use Bulk Density".[`SetYoungsModulus`](#generated.RASolidMaterial.SetYoungsModulus)(value\[, unit\])Set the value of "Youngs Modulus".<a id="generated.RASolidMaterial.GetBulkDensity"></a>

#### GetBulkDensity(unit: Optional\[str\] = None)

Get the value of “Bulk 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.RASolidMaterial.GetCurrentDensity"></a>

#### GetCurrentDensity(unit: Optional\[str\] = None)

Get the value of “Current 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.RASolidMaterial.GetDensity"></a>

#### GetDensity(unit: Optional\[str\] = 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.RASolidMaterial.GetModuleProperties"></a>

#### GetModuleProperties()

Get the names of the module properties.

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

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

#### GetModuleProperty(property\_name: str | rocky30.plugins.api.ra\_addins.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.RASolidMaterial.GetPoissonRatio"></a>

#### GetPoissonRatio(unit: Optional\[str\] = None)

Get the value of “Poisson Ratio”.

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

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

#### GetSpecificHeat(unit: Optional\[str\] = 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.RASolidMaterial.GetThermalConductivity"></a>

#### GetThermalConductivity(unit: Optional\[str\] = 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.RASolidMaterial.GetUseBulkDensity"></a>

#### GetUseBulkDensity()

Get the value of “Use Bulk Density”.

<a id="generated.RASolidMaterial.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.RASolidMaterial.GetYoungsModulus"></a>

#### GetYoungsModulus(unit: Optional\[str\] = None)

Get the value of “Youngs Modulus”.

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

<a id="generated.RASolidMaterial.SetBulkDensity"></a>

#### SetBulkDensity(value: Union\[str, float\], unit: Optional\[str\] = None)

Set the value of “Bulk 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.RASolidMaterial.SetCurrentDensity"></a>

#### SetCurrentDensity(value: Union\[str, float\], unit: Optional\[str\] = None)

Set the value of “Current 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.RASolidMaterial.SetDensity"></a>

#### SetDensity(value: Union\[str, float\], unit: Optional\[str\] = 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.RASolidMaterial.SetModuleProperty"></a>

#### SetModuleProperty(property\_name: str | rocky30.plugins.api.ra\_addins.ModulePropertyIdentifier, value: float | bool | str, unit: Optional\[str\] = 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.RASolidMaterial.SetPoissonRatio"></a>

#### SetPoissonRatio(value: Union\[str, float\], unit: Optional\[str\] = None)

Set the value of “Poisson Ratio”.

- **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 “-“.

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

#### SetSpecificHeat(value: Union\[str, float\], unit: Optional\[str\] = 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.RASolidMaterial.SetThermalConductivity"></a>

#### SetThermalConductivity(value: Union\[str, float\], unit: Optional\[str\] = 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.RASolidMaterial.SetUseBulkDensity"></a>

#### SetUseBulkDensity(value: bool)

Set the value of “Use Bulk Density”.

- **Parameters:****value** – The value to set.

<a id="generated.RASolidMaterial.SetYoungsModulus"></a>

#### SetYoungsModulus(value: Union\[str, float\], unit: Optional\[str\] = None)

Set the value of “Youngs Modulus”.

- **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 “N/m2”.