NonlinearEigen

under construction:Undocumented Class

The NonlinearEigen 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.


# NonlinearEigen

!syntax description /Executioner/NonlinearEigen

## Overview

!! Replace these lines with information regarding the NonlinearEigen object.

## Example Input File Syntax

!! Describe and include an example of how to use the NonlinearEigen object.

!syntax parameters /Executioner/NonlinearEigen

!syntax inputs /Executioner/NonlinearEigen

!syntax children /Executioner/NonlinearEigen

Executioner for Eigen value problems.

Input Parameters

bx_normTo evaluate |Bx| for the eigenvalue
C++ Type:PostprocessorName
Options:
Description:To evaluate |Bx| for the eigenvalue

Required Parameters

contact_line_search_allowed_lambda_cuts2The number of times lambda is allowed to be cut in half in the contact line search. We recommend this number be roughly bounded by 0 <= allowed_lambda_cuts <= 3
Default:2
C++ Type:unsigned int
Options:
Description:The number of times lambda is allowed to be cut in half in the contact line search. We recommend this number be roughly bounded by 0 <= allowed_lambda_cuts <= 3
contact_line_search_ltolThe linear relative tolerance to be used while the contact state is changing between non-linear iterations. We recommend that this tolerance be looser than the standard linear tolerance
C++ Type:double
Options:
Description:The linear relative tolerance to be used while the contact state is changing between non-linear iterations. We recommend that this tolerance be looser than the standard linear tolerance
free_l_tol0.01Relative linear tolerance in free power iteration
Default:0.01
C++ Type:double
Options:
Description:Relative linear tolerance in free power iteration
free_power_iterations4The number of free power iterations
Default:4
C++ Type:unsigned int
Options:
Description:The number of free power iterations
k01Initial guess of the eigenvalue
Default:1
C++ Type:double
Options:
Description:Initial guess of the eigenvalue
line_searchdefaultSpecifies the line search type (Note: none = basic)
Default:default
C++ Type:MooseEnum
Options:basic bt contact cp default l2 none project shell
Description:Specifies the line search type (Note: none = basic)
line_search_packagepetscThe solver package to use to conduct the line-search
Default:petsc
C++ Type:MooseEnum
Options:petsc moose
Description:The solver package to use to conduct the line-search
max_xfem_update4294967295Maximum number of times to update XFEM crack topology in a step due to evolving cracks
Default:4294967295
C++ Type:unsigned int
Options:
Description:Maximum number of times to update XFEM crack topology in a step due to evolving cracks
mffd_typewpSpecifies the finite differencing type for Jacobian-free solve types. Note that the default is wp (for Walker and Pernice).
Default:wp
C++ Type:MooseEnum
Options:wp ds
Description:Specifies the finite differencing type for Jacobian-free solve types. Note that the default is wp (for Walker and Pernice).
nl_div_tol-1Nonlinear Divergence Tolerance
Default:-1
C++ Type:double
Options:
Description:Nonlinear Divergence Tolerance
output_after_power_iterationsTrueTrue to output solution after free power iterations
Default:True
C++ Type:bool
Options:
Description:True to output solution after free power iterations
petsc_optionsSingleton PETSc options
C++ Type:MultiMooseEnum
Options:-dm_moose_print_embedding -dm_view -ksp_converged_reason -ksp_gmres_modifiedgramschmidt -ksp_monitor -ksp_monitor_snes_lg-snes_ksp_ew -ksp_snes_ew -snes_converged_reason -snes_ksp -snes_ksp_ew -snes_linesearch_monitor -snes_mf -snes_mf_operator -snes_monitor -snes_test_display -snes_view
Description:Singleton PETSc options
petsc_options_inameNames of PETSc name/value pairs
C++ Type:MultiMooseEnum
Options:-ksp_atol -ksp_gmres_restart -ksp_max_it -ksp_pc_side -ksp_rtol -ksp_type -mat_fd_coloring_err -mat_fd_type -mat_mffd_type -pc_asm_overlap -pc_factor_levels -pc_factor_mat_ordering_type -pc_hypre_boomeramg_grid_sweeps_all -pc_hypre_boomeramg_max_iter -pc_hypre_boomeramg_strong_threshold -pc_hypre_type -pc_type -snes_atol -snes_linesearch_type -snes_ls -snes_max_it -snes_rtol -snes_divergence_tolerance -snes_type -sub_ksp_type -sub_pc_type
Description:Names of PETSc name/value pairs
petsc_options_valueValues of PETSc name/value pairs (must correspond with "petsc_options_iname"
C++ Type:std::vector
Options:
Description:Values of PETSc name/value pairs (must correspond with "petsc_options_iname"
skip_exception_checkFalseSpecifies whether or not to skip exception check
Default:False
C++ Type:bool
Options:
Description:Specifies whether or not to skip exception check
solve_typePJFNK: Preconditioned Jacobian-Free Newton Krylov JFNK: Jacobian-Free Newton Krylov NEWTON: Full Newton Solve FD: Use finite differences to compute Jacobian LINEAR: Solving a linear problem
C++ Type:MooseEnum
Options:PJFNK JFNK NEWTON FD LINEAR
Description:PJFNK: Preconditioned Jacobian-Free Newton Krylov JFNK: Jacobian-Free Newton Krylov NEWTON: Full Newton Solve FD: Use finite differences to compute Jacobian LINEAR: Solving a linear problem
splittingTop-level splitting defining a hierarchical decomposition into subsystems to help the solver.
C++ Type:std::vector
Options:
Description:Top-level splitting defining a hierarchical decomposition into subsystems to help the solver.
update_xfem_at_timestep_beginFalseShould XFEM update the mesh at the beginning of the timestep
Default:False
C++ Type:bool
Options:
Description:Should XFEM update the mesh at the beginning of the timestep
verboseFalseSet to true to print additional information
Default:False
C++ Type:bool
Options:
Description:Set to true to print additional information

Optional Parameters

accept_on_max_picard_iterationFalseTrue to treat reaching the maximum number of Picard iterations as converged.
Default:False
C++ Type:bool
Options:
Description:True to treat reaching the maximum number of Picard iterations as converged.
disable_picard_residual_norm_checkFalseDisable the Picard residual norm evaluation thus the three parameters picard_rel_tol, picard_abs_tol and picard_force_norms.
Default:False
C++ Type:bool
Options:
Description:Disable the Picard residual norm evaluation thus the three parameters picard_rel_tol, picard_abs_tol and picard_force_norms.
picard_abs_tol1e-50The absolute nonlinear residual to shoot for during Picard iterations. This check is performed based on the Master app's nonlinear residual.
Default:1e-50
C++ Type:double
Options:
Description:The absolute nonlinear residual to shoot for during Picard iterations. This check is performed based on the Master app's nonlinear residual.
picard_force_normsFalseForce the evaluation of both the TIMESTEP_BEGIN and TIMESTEP_END norms regardless of the existance of active MultiApps with those execute_on flags, default: false.
Default:False
C++ Type:bool
Options:
Description:Force the evaluation of both the TIMESTEP_BEGIN and TIMESTEP_END norms regardless of the existance of active MultiApps with those execute_on flags, default: false.
picard_max_its1Specifies the maximum number of Picard iterations. Mainly used when wanting to do Picard iterations with MultiApps that are set to execute_on timestep_end or timestep_begin. Setting this parameter to 1 turns off the Picard iterations.
Default:1
C++ Type:unsigned int
Options:
Description:Specifies the maximum number of Picard iterations. Mainly used when wanting to do Picard iterations with MultiApps that are set to execute_on timestep_end or timestep_begin. Setting this parameter to 1 turns off the Picard iterations.
picard_rel_tol1e-08The relative nonlinear residual drop to shoot for during Picard iterations. This check is performed based on the Master app's nonlinear residual.
Default:1e-08
C++ Type:double
Options:
Description:The relative nonlinear residual drop to shoot for during Picard iterations. This check is performed based on the Master app's nonlinear residual.
relaxation_factor1Fraction of newly computed value to keep.Set between 0 and 2.
Default:1
C++ Type:double
Options:
Description:Fraction of newly computed value to keep.Set between 0 and 2.
relaxed_variablesList of variables to relax during Picard Iteration
C++ Type:std::vector
Options:
Description:List of variables to relax during Picard Iteration

Picard Parameters

auto_initializationTrueTrue to ask the solver to set initial
Default:True
C++ Type:bool
Options:
Description:True to ask the solver to set initial
control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
time0System time
Default:0
C++ Type:double
Options:
Description:System time

Advanced Parameters

automatic_scalingFalseWhether to use automatic scaling for the variables.
Default:False
C++ Type:bool
Options:
Description:Whether to use automatic scaling for the variables.
compute_initial_residual_before_preset_bcsFalseUse the residual norm computed *before* preset BCs are imposed in relative convergence check
Default:False
C++ Type:bool
Options:
Description:Use the residual norm computed *before* preset BCs are imposed in relative convergence check
compute_scaling_onceTrueWhether the scaling factors should only be computed once at the beginning of the simulation through an extra Jacobian evaluation. If this is set to false, then the scaling factors will be computed during an extra Jacobian evaluation at the beginning of every time step.
Default:True
C++ Type:bool
Options:
Description:Whether the scaling factors should only be computed once at the beginning of the simulation through an extra Jacobian evaluation. If this is set to false, then the scaling factors will be computed during an extra Jacobian evaluation at the beginning of every time step.
l_abs_tol1e-50Linear Absolute Tolerance
Default:1e-50
C++ Type:double
Options:
Description:Linear Absolute Tolerance
l_max_its10000Max Linear Iterations
Default:10000
C++ Type:unsigned int
Options:
Description:Max Linear Iterations
l_tol0.01Linear Tolerance
Default:0.01
C++ Type:double
Options:
Description:Linear Tolerance
nl_abs_step_tol1e-50Nonlinear Absolute step Tolerance
Default:1e-50
C++ Type:double
Options:
Description:Nonlinear Absolute step Tolerance
nl_abs_tol1e-06Nonlinear Absolute Tolerance
Default:1e-06
C++ Type:double
Options:
Description:Nonlinear Absolute Tolerance
nl_max_funcs10000Max Nonlinear solver function evaluations
Default:10000
C++ Type:unsigned int
Options:
Description:Max Nonlinear solver function evaluations
nl_max_its50Max Nonlinear Iterations
Default:50
C++ Type:unsigned int
Options:
Description:Max Nonlinear Iterations
nl_rel_step_tol1e-50Nonlinear Relative step Tolerance
Default:1e-50
C++ Type:double
Options:
Description:Nonlinear Relative step Tolerance
nl_rel_tol1e-50Nonlinear Relative Tolerance
Default:1e-50
C++ Type:double
Options:
Description:Nonlinear Relative Tolerance
num_grids1The number of grids to use for a grid sequencing algorithm. This includes the final grid, so num_grids = 1 indicates just one solve in a time-step
Default:1
C++ Type:unsigned int
Options:
Description:The number of grids to use for a grid sequencing algorithm. This includes the final grid, so num_grids = 1 indicates just one solve in a time-step
snesmf_reuse_baseTrueSpecifies whether or not to reuse the base vector for matrix-free calculation
Default:True
C++ Type:bool
Options:
Description:Specifies whether or not to reuse the base vector for matrix-free calculation

Solver Parameters

normal_factorNormalize x to make |x| equal to this factor
C++ Type:double
Options:
Description:Normalize x to make |x| equal to this factor
normalizationTo evaluate |x| for normalization
C++ Type:PostprocessorName
Options:
Description:To evaluate |x| for normalization
output_before_normalizationTrueTrue to output a step before normalization
Default:True
C++ Type:bool
Options:
Description:True to output a step before normalization

Normalization Parameters

Restart Parameters

Input Files

test/tests/executioners/eigen_executioners/ne_mat.i
test/tests/executioners/eigen_executioners/ne_coupled.i
test/tests/executioners/eigen_executioners/ne.i
test/tests/executioners/eigen_executioners/ane.i
test/tests/executioners/eigen_executioners/ne_deficient_b.i

test/tests/executioners/eigen_executioners/ne_mat.i

[Mesh]
 type = GeneratedMesh
 dim = 2
 xmin = 0
 xmax = 10
 ymin = 0
 ymax = 10
 elem_type = QUAD4
 nx = 8
 ny = 8

 uniform_refine = 0
[]

# the minimum eigenvalue of this problem is 2*(PI/a)^2;
# Its inverse is 0.5*(a/PI)^2 = 5.0660591821169. Here a is equal to 10.

[Variables]
  active = 'u'

  [./u]
    # second order is way better than first order
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Kernels]
  active = 'diff rhs'

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./rhs]
    type = MaterialEigenKernel
    variable = u
    mat = varmat
  [../]
