DemagFieldAuxPML

construction:Undocumented Class

The DemagFieldAuxPML has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Converts magnetostatic potential to the vector demagnetization field.

Overview

Example Input File Syntax

Input Parameters

componentAn integer corresponding to the direction the variable this auxkernel acts in. (0 for x, 1 for y, 2 for z)
C++ Type:unsigned int
Controllable:No
Description:An integer corresponding to the direction the variable this auxkernel acts in. (0 for x, 1 for y, 2 for z)
variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to

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
check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
deltapyminus1pole distance
Default:1
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:pole distance
deltasyminus1000scaled thickness of pml region
Default:1000
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:scaled thickness of pml region
deltawyminus1distance to be scaled (dimensionfull
Default:1
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:distance to be scaled (dimensionfull
execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:LINEAR TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, MULTISYSTEM_FIXED_POINT_ITERATION_END, FINAL, CUSTOM, PRE_DISPLACE
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
phi1The internal magnetic potential variable
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The internal magnetic potential variable
potential_H_extThe external magnetic potential variable (disabled for now)
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The external magnetic potential variable (disabled for now)
y0pmlminus-1position at which scaling will start
Default:-1
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:position at which scaling will start

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.
search_methodnearest_node_connected_sidesChoice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
Default:nearest_node_connected_sides
C++ Type:MooseEnum
Options:nearest_node_connected_sides, all_proximate_sides
Controllable:No
Description:Choice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
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

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.

Material Property Retrieval Parameters

Input Files

(test/tests/magnets/slab_PML_small.i)

(test/tests/magnets/slab_PML_small.i)

[GlobalParams]
  mag_x = mag_x
  mag_y = mag_y
  mag_z = mag_z

  potential_H_int = potential_H_int

  g0 = 1.0
  Hscale = 0.004519239
  mu0 = 1.256637e-06
  y0pmlminus = -25
  deltasyminus = 1.0e04
  deltawyminus = 5
  deltapyminus = 0.1
[]

alphadef = 0.02

[Mesh]
  [./mesh]
    type = GeneratedMeshGenerator
    dim = 3
    nx = 25
    ny = 43
    nz = 5
    xmin = -50
    xmax = 50
    ymin = -35
    ymax = 50
    zmin = -10
    zmax = 10
  [../]
  [./infinite_domain]
    type = SubdomainBoundingBoxGenerator
    input = mesh
    bottom_left = '-50 -35 -10'
    top_right = '50 50 10'
    block_id = 3
    block_name = infinite_domain
  [../]
  [./vacuum_box]
    type = SubdomainBoundingBoxGenerator
    input = infinite_domain
    bottom_left = '-50 -25 -10'
    top_right = '50 50 10'
    block_id = 2
    block_name = vacuum
  [../]
  [./boundary1]
    type = SideSetsBetweenSubdomainsGenerator
    input = vacuum_box
    new_boundary = id_boundary
    paired_block = vacuum
    primary_block = 3
  [../]
  [./brick]
    type = SubdomainBoundingBoxGenerator
    input = boundary1
    bottom_left = '-10 -10 -1.5'
    top_right = '10 10 1.5'
    block_id = 1
    block_name = brick
  [../]
[../]

[Materials]

  [./constants]
    type = GenericConstantMaterial
    prop_names = ' alpha           permittivity  Ae        Ms'
    prop_values = '${alphadef}     1.0           1.3e-05   1.2'
    block = '1'
  [../]

 [./a_long]
    type = GenericFunctionMaterial
    prop_names = 'alpha_long'
    prop_values = 'bc_func_1'
    block = '1'
 [../]
 [./constantsv]
    type = GenericConstantMaterial
    prop_names = ' permittivity'
    prop_values = '1.0'
    block = '3 2'
  [../]
[]

[Functions]

  [./bc_func_1]
    type = ParsedFunction
    expression = 'st'
    symbol_names = 'st'
    symbol_values = '1.e1'
  [../]

[]

[Variables]
  [./mag_x]
    order = FIRST
    family = LAGRANGE
    block = '1'
    [./InitialCondition]
      type = RandomConstrainedVectorFieldIC
      phi = azimuth_phi
      theta = polar_theta
      M0s = 1.0
      component  = 0
    [../]
  [../]
  [./mag_y]
    order = FIRST
    family = LAGRANGE
    block = '1'
    [./InitialCondition]
      type = RandomConstrainedVectorFieldIC
      phi = azimuth_phi
      theta = polar_theta
      M0s = 1.0
      component  = 1
    [../]
  [../]
  [./mag_z]
    order = FIRST
    family = LAGRANGE
    block= '1'
    [./InitialCondition]
      type = RandomConstrainedVectorFieldIC
      phi = azimuth_phi
      theta = polar_theta
      M0s = 1.0
      component  = 2
    [../]
  [../]
  [./potential_H_int]
    order = FIRST
    family = LAGRANGE
    block = '1 2'
  [../]
  [./phi2]
   order = FIRST
   family = LAGRANGE
   block = 3
  [../]
[]

[AuxVariables]

  [./azimuth_phi]
    order = FIRST
    family = LAGRANGE
    block = '1'
    [./InitialCondition]
      type = RandomIC
      min = 1.5708
      max = 1.5709
      seed = 2
    [../]
  [../]
  [./polar_theta]
    order = FIRST
    family = LAGRANGE
    block = '1'
    [./InitialCondition]
      type = RandomIC
      min = 1.5708
      max = 1.5709
      seed = 37
    [../]
  [../]

  [./mag_s]
    order = FIRST
    family = LAGRANGE
    block = '1'
  [../]
  [./H_y]
    order = FIRST
    family = MONOMIAL
    block = '1 2'
  [../]
  [./H_y_v]
    order = FIRST
    family = MONOMIAL
    block = '3'
  [../]
[]

[AuxKernels]
  [./mag_mag]
    type = VectorMagnitudeAux
    variable = mag_s
    x = mag_x
    y = mag_y
    z = mag_z
    execute_on = 'initial timestep_end final'
    block = '1'
  [../]
  [./Hy_brick]
    type = DemagFieldAux
    variable = H_y
    component = 1
    block = '1 2'
  [../]
  [./Hy_id]
    type = DemagFieldAuxPML
    phi1 = phi2
    variable = H_y_v
    component = 1
    block = '3'
  [../]
[]

[Kernels]

  [./mag_x_time]
    type = TimeDerivative
    variable = mag_x
    block = '1'
  [../]
  [./mag_y_time]
    type = TimeDerivative
    variable = mag_y
    block = '1'
  [../]
  [./mag_z_time]
    type = TimeDerivative
    variable = mag_z
    block = '1'
  [../]

  [./dllg_x_exch]
    type = MasterExchangeCartLLG
    variable = mag_x
    component = 0
    mag_x = mag_x
    mag_y = mag_y
    mag_z = mag_z
    block = '1'
  [../]
  [./dllg_y_exch]
    type = MasterExchangeCartLLG
    variable = mag_y
    component = 1
    mag_x = mag_x
    mag_y = mag_y
    mag_z = mag_z
    block = '1'
  [../]
  [./dllg_z_exch]
    type = MasterExchangeCartLLG
    variable = mag_z
    component = 2
    mag_x = mag_x
    mag_y = mag_y
    mag_z = mag_z
    block = '1'
  [../]

  [./d_HM_x]
    type = MasterInteractionCartLLG
    variable = mag_x
    component = 0
    block = '1'
  [../]
  [./d_HM_y]
    type = MasterInteractionCartLLG
    variable = mag_y
    component = 1
    block = '1'
  [../]
  [./d_HM_z]
    type = MasterInteractionCartLLG
    variable = mag_z
    component = 2
    block = '1'
  [../]

  [./llb1_x]
    type = MasterLongitudinalLLB
    variable = mag_x
    component = 0
    block = '1'
  [../]
  [./llb1_y]
    type = MasterLongitudinalLLB
    variable = mag_y
    component = 1
    block = '1'
  [../]

  [./llb1_z]
    type = MasterLongitudinalLLB
    variable = mag_z
    component = 2
    block = '1'
  [../]

  [./int_pot_lap]
    type = Electrostatics
    variable = potential_H_int
    block = '1 2'
  [../]
  [./int_bc_pot_lap]
    type = MagHStrongCart
    variable = potential_H_int
    block = '1'
  [../]
  [./infinite_domain]
    type = MagneticPMLCart
    variable = phi2
    component = 1
    block = '3'
  [../]

[]

[InterfaceKernels]
  [./PML_boundary]
    type = InterfaceEquality
    variable = potential_H_int
    boundary = id_boundary
    neighbor_var = potential_H_int
    permittivity_neighbor = 1.
  [../]
[]

[BCs]
  [./vacuum_box]
    type = DirichletBC
    variable = phi2
    value = 0.
    boundary = 'bottom'
  [../]
  [./other_boundaries]
    type = DirichletBC
    variable = potential_H_int
    value = 0.
    boundary = 'left right front back top '
  [../]
  [./boundarydirichlet]
    type = CoupledDirichletBC
    variable = phi2
    coupled_var = potential_H_int
    boundary = id_boundary
  []
[]

[Postprocessors]
   [./dt]
     type = TimestepSize
   [../]

  [./M1]
    type = ElementAverageValue
    variable = mag_s
    execute_on = 'initial timestep_end final'
    block = '1'
  [../]

  [./<mx>]
    type = ElementAverageValue
    variable = mag_x
    execute_on = 'initial timestep_end final'
    block = '1'
  [../]
  [./<my>]
    type = ElementAverageValue
    variable = mag_y
    execute_on = 'initial timestep_end final'
    block = '1'
  [../]
  [./<mz>]
    type = ElementAverageValue
    variable = mag_z
    execute_on = 'initial timestep_end final'
    block = '1'
  [../]

  [./Fexch]
    type = MasterMagneticExchangeEnergy
    energy_scale = 0.001
    execute_on = 'initial timestep_end final'
    block = '1'
  [../]

  [./Fdemag]
    type = MagnetostaticEnergyCart
    energy_scale = 0.001
    execute_on = 'initial timestep_begin timestep_end final'
    block = '1'
  [../]

  [./Fllb1]
    type = MagneticExcessLLBEnergy
    mag_x = mag_x
    mag_y = mag_y
    mag_z = mag_z
    execute_on = 'initial timestep_end final'
    block = '1'
  [../]

  [./Ftot]
    type = LinearCombinationPostprocessor
    pp_names = 'Fexch Fdemag'
    pp_coefs = ' 1.0 1.0'
    execute_on = 'initial timestep_end final'
  [../]

[]

[Preconditioning]

  [./smp]
    type = SMP
    full = true
    petsc_options_iname = ' -ksp_gmres_restart -snes_atol -snes_rtol -ksp_rtol -pc_type -sub_pc_type '
    petsc_options_value = '    100               1e-12      1e-9      1e-8     bjacobi   ilu'
  [../]
[]

[Executioner]
  type = Transient
  solve_type = 'NEWTON'
  automatic_scaling = true

  [./TimeIntegrator]
    type = NewmarkBeta
  [../]

  dtmin = 1.e-5
  dtmax = 1.e-3
  end_time = 2

  [./TimeStepper]
    type = IterationAdaptiveDT
    optimal_iterations = 25
    linear_iteration_ratio = 100
    dt = 1e-4
    growth_factor = 1.1
    cutback_factor = 0.75
  [../]
  num_steps = 2
[../]

[Outputs]
  print_linear_residuals = false
  [pgraph]
  type = PerfGraphOutput
  execute_on = final
  level = 2
[]
  [./out]
    type = Exodus
    file_base = slab_PML_small_25_002
    elemental_as_nodal = true
    time_step_interval = 1
    execute_on = 'initial timestep_end'
  [../]
  [./outCSV]
    type = CSV
    file_base = slab_PML_small_25_002
    time_step_interval = 1
  [../]
[]