- 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
- complex_electric_fieldThe complex component of the electric field vector for the time-harmonic formulation.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The complex component of the electric field vector for the time-harmonic formulation.
- 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
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
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.
- electric_fieldThe electric field vector or electrostatic potential scalar to produce the field.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The electric field vector or electrostatic potential scalar to produce the field.
- electric_field_heating_nameelectric_field_heatingUser-specified material property name for the Joule heating.
Default:electric_field_heating
C++ Type:std::string
Controllable:No
Description:User-specified material property name for the Joule heating.
- electric_field_material_nameelectric_fieldUser-specified material property name for the field.
Default:electric_field
C++ Type:std::string
Controllable:No
Description:User-specified material property name for the field.
- electrical_conductivityelectrical_conductivityMaterial property providing electrical conductivity of the material.
Default:electrical_conductivity
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:Material property providing electrical conductivity of the material.
- formulationtimeThe domain formulation of the Joule heating, time or frequency (default = time).
Default:time
C++ Type:MooseEnum
Controllable:No
Description:The domain formulation of the Joule heating, time or frequency (default = time).
- heating_scaling1Coefficient to multiply by heating term.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Coefficient to multiply by heating term.
- solverelectrostaticElectrostatic or electromagnetic field solver (default = electrostatic).
Default:electrostatic
C++ Type:MooseEnum
Controllable:No
Description:Electrostatic or electromagnetic field solver (default = electrostatic).
ElectromagneticHeatingMaterial
Material class used to provide the electric field as a material property and computes the residual contributions for electromagnetic/electrostatic heating objects.
Overview
ElectromagneticHeatingMaterial provides the electric field and residual contributions of electromagnetic/electrostatic heating objects as material properties. In particular, ElectromagneticHeatingMaterial provides the residuals for ADJouleHeatingSource and JouleHeatingHeatGeneratedAux within the heat transfer module.
For the formulation of the electric field, users defined the "solver" parameter as:
ELECTROMAGNETIC: where the electric field can be supplied by the electromagnetic module
ELECTROSTATIC: where the user provides an electrostatic potential and the electric field () is defined as , where is the electrostatic potential
For the formulation of the residuals, users defined the "formulation" parameter as:
TIME: where the electric field is assumed to be derived from the time dependent Maxwell's equations
FREQUENCY: where the electric field is assumed to be derived from the frequency dependent Maxwell's equations. When using the frequency domain, the electric field is assumed to have a real and complex component.
The equations for the residual formulations can be found in ADJouleHeatingSource.
Example Input File Syntax
An electrostatic example of how to use ElectromagneticHeatingMaterial can be found in the heat transfer module test transient_ad_jouleheating.i.
[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
[ElectromagneticMaterial]
type = ElectromagneticHeatingMaterial<<<{"description": "Material class used to provide the electric field as a material property and computes the residual contributions for electromagnetic/electrostatic heating objects.", "href": "ElectromagneticHeatingMaterial.html"}>>>
electric_field<<<{"description": "The electric field vector or electrostatic potential scalar to produce the field."}>>> = elec
electric_field_heating_name<<<{"description": "User-specified material property name for the Joule heating."}>>> = electric_field_heating
electrical_conductivity<<<{"description": "Material property providing electrical conductivity of the material."}>>> = electrical_conductivity
formulation<<<{"description": "The domain formulation of the Joule heating, time or frequency (default = time)."}>>> = 'time'
solver<<<{"description": "Electrostatic or electromagnetic field solver (default = electrostatic)."}>>> = 'electrostatic'
[]
[]An electromagnetic example of how to use ElectromagneticHeatingMaterial can be found in the combined module test aux_microwave_heating.i.
[Materials<<<{"href": "../../syntax/Materials/index.html"}>>>]
[ElectromagneticMaterial]
type = ElectromagneticHeatingMaterial<<<{"description": "Material class used to provide the electric field as a material property and computes the residual contributions for electromagnetic/electrostatic heating objects.", "href": "ElectromagneticHeatingMaterial.html"}>>>
electric_field<<<{"description": "The electric field vector or electrostatic potential scalar to produce the field."}>>> = E_real
complex_electric_field<<<{"description": "The complex component of the electric field vector for the time-harmonic formulation."}>>> = E_imag
electric_field_heating_name<<<{"description": "User-specified material property name for the Joule heating."}>>> = electric_field_heating
electrical_conductivity<<<{"description": "Material property providing electrical conductivity of the material."}>>> = cond_real
formulation<<<{"description": "The domain formulation of the Joule heating, time or frequency (default = time)."}>>> = FREQUENCY
solver<<<{"description": "Electrostatic or electromagnetic field solver (default = electrostatic)."}>>> = ELECTROMAGNETIC
[]
[]Input 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
- 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
Unit:(no unit assumed)
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.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.