[]

[Materials]
  [./var_mat]
    type = VarCouplingMaterialEigen
    block = 0
    var = u
    material_prop_name = varmat
  [../]
[]

[BCs]
  active = 'homogeneous'

  [./homogeneous]
    type = DirichletBC
    variable = u
    preset = false
    boundary = '0 1 2 3'
    value = 0
  [../]
[]

[Executioner]
  type = NonlinearEigen

  bx_norm = 'unorm'
  normalization = 'unorm'
  normal_factor = 9.990012561844

  free_power_iterations = 2
  nl_abs_tol = 1e-12
  nl_rel_tol = 1e-50
  k0 = 1.0

  #Preconditioned JFNK (default)
  solve_type = 'PJFNK'
[]

[Postprocessors]
  active = 'unorm udiff'

  [./unorm]
    type = ElementIntegralVariablePostprocessor
    variable = u
    # execute on residual is important for nonlinear eigen solver!
    execute_on = linear
  [../]

  [./udiff]
    type = ElementL2Diff
    variable = u
  [../]
[]

[Outputs]
  execute_on = 'timestep_end'
  file_base = ne_mat
  exodus = true
[]

test/tests/executioners/eigen_executioners/ne_coupled.i

[Mesh]
 type = GeneratedMesh
 dim = 2
 xmin = 0
 xmax = 10
 ymin = 0
 ymax = 10
 elem_type = QUAD4
 nx = 8
 ny = 8

 uniform_refine = 0
