Split.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* 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 "MooseEnum.h"
#include "MooseObject.h"
#include "PetscSupport.h"
#include "Restartable.h"
 
// Forward declarations
class FEProblemBase;
class NonlinearSystemBase;
 
class Split : public MooseObject, public Restartable
{
public:
  static InputParameters validParams();
 
  Split(const InputParameters & parameters);
  virtual ~Split() = default;
 
  virtual void setup(NonlinearSystemBase & nl, const std::string & prefix = "");
 
  const std::vector<NonlinearVariableName> & getVars() const { return _vars; }
 
  const std::vector<SubdomainName> & getBlocks() const { return _blocks; }
 
  virtual bool restrictsRegion() const
  {
    return !_blocks.empty() || !_sides.empty() || !_unsides.empty();
  }
 
protected:
  enum SplittingType
  {
    SplittingTypeAdditive,
    SplittingTypeMultiplicative,
    SplittingTypeSymmetricMultiplicative,
    SplittingTypeSchur
  };
 
  FEProblemBase & _fe_problem;
 
  std::vector<NonlinearVariableName> _vars;
 
  std::vector<SubdomainName> _blocks;
  std::vector<BoundaryName> _sides;
  std::vector<BoundaryName> _unsides;
 
  std::vector<std::string> _splitting;
 
  MooseEnum _splitting_type;
  MooseEnum _schur_type;
  MooseEnum _schur_pre;
};