SolverSystem.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

#include "SystemBase.h"
#include "MooseTypes.h"

#include "libmesh/system.h"

#include <string>

class SubProblem;
class FEProblemBase;

namespace SparsityPattern = libMesh::SparsityPattern;

class SolverSystem : public SystemBase
{
public:
  SolverSystem(SubProblem & subproblem,
               FEProblemBase & fe_problem,
               const std::string & name,
               Moose::VarKindType var_kind);
  virtual ~SolverSystem();

  virtual void preInit() override;
  virtual void restoreSolutions() override final;

  void serializeSolution();

  virtual void stopSolve(const ExecFlagType & exec_flag,
                         const std::set<TagID> & vector_tags_to_close) = 0;

  virtual bool converged() = 0;

  virtual bool containsTimeKernel() = 0;

  virtual std::vector<std::string> timeKernelVariableNames() = 0;

  void setSolution(const NumericVector<Number> & soln);

  void setFixedPointRelaxationFactor(const Real relaxation_factor);
  void clearFixedPointRelaxation();
  void saveOldSolutionForFixedPointRelaxation();
  void applyFixedPointRelaxation();

  void setPCSide(MooseEnum pcs);

  Moose::PCSideType getPCSide() { return _pc_side; }

  void setMooseKSPNormType(MooseEnum kspnorm);

  Moose::MooseKSPNormType getMooseKSPNormType() { return _ksp_norm; }

  virtual const NumericVector<Number> * const & currentSolution() const override final;

  virtual void compute(ExecFlagType type) override;

protected:
  void checkInvalidSolution();

  virtual NumericVector<Number> & solutionInternal() const override final;

  virtual bool matrixFromColoring() const { return false; }

  const NumericVector<Number> * _current_solution;

  Moose::PCSideType _pc_side;
  Moose::MooseKSPNormType _ksp_norm;

  bool _solution_is_invalid;

  Real _fixed_point_relaxation_factor = 1.0;
};

inline const NumericVector<Number> * const &
SolverSystem::currentSolution() const
{
  return _current_solution;
}

inline NumericVector<Number> &
SolverSystem::solutionInternal() const
{
  return *system().solution;
}