Solid

class Solid

Bases: PDEModelBase

Solid class for setting up the conjugate heat transfer volume model that contains all the common fields every heat transfer zone should have.

Example

Define Solid model for volumes with the name pattern "solid-*".

>>> fl.Solid(
...     entities=[volume_mesh["solid-*"]],
...     heat_equation_solver=fl.HeatEquationSolver(
...         equation_evaluation_frequency=2,
...         linear_solver=fl.LinearSolver(
...             absolute_tolerance=1e-10,
...             max_iterations=50
...         ),
...         relative_tolerance=0.001,
...     ),
...     initial_condition=fl.HeatEquationInitialCondition(temperature="1.0"),
...     material=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,
...     ),
...     volumetric_heat_source=1.0 * fl.u.W / fl.u.m**3,
... )

---

Attributes

material: SolidMaterial

The material property of solid.

initial_condition: HeatEquationInitialCondition, optional

The initial condition of the heat equation solver.

Default:

None

name: str, optional

Name of the Solid model.

Default:

None

entities: EntityList[GenericVolume, CustomVolume, SeedpointVolume]

The list of GenericVolume or CustomVolume or SeedpointVolume entities on which the heat transfer equation is solved. The assigned volumes must have only tetrahedral elements.

heat_equation_solver: HeatEquationSolver

Heat equation solver settings, see HeatEquationSolver documentation.

Default:

HeatEquationSolver()

volumetric_heat_source: str | HeatSourceType

The volumetric heat source.

Default:

0 * W/m**3

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')