moose::internal::ConvergenceIterationTypeRegistry Class Reference

Registry for Convergence iteration types. More...

#include <ConvergenceIterationTypes.h>

Public Member Functions
const Convergence::IterationType &	registerType (const std::string &name)
	Registers a Convergence iteration type.
	ConvergenceIterationTypeRegistry (ConvergenceIterationTypeRegistry const &)=delete
	Don't allow creation through copy/move construction or assignment.
ConvergenceIterationTypeRegistry &	operator= (ConvergenceIterationTypeRegistry const &)=delete
	ConvergenceIterationTypeRegistry (ConvergenceIterationTypeRegistry &&)=delete
ConvergenceIterationTypeRegistry &	operator= (ConvergenceIterationTypeRegistry &&)=delete

Static Public Member Functions
static ConvergenceIterationTypeRegistry &	getRegistry ()
	Return Singleton instance.

Private Member Functions
	ConvergenceIterationTypeRegistry ()

Private Attributes
ConvergenceIterationTypeEnum	_types
	The registered types.

Detailed Description

Registry for Convergence iteration types.

Definition at line 23 of file ConvergenceIterationTypes.h.

Constructor & Destructor Documentation

ConvergenceIterationTypeRegistry() [1/3]

moose::internal::ConvergenceIterationTypeRegistry::ConvergenceIterationTypeRegistry ( ConvergenceIterationTypeRegistry const &  )

delete

Don't allow creation through copy/move construction or assignment.

ConvergenceIterationTypeRegistry() [2/3]

moose::internal::ConvergenceIterationTypeRegistry::ConvergenceIterationTypeRegistry ( ConvergenceIterationTypeRegistry &&  )

delete

ConvergenceIterationTypeRegistry() [3/3]

moose::internal::ConvergenceIterationTypeRegistry::ConvergenceIterationTypeRegistry ( )

inlineprivate

Definition at line 45 of file ConvergenceIterationTypes.h.

{}

Member Function Documentation

getRegistry()

ConvergenceIterationTypeRegistry & moose::internal::ConvergenceIterationTypeRegistry::getRegistry ( )

static

Return Singleton instance.

Definition at line 19 of file ConvergenceIterationTypes.C.

{
  static ConvergenceIterationTypeRegistry conv_iter_type_registry;
  return conv_iter_type_registry;
}

Referenced by ConvergenceIterationTypes::registerType().

operator=() [1/2]

ConvergenceIterationTypeRegistry & moose::internal::ConvergenceIterationTypeRegistry::operator= ( ConvergenceIterationTypeRegistry &&  )

delete

operator=() [2/2]

ConvergenceIterationTypeRegistry & moose::internal::ConvergenceIterationTypeRegistry::operator= ( ConvergenceIterationTypeRegistry const &  )

delete

registerType()

const Convergence::IterationType & moose::internal::ConvergenceIterationTypeRegistry::registerType

(

const std::string &

name

)

Registers a Convergence iteration type.

Parameters

name	The name of the Convergence iteration type

Definition at line 26 of file ConvergenceIterationTypes.C.

{
  const auto name_upper = MooseUtils::toUpper(name);
 
  const auto type_iter = _types.find(name_upper);
  if (type_iter != _types.items().end())
  {
    // Assume that this is not a duplicate name, but a "double registration" due
    // to the dynamic load functionality.
    return *type_iter;
  }
  else
    return _types.addConvergenceIterationType(name_upper);
}

Referenced by ConvergenceIterationTypes::registerType().

Member Data Documentation

_types

ConvergenceIterationTypeEnum moose::internal::ConvergenceIterationTypeRegistry::_types

private

The registered types.

Definition at line 48 of file ConvergenceIterationTypes.h.

Referenced by registerType().

---

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

• include/convergence/ConvergenceIterationTypes.h
• src/convergence/ConvergenceIterationTypes.C