WaveEquationCoefficient

Material for use as coefficient (where a is a scalar coefficient) in standard-form Helmholtz wave equation applications with derivatives calculated using automatic differentiation.

Overview

This object provides a ready-to-use coefficient for the electric field Helmholtz wave equation problem, specifically a coefficient material property of the form

where

  • is the complex wave number ( where is the wavelength),

  • is the complex relative electric permittivity, and

  • is the complex relative magnetic permeability.

Note that all of these parameters (real and imaginary parts) can be provided by the user as material properties.

Example Input File Syntax

[wave_equation_coefficient]
  type = WaveEquationCoefficient
  k_real = k_real_mat
  k_imag = k_imag_mat
  eps_rel_real = 1
  eps_rel_imag = 0
  mu_rel_real = 1
  mu_rel_imag = 0
[]
(../moose/modules/electromagnetics/test/tests/kernels/scalar_complex_helmholtz/scalar_complex_helmholtz.i)

Input Parameters

  • eps_rel_imagRelative permittivity, imaginary component.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Relative permittivity, imaginary component.

  • eps_rel_realRelative permittivity, real component.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Relative permittivity, real component.

  • k_realWave number, real component.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Wave number, real component.

  • mu_rel_imagRelative permeability, imaginary component.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Relative permeability, imaginary component.

  • mu_rel_realRelative permeability, real component.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Relative permeability, real component.

Required Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • coef1Real-valued function coefficient.

    Default:1

    C++ Type:double

    Controllable:No

    Description:Real-valued function coefficient.

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

  • k_imag0Wave number, imaginary component.

    Default:0

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:Wave number, imaginary component.

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • prop_name_imaginarywave_equation_coefficient_imaginaryUser-specified material property name for the imaginary component.

    Default:wave_equation_coefficient_imaginary

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:User-specified material property name for the imaginary component.

  • prop_name_realwave_equation_coefficient_realUser-specified material property name for the real component.

    Default:wave_equation_coefficient_real

    C++ Type:MaterialPropertyName

    Controllable:No

    Description:User-specified material property name for the real component.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters