SolidMaterial

class SolidMaterial

Bases: MaterialBase

Represents the solid material properties for heat transfer volume.

Example

>>> fl.SolidMaterial(
...     name="aluminum",
...     thermal_conductivity=235 * fl.u.kg / fl.u.s**3 * fl.u.m / fl.u.K,
...     density=2710 * fl.u.kg / fl.u.m**3,
...     specific_heat_capacity=903 * fl.u.m**2 / fl.u.s**2 / fl.u.K,
... )

---

Attributes

name: str

Name of the solid material.

thermal_conductivity: ThermalConductivityType.Positive

Thermal conductivity of the material.

density: DensityType.Positive, optional

Density of the material.

Default:

None

specific_heat_capacity: SpecificHeatCapacityType.Positive, optional

Specific heat capacity of the material.

Default:

None

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')