Coil Current Report
The ExcitationCoilCurrentReport returns the electric current flowing through the coil in response to an applied voltage or an applied current (in which case it just returns the applied current).
When a voltage is applied across a coil, an electric current flows through it depending on the coil’s resistance and the back electromotive force induced by the changing magnetic field.
\[I = \frac{1}{R} \left( V - \int_\Omega \frac{\partial \mathbf{A}}{\partial t} \cdot \mathbf{\tau} \rm{d}\, \Omega \right)\]
where \(I [{\rm A}]\) is the resulting current, \(V [{\rm V}]\) is the applied voltage, \(R [{\rm \Omega}]\) is the coil resistance. The second term is the back electromotive force.
Usage Example
from mufem.electromagnetics.coil import ExcitationCoilCurrentReport
help(ExcitationCoilCurrentReport)
Help on class ExcitationCoilCurrentReport in module mufem.electromagnetics.coil:
class ExcitationCoilCurrentReport(mufem.ReportTrait)
| Method resolution order:
| ExcitationCoilCurrentReport
| mufem.ReportTrait
| pybind11_builtins.pybind11_object
| builtins.object
|
| Methods defined here:
|
| __init__(...)
| __init__(self: mufem.electromagnetics.coil.ExcitationCoilCurrentReport, name: str, coil_index: int) -> None
|
| Creates a ExcitationCoilCurrentReport with the given name and coil index.
|
| :param name: Name of the coil
| :param coil_index: Index of the coil
|
| evaluate(...)
| evaluate(self: mufem.electromagnetics.coil.ExcitationCoilCurrentReport) -> Value
|
| Evaluates and returns the current of the coil.
|
| get_name(...)
| get_name(self: mufem.electromagnetics.coil.ExcitationCoilCurrentReport) -> str
|
| Returns the name of the coil.
|
| ----------------------------------------------------------------------
| 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.