assign_force

Maxwell2d.assign_force(input_object, reference_cs='Global', is_virtual=True, force_name=None)

Assign a force to one or more objects.

Force assignment can be calculated based upon the solver type. For 3D solvers the available solution types are: Magnetostatic, Electrostatic, Eddy Current, Transient and Electric Transient. For 2D solvers the available solution types are: Magnetostatic, Electrostatic, Eddy Current and Transient.

Parameters:

input_objectstr, list

One or more objects to assign the force to.

reference_csstr, optional

Name of the reference coordinate system. The default is "Global".

is_virtualbool, optional

Whether the force is virtual. The default is True.

force_namestr, optional

Name of the force. The default is None, in which case the default name is used.

Returns:

bool

True when successful, False when failed.

References

>>> oModule.AssignForce