add_spatial_modifier_dataset#

MatProperty.add_spatial_modifier_dataset(dataset, index=0)[source]#

Add a spatial modifier to a material property using an existing dataset.

Parameters:
datasetstr

Name of the project dataset.

indexint, optional

Value for the index. The default is 0.

Returns:
bool

True when successful, False when failed.

References

>>> oDefinitionManager.EditMaterial

Examples

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss(version="2021.2")
>>> mat1 = hfss.materials.add_material("new_copper2")
>>> mat1.add_spatial_modifier_dataset("$ds1")