ConvergenceIterationTypes.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 "Convergence.h"
#include "ConvergenceIterationTypeEnum.h"

namespace moose
{
namespace internal
{

class ConvergenceIterationTypeRegistry
{
public:
  const Convergence::IterationType & registerType(const std::string & name);

  static ConvergenceIterationTypeRegistry & getRegistry();

  ConvergenceIterationTypeRegistry(ConvergenceIterationTypeRegistry const &) = delete;
  ConvergenceIterationTypeRegistry & operator=(ConvergenceIterationTypeRegistry const &) = delete;

  ConvergenceIterationTypeRegistry(ConvergenceIterationTypeRegistry &&) = delete;
  ConvergenceIterationTypeRegistry & operator=(ConvergenceIterationTypeRegistry &&) = delete;

private:
  // Private constructor for singleton pattern
  ConvergenceIterationTypeRegistry() {}

  ConvergenceIterationTypeEnum _types;
};

} // internal
} // moose

namespace ConvergenceIterationTypes
{
const Convergence::IterationType & registerType(const std::string & it_type);

const auto NONLINEAR = registerType("NONLINEAR");
const auto LINEAR = registerType("LINEAR");
const auto MULTISYSTEM_FIXED_POINT = registerType("MULTISYSTEM_FIXED_POINT");
const auto MULTIAPP_FIXED_POINT = registerType("MULTIAPP_FIXED_POINT");
const auto STEADY_STATE = registerType("STEADY_STATE");
}