Split

under construction:Undocumented Class

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

Input Parameters

  • schur_typefullType of Schur complement

    Default:full

    C++ Type:MooseEnum

    Description:Type of Schur complement

  • petsc_options_valuePETSc option values for the FieldSplit solver

    C++ Type:std::vector

    Description:PETSc option values for the FieldSplit solver

  • schur_preSType of Schur complement preconditioner matrix

    Default:S

    C++ Type:MooseEnum

    Description:Type of Schur complement preconditioner matrix

  • varsVariables Split operates on (omitting this implies "all variables"

    C++ Type:std::vector

    Description:Variables Split operates on (omitting this implies "all variables"

  • unsidesSidesets Split excludes (omitting this implies "do not exclude any sidesets"

    C++ Type:std::vector

    Description:Sidesets Split excludes (omitting this implies "do not exclude any sidesets"

  • schur_ainvdiagType of approximation to inv(A) used when forming S = D - C inv(A) B

    Default:diag

    C++ Type:MooseEnum

    Description:Type of approximation to inv(A) used when forming S = D - C inv(A) B

  • splittingThe names of the splits (subsystems) in the decomposition of this split

    C++ Type:std::vector

    Description:The names of the splits (subsystems) in the decomposition of this split

  • splitting_typeadditiveSplit decomposition type

    Default:additive

    C++ Type:MooseEnum

    Description:Split decomposition type

  • petsc_optionsPETSc flags for the FieldSplit solver

    C++ Type:MultiMooseEnum

    Description:PETSc flags for the FieldSplit solver

  • blocksMesh blocks Split operates on (omitting this implies "all blocks"

    C++ Type:std::vector

    Description:Mesh blocks Split operates on (omitting this implies "all blocks"

  • petsc_options_inamePETSc option names for the FieldSplit solver

    C++ Type:std::vector

    Description:PETSc option names for the FieldSplit solver

  • sidesSidesets Split operates on (omitting this implies "no sidesets"

    C++ Type:std::vector

    Description:Sidesets Split operates on (omitting this implies "no sidesets"

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.

Advanced Parameters

References