[]

[Variables]
  [./u]
    order = FIRST
    family = LAGRANGE
  [../]

  [./T]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[AuxVariables]
  [./power]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Kernels]
  [./diff]
    type = DiffMKernel
    variable = u
    mat_prop = diffusion
    offset = 0.0
  [../]

  [./rhs]
    type = MassEigenKernel
    variable = u
  [../]

  [./diff_T]
    type = Diffusion
    variable = T
  [../]
  [./src_T]
    type = CoupledForce
    variable = T
    v = power
  [../]
[]

[AuxKernels]
  [./power_ak]
    type = NormalizationAux
    variable = power
    source_variable = u
    normalization = unorm

# this coefficient will affect the eigenvalue.
    normal_factor = 10


    execute_on = linear
  [../]
[]

[BCs]
  [./homogeneous]
    type = DirichletBC
    variable = u
    boundary = '0 1 2 3'
    value = 0
  [../]

  [./homogeneousT]
    type = DirichletBC
    variable = T
    boundary = '0 1 2 3'
    value = 0
  [../]
[]

[Materials]
  [./dc]
    type = VarCouplingMaterial
    var = T
    block = 0
    base = 1.0
    coef = 1.0
  [../]
[]

[Executioner]
  type = NonlinearEigen

  bx_norm = 'unorm'

  free_power_iterations = 2
  nl_abs_tol = 1e-12
  nl_rel_tol = 1e-50
  k0 = 1.0
  output_after_power_iterations = false

  #Preconditioned JFNK (default)
  solve_type = 'PJFNK'
