add_material_sweep

Materials.add_material_sweep(swargs, matname)[source]

Create a sweep material made of an array of materials.

If a material needs to have a dataset (thermal modifier), then a dataset is created. Material properties are loaded from the XML file database amat.xml.

Parameters
swargslist

List of materials to merge into a single sweep material.

matnamestr

Name of the sweep material.

enableTMbool, optional

Unavailable currently. Whether to enable the thermal modifier. The default is True.

Returns
int

Index of the project variable.

References

>>> oDefinitionManager.AddMaterial

Examples

>>> from pyaedt import Hfss
>>> hfss = Hfss()
>>> hfss.materials.add_material("MyMaterial")
>>> hfss.materials.add_material("MyMaterial2")
>>> hfss.materials.add_material_sweep(["MyMaterial", "MyMaterial2"], "Sweep_copper")