InversePowerMethod

under construction:Undocumented Class

The InversePowerMethod has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Executioner/InversePowerMethod

Input Parameters

  • bx_normTo evaluate |Bx| for the eigenvalue

    C++ Type:PostprocessorName

    Options:

    Description:To evaluate |Bx| for the eigenvalue

Required Parameters

  • xdiffTo evaluate |x-x_previous| for power iterations

    C++ Type:PostprocessorName

    Options:

    Description:To evaluate |x-x_previous| for power iterations

  • 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

  • pfactor0.01Reduce residual norm per power iteration by this factor

    Default:0.01

    C++ Type:double

    Options:

    Description:Reduce residual norm per power iteration by this factor

  • 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"

  • 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_type -sub_ksp_type -sub_pc_type

    Description:Names of PETSc name/value pairs

  • 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

  • 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.

  • line_searchdefaultSpecifies the line search type (Note: none = basic)

    Default:default

    C++ Type:MooseEnum

    Options:basic bt contact cp default l2 none shell

    Description:Specifies the line search type (Note: none = basic)

  • Chebyshev_acceleration_onTrueIf Chebyshev acceleration is turned on

    Default:True

    C++ Type:bool

    Options:

    Description:If Chebyshev acceleration is turned on

  • 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

  • k01Initial guess of the eigenvalue

    Default:1

    C++ Type:double

    Options:

    Description:Initial guess of the eigenvalue

  • eig_check_tol1e-06Eigenvalue convergence tolerance

    Default:1e-06

    C++ Type:double

    Options:

    Description:Eigenvalue convergence tolerance

  • 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

  • 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).

  • min_power_iterations1Minimum number of power iterations

    Default:1

    C++ Type:unsigned int

    Options:

    Description:Minimum number of power iterations

  • 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

  • sol_check_tol1.79769e+308Convergence tolerance on |x-x_previous| when provided

    Default:1.79769e+308

    C++ Type:double

    Options:

    Description:Convergence tolerance on |x-x_previous| when provided

  • max_power_iterations300The maximum number of power iterations

    Default:300

    C++ Type:unsigned int

    Options:

    Description:The maximum number of power iterations

Optional Parameters

  • no_fe_reinitFalseSpecifies whether or not to reinitialize FEs

    Default:False

    C++ Type:bool

    Options:

    Description:Specifies whether or not to reinitialize FEs

  • 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

  • auto_initializationTrueTrue to ask the solver to set initial

    Default:True

    C++ Type:bool

    Options:

    Description:True to ask the solver to set initial

Advanced Parameters

  • l_abs_step_tol-1Linear Absolute Step Tolerance

    Default:-1

    C++ Type:double

    Options:

    Description:Linear Absolute Step Tolerance

  • nl_abs_tol1e-50Nonlinear Absolute Tolerance

    Default:1e-50

    C++ Type:double

    Options:

    Description:Nonlinear Absolute Tolerance

  • nl_max_its50Max Nonlinear Iterations

    Default:50

    C++ Type:unsigned int

    Options:

    Description:Max Nonlinear Iterations

  • l_max_its10000Max Linear Iterations

    Default:10000

    C++ Type:unsigned int

    Options:

    Description:Max Linear Iterations

  • compute_initial_residual_before_preset_bcsFalseUse the residual norm computed *before* PresetBCs are imposed in relative convergence check

    Default:False

    C++ Type:bool

    Options:

    Description:Use the residual norm computed *before* PresetBCs are imposed in relative convergence check

  • nl_rel_tol1e-08Nonlinear Relative Tolerance

    Default:1e-08

    C++ Type:double

    Options:

    Description:Nonlinear Relative Tolerance

  • l_tol1e-05Linear Tolerance

    Default:1e-05

    C++ Type:double

    Options:

    Description:Linear Tolerance

  • nl_max_funcs10000Max Nonlinear solver function evaluations

    Default:10000

    C++ Type:unsigned int

    Options:

    Description:Max Nonlinear solver function evaluations

  • nl_rel_step_tol1e-50Nonlinear Relative step Tolerance

    Default:1e-50

    C++ Type:double

    Options:

    Description:Nonlinear Relative step Tolerance

  • nl_abs_step_tol1e-50Nonlinear Absolute step Tolerance

    Default:1e-50

    C++ Type:double

    Options:

    Description:Nonlinear Absolute step Tolerance

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

  • output_before_normalizationTrueTrue to output a step before normalization

    Default:True

    C++ Type:bool

    Options:

    Description:True to output a step before normalization

  • normalizationTo evaluate |x| for normalization

    C++ Type:PostprocessorName

    Options:

    Description:To evaluate |x| for normalization

Normalization Parameters

    Restart Parameters

    Input Files

    References