[]

[Postprocessors]
  active = 'unorm udiff'

  [./unorm]
    type = ElementIntegralVariablePostprocessor
    variable = u
    # execute on residual is important for nonlinear eigen solver!
    execute_on = linear
  [../]

  [./udiff]
    type = ElementL2Diff
    variable = u
    outputs = console
  [../]
[]

[Outputs]
  execute_on = 'timestep_end'
  file_base = ne_coupled
  exodus = true
[]

test/tests/executioners/eigen_executioners/ne.i

[Mesh]
 type = GeneratedMesh
 dim = 2
 xmin = 0
 xmax = 10
 ymin = 0
 ymax = 10
 elem_type = QUAD4
 nx = 8
 ny = 8

 uniform_refine = 0
[]

# the minimum eigenvalue of this problem is 2*(PI/a)^2;
# Its inverse is 0.5*(a/PI)^2 = 5.0660591821169. Here a is equal to 10.

[Variables]
  active = 'u'

  [./u]
    # second order is way better than first order
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Kernels]
  active = 'diff rhs'

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./rhs]
    type = MassEigenKernel
    variable = u
  [../]
[]

[BCs]
  active = 'homogeneous'

  [./homogeneous]
    type = DirichletBC
    variable = u
    preset = false
    boundary = '0 1 2 3'
    value = 0
  [../]
[]

[Executioner]
  type = NonlinearEigen

  bx_norm = 'unorm'
  normalization = 'unorm'
  normal_factor = 9.990012561844

  free_power_iterations = 2
  nl_abs_tol = 1e-12
  nl_rel_tol = 1e-50
  k0 = 1.0

  #Preconditioned JFNK (default)
  solve_type = 'PJFNK'
[]

