ContactSplit

Description

The ContactSplit class is used to create a split-based preconditioner for contact problems. The idea is to separate the DOFs on the contact interface from the DOFs in the rest of the domain. This allows users to apply different preconditioners for each DOF type. As a common practice, a direct preconditioner (e.g., LU) is often utilized for the interface problem, where the problem size is relatively small while the condition number is large. An iterative preconditioner (e.g., boomeramg) is often employed for the interior problem, where the problem is often better conditioned while the problem size is usually large.

Split-based preconditioner that partitions the domain into DOFs directly involved in contact (on contact surfaces) and those that are not

Example Input Syntax

[Preconditioning]
  [./FSP]
    type = FSP
    # It is the starting point of splitting
    topsplit = 'contact_interior' # 'contact_interior' should match the following block name
    [./contact_interior]
      splitting = 'contact interior'
      splitting_type = multiplicative
    [../]
    [./interior]
      type = ContactSplit
      vars = 'disp_x disp_y disp_z'
      uncontact_primary = '3'
      uncontact_secondary = '2'
      uncontact_displaced = '1'
      blocks = '1 2'
      include_all_contact_nodes = 1
      petsc_options_iname = '-ksp_type -ksp_max_it -ksp_rtol -ksp_gmres_restart -pc_type -pc_hypre_type -pc_hypre_boomeramg_max_iter -pc_hypre_strong_threshold'
      petsc_options_value = ' preonly 10 1e-4 201                hypre    boomeramg      1                            0.25'
    [../]
    [./contact]
      type = ContactSplit
      vars = 'disp_x disp_y disp_z'
      contact_primary = '3'
      contact_secondary = '2'
      contact_displaced = '1'
      include_all_contact_nodes = 1
      petsc_options_iname = '-ksp_type -ksp_max_it -pc_type -pc_asm_overlap -sub_pc_type   -pc_factor_levels'
      petsc_options_value = '  preonly 10 asm  1 lu 0'
    [../]
  [../]
[]

Input Parameters

include_all_contact_nodesFalseWhether to include all nodes on the contact surfaces
Default:False
C++ Type:bool
Controllable:No
Description:Whether to include all nodes on the contact surfaces

Required Parameters

