src/Mod/Fem/femsolver/elmer/equations/magnetodynamic2D_writer.py

# ***************************************************************************
# *   Copyright (c) 2023 Uwe Stöhr <uwestoehr@lyx.org>                      *
# *                                                                         *
# *   This file is part of the FreeCAD CAx development system.              *
# *                                                                         *
# *   This program is free software; you can redistribute it and/or modify  *
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
# *   as published by the Free Software Foundation; either version 2 of     *
# *   the License, or (at your option) any later version.                   *
# *   for detail see the LICENCE text file.                                 *
# *                                                                         *
# *   This program is distributed in the hope that it will be useful,       *
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
# *   GNU Library General Public License for more details.                  *
# *                                                                         *
# *   You should have received a copy of the GNU Library General Public     *
# *   License along with this program; if not, write to the Free Software   *
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
# *   USA                                                                   *
# *                                                                         *
# ***************************************************************************

__title__ = "FreeCAD FEM Magnetodynamics2D Elmer writer"
__author__ = "Uwe Stöhr"
__url__ = "https://www.freecad.org"

## \addtogroup FEM
#  @{

from FreeCAD import Console
from FreeCAD import Units

from femtools import femutils
from .. import sifio
from .. import writer as general_writer


class MgDyn2Dwriter:

    def __init__(self, writer, solver):
        self.write = writer
        self.solver = solver

    def getMagnetodynamic2DSolver(self, equation):
        # output the equation parameters
        s = self.write.createNonlinearSolver(equation)
        if not equation.IsHarmonic:
            s["Equation"] = "MgDyn2D"
            s["Procedure"] = sifio.FileAttr("MagnetoDynamics2D/MagnetoDynamics2D")
            s["Variable"] = "Potential"
        else:
            s["Equation"] = "MgDyn2DHarmonic"
            s["Procedure"] = sifio.FileAttr("MagnetoDynamics2D/MagnetoDynamics2DHarmonic")
            s["Variable"] = "Potential[Potential Re:1 Potential Im:1]"
        s["Exec Solver"] = "Always"
        s["Optimize Bandwidth"] = True
        s["Stabilize"] = equation.Stabilize
        return s

    def getMagnetodynamic2DSolverPost(self, equation):
        # output the equation parameters
        s = self.write.createNonlinearSolver(equation)
        s["Equation"] = "MgDyn2DPost"
        s["Exec Solver"] = "Always"
        s["Procedure"] = sifio.FileAttr("MagnetoDynamics/MagnetoDynamicsCalcFields")
        if equation.IsHarmonic:
            s["Angular Frequency"] = equation.AngularFrequency.getValueAs("Hz")
        s["Potential Variable"] = "Potential"
        if equation.CalculateCurrentDensity is True:
            s["Calculate Current Density"] = True
        if equation.CalculateElectricField is True:
            s["Calculate Electric Field"] = True
        if equation.CalculateElementalFields is False:
            s["Calculate Elemental Fields"] = False
        if equation.CalculateHarmonicLoss is True:
            s["Calculate Harmonic Loss"] = True
        if equation.CalculateJouleHeating is True:
            s["Calculate Joule Heating"] = True
        if equation.CalculateMagneticFieldStrength is True:
            s["Calculate Magnetic Field Strength"] = True
        if equation.CalculateMaxwellStress is True:
            s["Calculate Maxwell Stress"] = True
        if equation.CalculateNodalFields is False:
            s["Calculate Nodal Fields"] = False
        if equation.CalculateNodalForces is True:
            s["Calculate Nodal Forces"] = True
        if equation.CalculateNodalHeating is True:
            s["Calculate Nodal Heating"] = True
        s["Optimize Bandwidth"] = True
        s["Stabilize"] = equation.Stabilize
        return s

    def handleMagnetodynamic2DConstants(self):
        permeability = Units.Quantity(self.write.constsdef["PermeabilityOfVacuum"]).getValueAs(
            "H/m"
        )
        self.write.constant("Permeability Of Vacuum", permeability)

        permittivity = Units.Quantity(self.write.constsdef["PermittivityOfVacuum"]).getValueAs(
            "F/m"
        )
        self.write.constant("Permittivity Of Vacuum", permittivity)

    def handleMagnetodynamic2DMaterial(self, bodies):
        # check that all bodies have a set material
        for name in bodies:
            if self.write.getBodyMaterial(name) is None:
                raise general_writer.WriteError(
                    f"The body {name} is not referenced in any material.\n\n"
                )
        for obj in self.write.getMember("App::MaterialObject"):
            m = obj.Material
            refs = obj.References[0][1] if obj.References else self.write.getAllBodies()
            for name in (n for n in refs if n in bodies):
                if "ElectricalConductivity" not in m:
                    Console.PrintMessage(f"m: {m}\n")
                    raise general_writer.WriteError(
                        "The electrical conductivity must be specified for all materials.\n\n"
                    )
                if "RelativePermeability" not in m:
                    Console.PrintMessage(f"m: {m}\n")
                    raise general_writer.WriteError(
                        "The relative permeability must be specified for all materials.\n\n"
                    )
                self.write.material(name, "Name", m["Name"])
                conductivity = Units.Quantity(m["ElectricalConductivity"]).getValueAs("S/m")
                self.write.material(name, "Electric Conductivity", conductivity)

                self.write.material(name, "Relative Permeability", float(m["RelativePermeability"]))
                # permittivity might be necessary for the post processor
                if "RelativePermittivity" in m:
                    self.write.material(
                        name, "Relative Permittivity", float(m["RelativePermittivity"])
                    )

    def _outputMagnetodynamic2DBodyForce(self, obj, name, equation):
        if femutils.is_derived_from(obj, "Fem::ConstraintCurrentDensity") and obj.Mode == "Normal":
            current_density = obj.NormalCurrentDensity_re.getValueAs("A/m^2")
            self.write.bodyForce(name, "Current Density", current_density)
            # imaginaries are only needed for harmonic equation
            if equation.IsHarmonic:
                current_density = obj.NormalCurrentDensity_im.getValueAs("A/m^2")
                self.write.bodyForce(name, "Current Density Im", current_density)

        if femutils.is_derived_from(obj, "Fem::ConstraintMagnetization"):
            # output only if magnetization is enabled and needed
            if obj.EnableMagnetization_1:
                magnetization = obj.Magnetization_re_1.getValueAs("A/m")
                self.write.material(name, "Magnetization 1", magnetization)
            if obj.EnableMagnetization_2:
                magnetization = obj.Magnetization_re_2.getValueAs("A/m")
                self.write.material(name, "Magnetization 2", magnetization)
            # imaginaries are only needed for harmonic equation
            if equation.IsHarmonic:
                if obj.EnableMagnetization_1:
                    magnetization = obj.Magnetization_im_1.getValueAs("A/m")
                    self.write.material(name, "Magnetization Im 1", magnetization)
                if obj.EnableMagnetization_2:
                    magnetization = obj.Magnetization_im_2.getValueAs("A/m")
                    self.write.material(name, "Magnetization Im 2", magnetization)

    def handleMagnetodynamic2DBodyForces(self, bodies, equation):
        currentDensities = self.write.getMember("Fem::ConstraintCurrentDensity")
        for obj in currentDensities:
            if obj.References:
                for name in obj.References[0][1]:
                    self._outputMagnetodynamic2DBodyForce(obj, name, equation)
                self.write.handled(obj)
            else:
                # if there is only one current density without a reference,
                # add it to all bodies
                if len(currentDensities) == 1:
                    for name in bodies:
                        self._outputMagnetodynamic2DBodyForce(obj, name, equation)
                else:
                    raise general_writer.WriteError(
                        "Several current density constraints found without reference to a body.\n"
                        "Please set a body for each current density constraint."
                    )
            self.write.handled(obj)

        magnetizations = self.write.getMember("Fem::ConstraintMagnetization")
        for obj in magnetizations:
            if obj.References:
                for name in obj.References[0][1]:
                    self._outputMagnetodynamic2DBodyForce(obj, name, equation)
                self.write.handled(obj)
            else:
                # if there is only one magnetization without a reference,
                # add it to all bodies
                if len(magnetizations) == 1:
                    for name in bodies:
                        self._outputMagnetodynamic2DBodyForce(obj, name, equation)
                else:
                    raise general_writer.WriteError(
                        "Several magnetization constraints found without reference to a body.\n"
                        "Please set a body for each current density constraint."
                    )
            self.write.handled(obj)

    def handleMagnetodynamic2DBndConditions(self, equation):
        for obj in self.write.getMember("Fem::ConstraintElectrostaticPotential"):
            if obj.References:
                for name in obj.References[0][1]:
                    # output the FreeCAD label as comment
                    if obj.Label:
                        self.write.boundary(name, "! FreeCAD Name", obj.Label)

                    if obj.BoundaryCondition == "Dirichlet":
                        if obj.EnableAV_3:
                            potential = obj.AV_re_3.getValueAs("Wb/m")
                            self.write.boundary(name, "Potential", potential)
                            if equation.IsHarmonic:
                                potential = obj.AV_im_3.getValueAs("Wb/m")
                                self.write.boundary(name, "Potential im", potential)

                    elif obj.BoundaryCondition == "Neumann":
                        if obj.EnableMagnetic_1:
                            b_1 = obj.Magnetic_re_1.getValueAs("Wb/m^2")
                            self.write.boundary(name, "Magnetic Flux Density 1", b_1)
                            if equation.IsHarmonic:
                                b_1 = obj.Magnetic_im_1.getValueAs("Wb/m^2")
                                self.write.boundary(name, "Magnetic Flux Density 1 im", b_1)

                        if obj.EnableMagnetic_2:
                            b_2 = obj.Magnetic_re_2.getValueAs("Wb/m^2")
                            self.write.boundary(name, "Magnetic Flux Density 2", b_2)
                            if equation.IsHarmonic:
                                b_2 = obj.Magnetic_im_2.getValueAs("Wb/m^2")
                                self.write.boundary(name, "Magnetic Flux Density 2 im", b_2)

                    if obj.FarField:
                        self.write.boundary(name, "Infinity BC", True)

                self.write.handled(obj)

    def handleMagnetodynamic2DEquation(self, bodies, equation):
        for b in bodies:
            if equation.IsHarmonic and (equation.AngularFrequency == 0):
                raise general_writer.WriteError("The angular frequency must not be zero.\n\n")
            self.write.equation(b, "Name", equation.Name)
            if equation.IsHarmonic:
                frequency = equation.AngularFrequency.getValueAs("Hz")
                self.write.equation(b, "Angular Frequency", frequency)


##  @}