[Preconditioning]
  [./smp]
    type = SMP
    full = true
  [../]
[]

[Postprocessors]
  active = 'unorm udiff'

  [./unorm]
    type = ElementIntegralVariablePostprocessor
    variable = u
    # execute on residual is important for nonlinear eigen solver!
    execute_on = linear
  [../]

  [./udiff]
    type = ElementL2Diff
    variable = u
  [../]
[]

[Outputs]
  execute_on = 'timestep_end'
  file_base = ne
  exodus = true
[]

test/tests/executioners/eigen_executioners/ane.i

[Mesh]
 type = GeneratedMesh
 dim = 2
 xmin = 0
 xmax = 10
 ymin = 0
 ymax = 10
 elem_type = QUAD4
 nx = 8
 ny = 8

 uniform_refine = 0
[]

# the minimum eigenvalue is (2*PI*(p-1)^(1/p)/a/p/sin(PI/p))^p;
# Its inverse is 35.349726539758187. Here a is equal to 10.

[Variables]
  active = 'u'

  [./u]
    # second order is way better than first order
    order = FIRST
    family = LAGRANGE
  [../]
[]

[ICs]
  [./uic]
    type = RandomIC
    variable = u
  [../]
[]

[Kernels]
  active = 'diff rhs'

  [./diff]
    type = PHarmonic
    variable = u
    p = 3
  [../]

  [./rhs]
    type = PMassEigenKernel
    variable = u
    p = 3
  [../]
[]

[BCs]
  active = 'homogeneous'

  [./homogeneous]
    type = DirichletBC
    variable = u
    boundary = '0 2'
    value = 0
  [../]
[]

[Executioner]
  type = NonlinearEigen

  bx_norm = 'unorm'

  free_power_iterations = 10
  nl_abs_tol = 1e-12
  nl_rel_tol = 1e-50
  k0 = 1.0
# important: constant initial value set by auto_initilization does not
# converge to the fundamental mode
  auto_initialization = false
  output_after_power_iterations = false

  #Preconditioned JFNK (default)
  solve_type = 'PJFNK'
  l_max_its = 100
[]

[Postprocessors]
  active = 'unorm udiff'

  [./unorm]
    type = ElementIntegralVariablePostprocessor
    variable = u
    # execute on residual is important for nonlinear eigen solver!
    execute_on = linear
  [../]

  [./udiff]
    type = ElementL2Diff
    variable = u
    outputs = console
  [../]
[]

[Outputs]
  execute_on = 'timestep_end'
  file_base = ane
  exodus = true
[]

test/tests/executioners/eigen_executioners/ne_deficient_b.i

[Mesh]
 type = GeneratedMesh
 dim = 2
 xmin = 0
 xmax = 10
 ymin = 0
 ymax = 10
 elem_type = QUAD4
 nx = 8
 ny = 8

 uniform_refine = 0
[]

[Variables]
  [./u]
    order = FIRST
    family = LAGRANGE
  [../]
  [./v]
    order = FIRST
    family = LAGRANGE
    eigen = true
  [../]
[]

[Kernels]
  [./diff_u]
    type = Diffusion
    variable = u
  [../]
  [./diff_v]
    type = Diffusion
    variable = v
  [../]

  [./rhs]
    type = CoupledEigenKernel
    variable = u
    v = v
  [../]
  [./src_v]
    type = CoupledForce
    variable = v
    v = u
  [../]
[]

[BCs]
  [./homogeneous_u]
    type = DirichletBC
    variable = u
    boundary = '0 1 2 3'
    value = 0
  [../]
  [./homogeneous_v]
    type = DirichletBC
    variable = v
    boundary = '0 1 2 3'
    value = 0
  [../]
[]

[Executioner]
  type = NonlinearEigen

  bx_norm = 'vnorm'

  free_power_iterations = 2
  nl_abs_tol = 1e-12
  nl_rel_tol = 1e-50
  k0 = 1.0
  output_after_power_iterations = false

  #Preconditioned JFNK (default)
  solve_type = 'PJFNK'
[]

[Postprocessors]
  [./vnorm]
    type = ElementIntegralVariablePostprocessor
    variable = v
    # execute on residual is important for nonlinear eigen solver!
    execute_on = linear
  [../]

  [./udiff]
    type = ElementL2Diff
    variable = u
    outputs = console
  [../]
[]

[Outputs]
  execute_on = 'timestep_end'
  file_base = ne_deficient_b
  exodus = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools