Work in Progress

This document is still under development and may change frequently.

Time-Domain Magnetic Material: Constant

from mufem.electromagnetics.timedomainmagnetic import TimeDomainMagneticGeneralMaterial

help(TimeDomainMagneticGeneralMaterial.Constant)

Help on built-in function Constant in module mufem.electromagnetics.timedomainmagnetic:

Constant(...) method of builtins.PyCapsule instance
    Constant(name: str, marker: mufem.Marker, relative_magnetic_permeability: float = 1.0, electric_conductivity: float = 0.0, remanent_flux_density: object = (0.0, 0.0, 0.0), has_eddy_currents: bool = True) -> mufem.electromagnetics.timedomainmagnetic.TimeDomainMagneticGeneralMaterial


    Creates a non-magnetic material with constant relative magnetic permeability and electric conductivity.

    Parameters:
        name : str
            Name of the material
        marker : Marker
            Marker of the material
        relative_magnetic_permeability : float
            Relative magnetic permeability of the material, default is 1.0.
        electric_conductivity : float
            Electric conductivity of the material, default is 0.0.
        remanent_flux_density : 3-element sequence
            Remanent flux density of the material, default is (0.0, 0.0, 0.0)
        has_eddy_currents : bool
            Whether the material has eddy currents, default is True.

    Returns:
        TimeDomainMagneticGeneralMaterial::Constant