ADConductionCurrent.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "ADConductionCurrent.h"
#include "ElectromagneticEnums.h"
#include "ElectromagneticConstants.h"
#include <complex>

registerMooseObject("ElectromagneticsApp", ADConductionCurrent);

InputParameters
ADConductionCurrent::validParams()
{
  InputParameters params = ADVectorKernel::validParams();
  params.addClassDescription(
      "Calculates the current source term in the Helmholtz wave equation using "
      "the conduction formulation of the current.");
  params.addRequiredCoupledVar("E_real", "The real component of the electric field.");
  params.deprecateParam("E_real", "field_real", "10/01/2025");
  params.addRequiredCoupledVar("field_real", "The real component of the electric field.");
  params.addRequiredCoupledVar("E_imag", "The imaginary component of the electric field.");
  params.deprecateParam("E_imag", "field_imag", "10/01/2025");
  params.addRequiredCoupledVar("field_imag", "The imaginary component of the electric field.");

  params.addParam<MaterialPropertyName>(
      "conductivity_real", 1.0, "The real component of the material conductivity.");
  params.addParam<MaterialPropertyName>(
      "conductivity_imag", 0.0, "The imaginary component of the material conductivity.");

  params.addParam<MaterialPropertyName>(
      "ang_freq_real", "ang_freq", "The real component of the angular drive frequency.");
  params.addParam<MaterialPropertyName>(
      "ang_freq_imag", 0.0, "The imaginary component of the angular drive frequency.");

  params.addParam<MaterialPropertyName>(
      "permeability_real", "mu_vacuum", "The real component of the material permeability.");
  params.addParam<MaterialPropertyName>(
      "permeability_imag", 0.0, "The imaginary component of the material permeability.");

  MooseEnum component("real imaginary");
  params.addParam<MooseEnum>("component", component, "Component of field (real or imaginary).");
  return params;
}

ADConductionCurrent::ADConductionCurrent(const InputParameters & parameters)
  : ADVectorKernel(parameters),
    _field_real(adCoupledVectorValue("field_real")),
    _field_imag(adCoupledVectorValue("field_imag")),

    _cond_real(getADMaterialProperty<Real>("conductivity_real")),
    _cond_imag(getADMaterialProperty<Real>("conductivity_imag")),

    _omega_real(getADMaterialProperty<Real>("ang_freq_real")),
    _omega_imag(getADMaterialProperty<Real>("ang_freq_imag")),

    _mu_real(getADMaterialProperty<Real>("permeability_real")),
    _mu_imag(getADMaterialProperty<Real>("permeability_imag")),

    _component(getParam<MooseEnum>("component"))
{
}

ADReal
ADConductionCurrent::computeQpResidual()
{
  // TODO: In the future, need to add an AD capability to std::complex
  ADReal mu_omega_real = _mu_real[_qp] * _omega_real[_qp] - _mu_imag[_qp] * _omega_imag[_qp];
  ADReal mu_omega_imag = _mu_real[_qp] * _omega_imag[_qp] + _mu_imag[_qp] * _omega_real[_qp];

  ADRealVectorValue sigma_field_real =
      _cond_real[_qp] * _field_real[_qp] - _cond_imag[_qp] * _field_imag[_qp];
  ADRealVectorValue sigma_field_imag =
      _cond_imag[_qp] * _field_real[_qp] + _cond_real[_qp] * _field_imag[_qp];

  if (_component == EM::REAL)
  {
    return _test[_i][_qp] * -1.0 *
           (mu_omega_imag * sigma_field_real + mu_omega_real * sigma_field_imag);
  }
  else
  {
    return _test[_i][_qp] * (mu_omega_real * sigma_field_real - mu_omega_imag * sigma_field_imag);
  }
}