Convergence.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 "MooseObject.h"
#include "SetupInterface.h"
#include "PostprocessorInterface.h"
#include "PerfGraphInterface.h"
#include "TransientInterface.h"

class Convergence : public MooseObject,
                    public SetupInterface,
                    public PostprocessorInterface,
                    public PerfGraphInterface,
                    public TransientInterface
{
public:
  static InputParameters validParams();

  enum class MooseConvergenceStatus
  {
    ITERATING = 0,
    CONVERGED = 1,
    DIVERGED = -1
  };

  using IterationType = MooseEnumItem;

  Convergence(const InputParameters & parameters);

  virtual void initialSetup() override {}

  virtual void checkIterationType(IterationType /*it_type*/) const {}

  virtual void initialize() {}

  virtual void preExecute() {}

  virtual MooseConvergenceStatus checkConvergence(unsigned int n_iter) = 0;

  bool verbose() const { return _verbose; }

protected:
  void verboseOutput(std::ostringstream & oss);

  PerfID _perfid_check_convergence;

  THREAD_ID _tid;

private:
  const bool _verbose;
};