add_spatial_modifier_free_form#

MatProperty.add_spatial_modifier_free_form(formula, index=0)[source]#

Add a spatial modifier to a material property using a free-form formula.

Parameters:

formulastr: Full formula to apply.
indexint, optional: Value for the index. The default is 0.

Returns:

bool: True when successful, False when failed.

References

>>> oDefinitionManager.EditMaterial

Examples

>>> from pyaedt import Hfss
>>> hfss = Hfss(specified_version="2021.2")
>>> mat1 = hfss.materials.add_material("new_copper2")
>>> mat1.add_spatial_modifier_free_form("if(X > 1mm, 1, if(X < 1mm, 2, 1))")