- preconditionerTODO: docstring
C++ Type:std::vector
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
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).
PBP
under construction:Undocumented Class
The PBP 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 /Preconditioning/PBP
Input Parameters
- petsc_options_valueValues of PETSc name/value pairs (must correspond with "petsc_options_iname"
C++ Type:std::vector
Description:Values of PETSc name/value pairs (must correspond with "petsc_options_iname"
- 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
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.
- 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
Description:Specifies the finite differencing type for Jacobian-free solve types. Note that the default is wp (for Walker and Pernice).
- pc_sidedefaultPreconditioning side
Default:default
C++ Type:MooseEnum
Description:Preconditioning side
- 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
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.
- ksp_normunpreconditionedSets the norm that is used for convergence testing
Default:unpreconditioned
C++ Type:MooseEnum
Description:Sets the norm that is used for convergence testing
- 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
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
- petsc_optionsSingleton PETSc options
C++ Type:MultiMooseEnum
Description:Singleton PETSc options
- petsc_options_inameNames of PETSc name/value pairs
C++ Type:MultiMooseEnum
Description:Names of PETSc name/value pairs
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.