Split

construction:Undocumented Class

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


# Split

!syntax description /Preconditioning/Split

## Overview

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

## Example Input File Syntax

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

!syntax parameters /Preconditioning/Split

!syntax inputs /Preconditioning/Split

!syntax children /Preconditioning/Split

Field split based preconditioner for nonlinear solver.

Input Parameters

blocksMesh blocks Split operates on (omitting this implies "all blocks"
C++ Type:std::vector<SubdomainName>
Options:
Description:Mesh blocks Split operates on (omitting this implies "all blocks"
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
Description:PETSc flags for the FieldSplit solver
petsc_options_inamePETSc option names for the FieldSplit solver
C++ Type:std::vector<std::string>
Options:
Description:PETSc option names for the FieldSplit solver
petsc_options_valuePETSc option values for the FieldSplit solver
C++ Type:std::vector<std::string>
Options:
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
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
Description:Type of Schur complement preconditioner matrix
schur_typefullType of Schur complement
Default:full
C++ Type:MooseEnum
Options:full, upper, lower
Description:Type of Schur complement
sidesSidesets Split operates on (omitting this implies "no sidesets"
C++ Type:std::vector<BoundaryName>
Options:
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>
Options:
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
Description:Split decomposition type
unsidesSidesets Split excludes (omitting this implies "do not exclude any sidesets"
C++ Type:std::vector<BoundaryName>
Options:
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>
Options:
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>
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

Child Objects

(modules/contact/include/splits/ContactSplit.h)

(modules/contact/include/splits/ContactSplit.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "Split.h"

/**
 * Split-based preconditioner for contact problems.
 */
class ContactSplit : public Split
{
public:
  static InputParameters validParams();

  ContactSplit(const InputParameters & params);
  virtual void setup(const std::string & prefix = "-") override;

#if defined(LIBMESH_HAVE_PETSC) && !PETSC_VERSION_LESS_THAN(3, 3, 0)
protected:
  std::vector<std::string> _contact_primary;
  std::vector<std::string> _contact_secondary;
  std::vector<int> _contact_displaced;
  std::vector<std::string> _uncontact_primary;
  std::vector<std::string> _uncontact_secondary;
  std::vector<int> _uncontact_displaced;
  bool _include_all_contact_nodes;
#endif // defined(LIBMESH_HAVE_PETSC) && !PETSC_VERSION_LESS_THAN(3,3,0)
};

Input Parameters
Child Objects

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

Split

Input Parameters

Optional Parameters

Advanced Parameters

Child Objects