Excitation Current

The excitation current is the current that is applied to the coil. The current can be a constant value or a time-dependent function (for a time-transient simulation).

Usage Example

from mufem.electromagnetics.coil import CoilExcitationCurrent

help(CoilExcitationCurrent)

Help on class CoilExcitationCurrent in module mufem.electromagnetics.coil:

class CoilExcitationCurrent(CoilExcitation)
 |  Class representing the current used to excite a coil.
 |
 |  This class implements the mechanism to handle the current excitation of a coil.
 |
 |  Method resolution order:
 |      CoilExcitationCurrent
 |      CoilExcitation
 |      pybind11_builtins.pybind11_object
 |      builtins.object
 |
 |  Methods defined here:
 |
 |  __init__(...)
 |      __init__(self: mufem.electromagnetics.coil.CoilExcitationCurrent, electric_current: mufem.CffScalarVariableInputTrait) -> None
 |
 |      Constructor that creates a CoilExcitationCurrent with the given electric current.
 |
 |      Args:
 |          electric_current (CffScalarVariableInputTrait): The electric current for coil excitation.
 |
 |  get_current(...)
 |      get_current(self: mufem.electromagnetics.coil.CoilExcitationCurrent) -> float
 |
 |      Retrieves the electric current.
 |
 |      Returns:
 |          double: The value of the electric current.
 |
 |  get_voltage(...)
 |      get_voltage(self: mufem.electromagnetics.coil.CoilExcitationCurrent) -> float
 |
 |      Retrieves the voltage.
 |
 |      Returns:
 |          double: The value of the voltage.
 |
 |  ----------------------------------------------------------------------
 |  Static methods defined here:
 |
 |  Constant(...) method of builtins.PyCapsule instance
 |      Constant(current: float) -> mufem.electromagnetics.coil.CoilExcitationCurrent
 |
 |      Creates a CoilExcitationCurrent with the given constant current.
 |
 |      Args:
 |          current (double): The constant current.
 |
 |      Returns:
 |          CoilExcitationCurrent: The CoilExcitationCurrent object with the given constant current.
 |
 |  ----------------------------------------------------------------------
 |  Static methods inherited from pybind11_builtins.pybind11_object:
 |
 |  __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object
 |      Create and return a new object.  See help(type) for accurate signature.