FieldSplitPreconditionerTempl< Base > Class Template Reference

Implements a preconditioner designed to map onto PETSc's PCFieldSplit. More...

#include <FieldSplitPreconditioner.h>

Inheritance diagram for FieldSplitPreconditionerTempl< Base >:

Public Member Functions
	FieldSplitPreconditionerTempl (const InputParameters &parameters)
virtual void	setupDM ()=0
	setup the data management data structure that manages the field split
virtual KSP	getKSP ()=0

Static Public Member Functions
static InputParameters	validParams ()
	Constructor.

Protected Member Functions
virtual const libMesh::DofMapBase &	dofMap () const =0
virtual const libMesh::System &	system () const =0
virtual std::string	prefix () const =0
void	createMooseDM (DM *dm)
	creates the MOOSE data management object

Protected Attributes
NonlinearSystemBase &	_nl
	The nonlinear system this FSP is associated with (convenience reference)
std::string	_decomposition_split
	The decomposition split.

Detailed Description

template<typename Base>
class FieldSplitPreconditionerTempl< Base >

Implements a preconditioner designed to map onto PETSc's PCFieldSplit.

Definition at line 48 of file FieldSplitPreconditioner.h.

Constructor & Destructor Documentation

FieldSplitPreconditionerTempl()

template<typename Base >

FieldSplitPreconditionerTempl< Base >::FieldSplitPreconditionerTempl

(

const InputParameters &

parameters

)

Definition at line 49 of file FieldSplitPreconditioner.C.

  : Base(parameters),
    _nl(this->_fe_problem.getNonlinearSystemBase(this->_nl_sys_num)),
    _decomposition_split(this->template getParam<std::string>("topsplit"))
{
  if (libMesh::default_solver_package() != libMesh::PETSC_SOLVERS)
    mooseError("The field split preconditioner can only be used with PETSc");
 
  // number of variables
  unsigned int n_vars = _nl.nVariables();
  // if we want to construct a full Jacobian?
  // it is recommended to have a full Jacobian for using
  // the fieldSplit preconditioner
  bool full = this->template getParam<bool>("full");
 
  // how variables couple
  std::unique_ptr<CouplingMatrix> cm = std::make_unique<CouplingMatrix>(n_vars);
  if (!full)
  {
    if (this->isParamValid("off_diag_row") && this->isParamValid("off_diag_column"))
    {
 
      const auto off_diag_rows =
          this->template getParam<std::vector<NonlinearVariableName>>("off_diag_row");
      const auto off_diag_columns =
          this->template getParam<std::vector<NonlinearVariableName>>("off_diag_column");
 
      // put 1s on diagonal
      for (unsigned int i = 0; i < n_vars; i++)
        (*cm)(i, i) = 1;
 
      // off-diagonal entries
      std::vector<std::vector<unsigned int>> off_diag(n_vars);
      if (off_diag_rows.size() * off_diag_columns.size() != 0 &&
          off_diag_rows.size() == off_diag_columns.size())
        for (const auto i : index_range(off_diag_rows))
        {
          unsigned int row = _nl.getVariable(0, off_diag_rows[i]).number();
          unsigned int column = _nl.getVariable(0, off_diag_columns[i]).number();
          (*cm)(row, column) = 1;
        }
    }
  }
  else
  {
    for (unsigned int i = 0; i < n_vars; i++)
      for (unsigned int j = 0; j < n_vars; j++)
        (*cm)(i, j) = 1; // full coupling
  }
  this->setCouplingMatrix(std::move(cm));
 
  // turn on a flag
  _nl.useFieldSplitPreconditioner(this);
}

Member Function Documentation

createMooseDM()

template<typename Base >

void FieldSplitPreconditionerTempl< Base >::createMooseDM ( DM *  dm )

protected

creates the MOOSE data management object

Definition at line 107 of file FieldSplitPreconditioner.C.

{
  LibmeshPetscCallA(
      _nl.comm().get(),
      DMCreateMoose(_nl.comm().get(), _nl, dofMap(), system(), _decomposition_split, dm));
  LibmeshPetscCallA(_nl.comm().get(),
                    PetscObjectSetOptionsPrefix((PetscObject)*dm, prefix().c_str()));
  LibmeshPetscCall(DMSetFromOptions(*dm));
  LibmeshPetscCall(DMSetUp(*dm));
}

dofMap()

template<typename Base >

virtual const libMesh::DofMapBase & FieldSplitPreconditionerTempl< Base >::dofMap ( ) const

protectedpure virtual

Returns

The degree of freedom map to use for decomposition

Implemented in FieldSplitPreconditioner, and StaticCondensationFieldSplitPreconditioner.

getKSP()

virtual KSP FieldSplitPreconditionerBase::getKSP ( )

pure virtualinherited

Returns

The KSP object associated with the field split preconditioner

Implemented in FieldSplitPreconditioner, and StaticCondensationFieldSplitPreconditioner.

prefix()

template<typename Base >

virtual std::string FieldSplitPreconditionerTempl< Base >::prefix ( ) const

protectedpure virtual

Returns

The prefix to pass to PETSc for the DM

Implemented in FieldSplitPreconditioner, and StaticCondensationFieldSplitPreconditioner.

setupDM()

virtual void FieldSplitPreconditionerBase::setupDM ( )

pure virtualinherited

setup the data management data structure that manages the field split

Implemented in FieldSplitPreconditioner, and StaticCondensationFieldSplitPreconditioner.

Referenced by NonlinearSystemBase::setupDM().

system()

template<typename Base >

virtual const libMesh::System & FieldSplitPreconditionerTempl< Base >::system ( ) const

protectedpure virtual

Returns

The libMesh system

Implemented in FieldSplitPreconditioner, and StaticCondensationFieldSplitPreconditioner.

validParams()

template<typename Base >

InputParameters FieldSplitPreconditionerTempl< Base >::validParams ( )

static

Constructor.

Initializes SplitBasedPreconditioner data structures

Definition at line 32 of file FieldSplitPreconditioner.C.

{
  InputParameters params = Base::validParams();
  params.addClassDescription("Preconditioner designed to map onto PETSc's PCFieldSplit.");
 
  params.addRequiredParam<std::string>(
      "topsplit", "Entrance to splits, the top split will specify how splits will go.");
  // We should use full coupling Jacobian matrix by default
  params.addParam<bool>("full",
                        true,
                        "Set to true if you want the full set of couplings between variables "
                        "simply for convenience so you don't have to set every off_diag_row "
                        "and off_diag_column combination.");
  return params;
}

Referenced by FieldSplitPreconditioner::validParams(), and StaticCondensationFieldSplitPreconditioner::validParams().

Member Data Documentation

_decomposition_split

template<typename Base >

std::string FieldSplitPreconditionerTempl< Base >::_decomposition_split

protected

The decomposition split.

Definition at line 85 of file FieldSplitPreconditioner.h.

_nl

template<typename Base >

NonlinearSystemBase& FieldSplitPreconditionerTempl< Base >::_nl

protected

The nonlinear system this FSP is associated with (convenience reference)

Definition at line 80 of file FieldSplitPreconditioner.h.

---

The documentation for this class was generated from the following files:

• include/preconditioners/FieldSplitPreconditioner.h
• src/preconditioners/FieldSplitPreconditioner.C