set_magnetic_coercivity#

Material.set_magnetic_coercivity(value=0, x=1, y=0, z=0)[source]#

Set magnetic coercivity for material.

Parameters:
valuefloat, optional

Magnitude in A_per_meter. Default value is 0.

xfloat, optional

Vector x component. Default value is 1.

yfloat, optional

Vector y component. Default value is 0.

zfloat, optional

Vector z component. Default value is 0.

Returns:
bool