blocksMesh blocks Split operates on (omitting this implies "all blocks"
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:Mesh blocks Split operates on (omitting this implies "all blocks"
contact_displacedList of indicators whether displaced mesh is used to define included contact
C++ Type:std::vector<int>
Controllable:No
Description:List of indicators whether displaced mesh is used to define included contact
contact_primaryPrimary surface list for included contacts
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:Primary surface list for included contacts
contact_secondarySecondary surface list for included contacts
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:Secondary surface list for included contacts
petsc_optionsPETSc flags for the FieldSplit solver
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
Controllable:No
Description:PETSc flags for the FieldSplit solver
petsc_options_inamePETSc option names for the FieldSplit solver
C++ Type:std::vector<std::string>
Controllable:No
Description:PETSc option names for the FieldSplit solver
petsc_options_valuePETSc option values for the FieldSplit solver
C++ Type:std::vector<std::string>
Controllable:No
Description:PETSc option values for the FieldSplit solver
schur_ainvdiagType of approximation to inv(A) used when forming S = D - C inv(A) B
Default:diag
C++ Type:MooseEnum
Options:diag, lump
Controllable:No
Description:Type of approximation to inv(A) used when forming S = D - C inv(A) B
schur_preSType of Schur complement preconditioner matrix
Default:S
C++ Type:MooseEnum
Options:S, Sp, A11
Controllable:No
Description:Type of Schur complement preconditioner matrix
schur_typefullType of Schur complement
Default:full
C++ Type:MooseEnum
Options:full, upper, lower
Controllable:No
Description:Type of Schur complement
sidesSidesets Split operates on (omitting this implies "no sidesets"
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:Sidesets Split operates on (omitting this implies "no sidesets"
splittingThe names of the splits (subsystems) in the decomposition of this split
C++ Type:std::vector<std::string>
Controllable:No
Description:The names of the splits (subsystems) in the decomposition of this split
splitting_typeadditiveSplit decomposition type
Default:additive
C++ Type:MooseEnum
Options:additive, multiplicative, symmetric_multiplicative, schur
Controllable:No
Description:Split decomposition type
uncontact_displacedList of indicators whether displaced mesh is used to define excluded contact
C++ Type:std::vector<int>
Controllable:No
Description:List of indicators whether displaced mesh is used to define excluded contact
uncontact_primaryPrimary surface list for excluded contacts
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:Primary surface list for excluded contacts
uncontact_secondarySecondary surface list for excluded contacts
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:Secondary surface list for excluded contacts
unsidesSidesets Split excludes (omitting this implies "do not exclude any sidesets"
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:Sidesets Split excludes (omitting this implies "do not exclude any sidesets"
varsVariables Split operates on (omitting this implies "all variables"
C++ Type:std::vector<NonlinearVariableName>
Controllable:No
Description:Variables Split operates on (omitting this implies "all variables"

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

(modules/contact/test/tests/fieldsplit/2blocks3d.i)
(modules/contact/test/tests/fieldsplit/frictional_mortar_FS.i)

(modules/contact/test/tests/fieldsplit/2blocks3d.i)

[GlobalParams]
  displacements = 'disp_x disp_y disp_z'
  volumetric_locking_correction = true
[]

[Mesh]
  file = 2blocks3d.e
  patch_size = 5
[]

[Problem]
  error_on_jacobian_nonzero_reallocation = true
[]

[Modules/TensorMechanics/Master]
  [./all]
    strain = FINITE
    incremental = true
    add_variables = true
  [../]
[]

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

[Functions]
  [./horizontal_movement]
    type = ParsedFunction
    value = t/10.0
  [../]
[]

[AuxKernels]
  [./penetration]
    type = PenetrationAux
    variable = penetration
    boundary = 2
    paired_boundary = 3
    order = FIRST
  [../]
[]

[BCs]
  [./push_x]
    type = FunctionDirichletBC
    variable = disp_x
    boundary = 1
    function = horizontal_movement
  [../]
  [./fix_x]
    type = DirichletBC
    variable = disp_x
    boundary = 4
    value = 0.0
  [../]
  [./fix_y]
    type = DirichletBC
    variable = disp_y
    boundary = '1 4'
    value = 0.0
  [../]
  [./fix_z]
    type = DirichletBC
    variable = disp_z
    boundary = '1 4'
    value = 0.0
  [../]
[]

[Materials]
  [./elasticity_tensor_left]
    type = ComputeIsotropicElasticityTensor
    block = 1
    youngs_modulus = 1.0e6
    poissons_ratio = 0.3
  [../]
  [./stress_left]
    type = ComputeFiniteStrainElasticStress
    block = 1
  [../]

  [./elasticity_tensor_right]
    type = ComputeIsotropicElasticityTensor
    block = 2
    youngs_modulus = 1.0e6
    poissons_ratio = 0.3
  [../]
  [./stress_right]
    type = ComputeFiniteStrainElasticStress
    block = 2
  [../]
[]

[Contact]
  [./leftright]
    secondary = 2
    primary = 3
    model = frictionless
    penalty = 1e+6
    normalize_penalty = true
    formulation = kinematic
    normal_smoothing_distance = 0.1
  [../]
[]

[Preconditioning]
  [./FSP]
    type = FSP
    # It is the starting point of splitting
    topsplit = 'contact_interior' # 'contact_interior' should match the following block name
    [./contact_interior]
      splitting          = 'contact interior'
      splitting_type     = multiplicative
    [../]
    [./interior]
      type = ContactSplit
      vars = 'disp_x disp_y disp_z'
      uncontact_primary   = '3'
      uncontact_secondary    = '2'
      uncontact_displaced = '1'
      blocks              = '1 2'
      include_all_contact_nodes = 1
      petsc_options_iname = '-ksp_type -ksp_max_it -ksp_rtol -ksp_gmres_restart -pc_type -pc_hypre_type -pc_hypre_boomeramg_max_iter -pc_hypre_strong_threshold'
      petsc_options_value = ' preonly 10 1e-4 201                hypre    boomeramg      1                            0.25'
    [../]
    [./contact]
      type = ContactSplit
      vars = 'disp_x disp_y disp_z'
      contact_primary   = '3'
      contact_secondary    = '2'
      contact_displaced = '1'
      include_all_contact_nodes = 1
      petsc_options_iname = '-ksp_type -ksp_max_it -pc_type -pc_asm_overlap -sub_pc_type   -pc_factor_levels'
      petsc_options_value = '  preonly 10 asm  1 lu 0'
    [../]
  [../]
[]

[Executioner]
  type = Transient
  solve_type = 'PJFNK'

  dt = 0.1
  dtmin = 0.1
  end_time = 0.1

  l_tol = 1e-4
  l_max_its = 100

  nl_rel_tol = 1e-10
  nl_abs_tol = 1e-6
  nl_max_its = 100
[]

[Outputs]
  file_base = 2blocks3d_out
  [./exodus]
    type = Exodus
  [../]
  [./console]
    type = Console
    max_rows = 5
  [../]
[]

(modules/contact/test/tests/fieldsplit/2blocks3d.i)

[GlobalParams]
  displacements = 'disp_x disp_y disp_z'
  volumetric_locking_correction = true
[]

[Mesh]
  file = 2blocks3d.e
  patch_size = 5
[]

[Problem]
  error_on_jacobian_nonzero_reallocation = true
[]

[Modules/TensorMechanics/Master]
  [./all]
    strain = FINITE
    incremental = true
    add_variables = true
  [../]
[]

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

[Functions]
  [./horizontal_movement]
    type = ParsedFunction
    value = t/10.0
  [../]
[]

[AuxKernels]
  [./penetration]
    type = PenetrationAux
    variable = penetration
    boundary = 2
    paired_boundary = 3
    order = FIRST
  [../]
[]

[BCs]
  [./push_x]
    type = FunctionDirichletBC
    variable = disp_x
    boundary = 1
    function = horizontal_movement
  [../]
  [./fix_x]
    type = DirichletBC
    variable = disp_x
    boundary = 4
    value = 0.0
  [../]
  [./fix_y]
    type = DirichletBC
    variable = disp_y
    boundary = '1 4'
    value = 0.0
  [../]
  [./fix_z]
    type = DirichletBC
    variable = disp_z
    boundary = '1 4'
    value = 0.0
  [../]
[]

[Materials]
  [./elasticity_tensor_left]
    type = ComputeIsotropicElasticityTensor
    block = 1
    youngs_modulus = 1.0e6
    poissons_ratio = 0.3
  [../]
  [./stress_left]
    type = ComputeFiniteStrainElasticStress
    block = 1
  [../]

  [./elasticity_tensor_right]
    type = ComputeIsotropicElasticityTensor
    block = 2
    youngs_modulus = 1.0e6
    poissons_ratio = 0.3
  [../]
  [./stress_right]
    type = ComputeFiniteStrainElasticStress
    block = 2
  [../]
[]

[Contact]
  [./leftright]
    secondary = 2
    primary = 3
    model = frictionless
    penalty = 1e+6
    normalize_penalty = true
    formulation = kinematic
    normal_smoothing_distance = 0.1
  [../]
[]

[Preconditioning]
  [./FSP]
    type = FSP
    # It is the starting point of splitting
    topsplit = 'contact_interior' # 'contact_interior' should match the following block name
    [./contact_interior]
      splitting          = 'contact interior'
      splitting_type     = multiplicative
    [../]
    [./interior]
      type = ContactSplit
      vars = 'disp_x disp_y disp_z'
      uncontact_primary   = '3'
      uncontact_secondary    = '2'
      uncontact_displaced = '1'
      blocks              = '1 2'
      include_all_contact_nodes = 1
      petsc_options_iname = '-ksp_type -ksp_max_it -ksp_rtol -ksp_gmres_restart -pc_type -pc_hypre_type -pc_hypre_boomeramg_max_iter -pc_hypre_strong_threshold'
      petsc_options_value = ' preonly 10 1e-4 201                hypre    boomeramg      1                            0.25'
    [../]
    [./contact]
      type = ContactSplit
      vars = 'disp_x disp_y disp_z'
      contact_primary   = '3'
      contact_secondary    = '2'
      contact_displaced = '1'
      include_all_contact_nodes = 1
      petsc_options_iname = '-ksp_type -ksp_max_it -pc_type -pc_asm_overlap -sub_pc_type   -pc_factor_levels'
      petsc_options_value = '  preonly 10 asm  1 lu 0'
    [../]
  [../]
[]

[Executioner]
  type = Transient
  solve_type = 'PJFNK'

  dt = 0.1
  dtmin = 0.1
  end_time = 0.1

  l_tol = 1e-4
  l_max_its = 100

  nl_rel_tol = 1e-10
  nl_abs_tol = 1e-6
  nl_max_its = 100
[]

[Outputs]
  file_base = 2blocks3d_out
  [./exodus]
    type = Exodus
  [../]
  [./console]
    type = Console
    max_rows = 5
  [../]
[]

(modules/contact/test/tests/fieldsplit/frictional_mortar_FS.i)

offset = 0.021

vy = 0.15
vx = 0.04

refine = 1

[GlobalParams]
  displacements = 'disp_x disp_y'
  volumetric_locking_correction = true
[]

[Mesh]
  [original_file_mesh]
    type = FileMeshGenerator
    file = long_short_blocks.e
  []
  uniform_refine = ${refine}
[]

[Modules/TensorMechanics/Master]
  [all]
    strain = FINITE
    incremental = true
    add_variables = true
    block = '1 2'
  []
[]

[Functions]
  [horizontal_movement]
    type = ParsedFunction
    value = 'if(t<0.5,${vx}*t-${offset},${vx}-${offset})'
  []
  [vertical_movement]
    type = ParsedFunction
    value = 'if(t<0.5,${offset},${vy}*(t-0.5)+${offset})'
  []
[]

[BCs]
  [push_left_x]
    type = FunctionDirichletBC
    variable = disp_x
    boundary = 30
    function = horizontal_movement
  []
  [fix_right_x]
    type = DirichletBC
    variable = disp_x
    boundary = 40
    value = 0.0
  []
  [fix_right_y]
    type = DirichletBC
    variable = disp_y
    boundary = '40'
    value = 0.0
  []
  [push_left_y]
    type = FunctionDirichletBC
    variable = disp_y
    boundary = '30'
    function = vertical_movement
  []
[]

[Materials]
  [elasticity_tensor_left]
    type = ComputeIsotropicElasticityTensor
    block = 1
    youngs_modulus = 1.0e6
    poissons_ratio = 0.3
  []
  [stress_left]
    type = ComputeFiniteStrainElasticStress
    block = 1
  []

  [elasticity_tensor_right]
    type = ComputeIsotropicElasticityTensor
    block = 2
    youngs_modulus = 1.0e6
    poissons_ratio = 0.3
  []
  [stress_right]
    type = ComputeFiniteStrainElasticStress
    block = 2
  []
[]

[Contact]
  [leftright]
    secondary = 10
    primary = 20
    model = coulomb
    formulation = mortar
    friction_coefficient = 0.2
    c_normal = 1e0
  []
[]

[ICs]
  [disp_y]
    block = 1
    variable = disp_y
    value = ${offset}
    type = ConstantIC
  []
  [disp_x]
    block = 1
    variable = disp_x
    value = -${offset}
    type = ConstantIC
  []
[]

[Preconditioning]
  [FSP]
    type = FSP
    # It is the starting point of splitting
    topsplit = 'contact_interior' # 'contact_interior' should match the following block name
    [contact_interior]
      splitting = 'contact interior'
      splitting_type = multiplicative
    []
    [interior]
      type = ContactSplit
      vars = 'disp_x disp_y'
      uncontact_primary = '20'
      uncontact_secondary = '10'
      uncontact_displaced = '30'
      blocks = '1 2'
      include_all_contact_nodes = 1

      petsc_options_iname = '-ksp_type -pc_type -pc_hypre_type '
      petsc_options_value = '  preonly hypre  boomeramg'
    []
    [contact]
      type = ContactSplit
      vars = 'disp_x disp_y leftright_normal_lm leftright_tangential_lm'
      contact_primary = '20'
      contact_secondary = '10'
      contact_displaced = '30'
      include_all_contact_nodes = 1
      blocks = '4'

      petsc_options_iname = '-ksp_type -pc_sub_type -pc_factor_shift_type  -pc_factor_shift_amount'
      petsc_options_value = '  preonly lu NONZERO 1e-15'
    []
  []
[]

[Executioner]
  type = Transient
  solve_type = 'NEWTON'

  dt = 0.1
  dtmin = 1e-4
  end_time = 1

  l_tol = 1e-8
  l_max_its = 100

  nl_rel_tol = 1e-8
  nl_abs_tol = 1e-8
  nl_max_its = 10
[]

[Outputs]
  file_base = frictional_mortar_FS_out
  [exodus]
    type = Exodus
  []
  [console]
    type = Console
    max_rows = 5
  []
[]

Description
Example Input Syntax
Input Parameters
Input Files

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access