Application Usage link

Physics and Syntax

Application Development link

Framework Development link

MOOSEDocs link

Infrastructure

Questions

Information and Tools

PBP

under construction:Undocumented Class

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


# PBP

!syntax description /Preconditioning/PBP

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Preconditioning/PBP

!syntax inputs /Preconditioning/PBP

!syntax children /Preconditioning/PBP

!syntax description /Preconditioning/PBP

Input Parameters

  • preconditionerTODO: docstring

    C++ Type:std::vector

    Options:

    Description:TODO: docstring

  • solve_orderThe order the block rows will be solved in. Put the name of variables here to stand for solving that variable's block row. A variable may appear more than once (to create cylces if you like).

    C++ Type:std::vector

    Options:

    Description:The order the block rows will be solved in. Put the name of variables here to stand for solving that variable's block row. A variable may appear more than once (to create cylces if you like).

Required Parameters

  • ksp_normunpreconditionedSets the norm that is used for convergence testing

    Default:unpreconditioned

    C++ Type:MooseEnum

    Options:none preconditioned unpreconditioned natural default

    Description:Sets the norm that is used for convergence testing

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

  • off_diag_columnThe off diagonal column you want to add into the matrix, it will be associated with an off diagonal row from the same position in off_diag_row.

    C++ Type:std::vector

    Options:

    Description:The off diagonal column you want to add into the matrix, it will be associated with an off diagonal row from the same position in off_diag_row.

  • off_diag_rowThe off diagonal row you want to add into the matrix, it will be associated with an off diagonal column from the same position in off_diag_colum.

    C++ Type:std::vector

    Options:

    Description:The off diagonal row you want to add into the matrix, it will be associated with an off diagonal column from the same position in off_diag_colum.

  • pc_sidedefaultPreconditioning side

    Default:default

    C++ Type:MooseEnum

    Options:left right symmetric default

    Description:Preconditioning side

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

  • 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

Optional Parameters

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

Advanced Parameters