Preconditioning System

Overview

See Steady for more details on how preconditioning is used in solving nonlinear systems in MOOSE. The Preconditioning block allows you to define which type of preconditioning matrix to build and what process to apply. You can define multiple blocks with different names, allowing you to quickly switch out preconditioning options. Within the sub-blocks you can also provide other options specific to that type of preconditioning matrix. You can also override PETSc options here. Only one block can be active at a time.

Default Preconditioning Matrix

Consider the fully coupled system of equations:

var element = document.getElementById("moose-equation-3a860cc1-9158-44fc-bf97-ce5a4675ddd7");katex.render("\\begin{aligned} \\nabla \\cdot k(s,T) \\nabla T &= 0 \\\\ \\nabla \\cdot D(s,T) \\nabla s &= 0 , \\end{aligned},", element, {displayMode:true,throwOnError:false});

the fully coupled Jacobian is then approximated using a block-diagonal approach:

var element = document.getElementById("moose-equation-1b520261-73d9-49bd-811f-6ab35019494b");katex.render("\\boldsymbol{R}'(s,T) = \\begin{bmatrix} (\\boldsymbol{R}_T)_T & (\\boldsymbol{R}_T)_s \\\\ (\\boldsymbol{R}_s)_T & (\\boldsymbol{R}_s)_s \\end{bmatrix} \\approx \\begin{bmatrix} (\\boldsymbol{R}_T)_T & \\boldsymbol{0} \\\\ \\boldsymbol{0} & (\\boldsymbol{R}_s)_s \\end{bmatrix} .", element, {displayMode:true,throwOnError:false});

Thus, for this example, the default preconditioning matrix is defined as:

var element = document.getElementById("moose-equation-1c9d3789-9938-4b10-8be0-58a1e8239e5d");katex.render("\\boldsymbol{M} \\equiv \\begin{bmatrix} (k(s,T) \\nabla \\phi_j, \\nabla \\psi_i) & \\boldsymbol{0} \\\\ \\boldsymbol{0} & (D(s,T) \\nabla \\phi_j, \\nabla\\psi_i) \\end{bmatrix} \\approx \\boldsymbol{R}'(s,T) .", element, {displayMode:true,throwOnError:false});

Example Input File Syntax

A single preconditioner may be specified as below:

[Preconditioning]
  [my_prec]
    type = SMP
    # SMP Options Go Here!
    # Override PETSc Options Here!
  []
[]

Nested preconditioners may be specified as below, for the FSP for example:

[Preconditioning]
  active = 'FSP'

  [./FSP]
    type = FSP
    # It is the starting point of splitting
    topsplit = 'uv' # 'uv' should match the following block name
    [./uv]
      splitting = 'u v' # 'u' and 'v' are the names of subsolvers
      # Generally speaking, there are four types of splitting we could choose
      # <additive,multiplicative,symmetric_multiplicative,schur>
      splitting_type = additive
      # An approximate solution to the original system
      # | A_uu  A_uv | | u | _ |f_u|
      # |  0    A_vv | | v | - |f_v|
      #  is obtained by solving the following subsystems
      #  A_uu u = f_u and A_vv v = f_v
      # If splitting type is specified as schur, we may also want to set more options to
      # control how schur works using PETSc options
      # petsc_options_iname = '-pc_fieldsplit_schur_fact_type -pc_fieldsplit_schur_precondition'
      # petsc_options_value = 'full selfp'
    [../]
    [./u]
      vars = 'u'
      # PETSc options for this subsolver
      # A prefix will be applied, so just put the options for this subsolver only
      petsc_options_iname = '-pc_type -ksp_type'
      petsc_options_value = '     hypre preonly'
    [../]
    [./v]
      vars = 'v'
      # PETSc options for this subsolver
      petsc_options_iname = '-pc_type -ksp_type'
      petsc_options_value = '     hypre  preonly'
    [../]
  [../]
[]

Available Objects

Moose App
SplitField split based preconditioner for nonlinear solver.
FDPFinite difference preconditioner (FDP) builds a numerical Jacobian for preconditioning, only use for testing and verification.
FSPPreconditioner designed to map onto PETSc's PCFieldSplit.
PBPPhysics-based preconditioner (PBP) allows individual physics to have their own preconditioner.
SMPSingle matrix preconditioner (SMP) builds a preconditioner using user defined off-diagonal parts of the Jacobian.
VCPVarialble condensation preconditioner (VCP) condenses out specified variable(s) from the Jacobian matrix and produces a system of equations with less unkowns to be solved by the underlying preconditioners.

Available Actions

Moose App
SetupPreconditionerActionAdd a Preconditioner object to the simulation.
AddFieldSplitActionAdd a Split object to the simulation.

(moose/test/tests/preconditioners/fsp/fsp_test.i)

[Mesh]
  [./square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  [../]
[]

[Variables]
  active = 'u v'

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

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

[Kernels]
  active = 'diff_u conv_v diff_v'

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

  [./conv_v]
    type = CoupledForce
    variable = v
    v = u
  [../]

  [./diff_v]
    type = Diffusion
    variable = v
  [../]
[]

[BCs]
  active = 'left_u right_u left_v'

  [./left_u]
    type = DirichletBC
    variable = u
    boundary = 3
    value = 0
  [../]

  [./right_u]
    type = DirichletBC
    variable = u
    boundary = 1
    value = 100
  [../]

  [./left_v]
    type = DirichletBC
    variable = v
    boundary = 3
    value = 0
  [../]

  [./right_v]
    type = DirichletBC
    variable = v
    boundary = 1
    value = 0
  [../]
[]

[Executioner]
  type = Steady

  # This is setup automatically in MOOSE (SetupPBPAction.C)
  # petsc_options = '-snes_mf_operator'
  # petsc_options_iname = '-pc_type'
  # petsc_options_value =  'asm'
[]

[Preconditioning]
  active = 'FSP'

  [./FSP]
    type = FSP
    # It is the starting point of splitting
    topsplit = 'uv' # 'uv' should match the following block name
    [./uv]
      splitting = 'u v' # 'u' and 'v' are the names of subsolvers
      # Generally speaking, there are four types of splitting we could choose
      # <additive,multiplicative,symmetric_multiplicative,schur>
      splitting_type  = additive
      # An approximate solution to the original system
      # | A_uu  A_uv | | u | _ |f_u|
      # |  0    A_vv | | v | - |f_v|
      #  is obtained by solving the following subsystems
      #  A_uu u = f_u and A_vv v = f_v
      # If splitting type is specified as schur, we may also want to set more options to
      # control how schur works using PETSc options
      # petsc_options_iname = '-pc_fieldsplit_schur_fact_type -pc_fieldsplit_schur_precondition'
      # petsc_options_value = 'full selfp'
    [../]
    [./u]
      vars = 'u'
      # PETSc options for this subsolver
      # A prefix will be applied, so just put the options for this subsolver only
      petsc_options_iname = '-pc_type -ksp_type'
      petsc_options_value = '     hypre preonly'
    [../]
    [./v]
      vars = 'v'
      # PETSc options for this subsolver
      petsc_options_iname = '-pc_type -ksp_type'
      petsc_options_value = '     hypre  preonly'
    [../]
  [../]
[]

[Outputs]
  file_base = out
  exodus = true
[]

Overview
Default Preconditioning Matrix
Example Input File Syntax
Available Objects
Available Actions