The place where all sections with solution invalid warnings will be stored. More...

#include <SolutionInvalidityRegistry.h>

Inheritance diagram for moose::internal::SolutionInvalidityRegistry:

Public Member Functions
InvalidSolutionID	registerInvalidity (const std::string &object_type, const std::string &message, const bool warning)
	Call to register an invalid calculation.

std::size_t	size () const

std::size_t	id (const SolutionInvalidityName &key) const

bool	keyExists (const SolutionInvalidityName &key) const

bool	idExists (const std::size_t id) const

const SolutionInvalidityInfo &	item (const std::size_t id) const

Protected Member Functions
const SolutionInvalidityInfo &	itemNonLocking (const std::size_t id) const

std::size_t	registerItem (const SolutionInvalidityName &key, CreateItem &create_item)
	Registers an item with key `key` if said key does not exist.

Protected Attributes
const std::string	_name
	The name of this registry; used in error handling.

std::unordered_map< SolutionInvalidityName, std::size_t, SoltionInvalidityNameHash >	_key_to_id
	Map of keys to IDs.

std::deque< SolutionInvalidityInfo >	_id_to_item
	Vector of IDs to Items.

std::mutex	_key_to_id_mutex
	Mutex for locking access to _key_to_id NOTE: These can be changed to shared_mutexes once we get C++17.

std::mutex	_id_to_item_mutex
	Mutex for locking access to _id_to_item NOTE: These can be changed to shared_mutexes once we get C++17.

Private Member Functions
	SolutionInvalidityRegistry ()

Private Attributes
friend	SolutionInvalidity
	This is only here so that SolutionInvalidity can access readSectionInfo.

Friends
SolutionInvalidityRegistry &	getSolutionInvalidityRegistry ()
	So it can be constructed.

Detailed Description

The place where all sections with solution invalid warnings will be stored.

Definition at line 91 of file SolutionInvalidityRegistry.h.

Constructor & Destructor Documentation

◆ SolutionInvalidityRegistry()

moose::internal::SolutionInvalidityRegistry::SolutionInvalidityRegistry ( )

private

Definition at line 26 of file SolutionInvalidityRegistry.C.

  : GeneralRegistry<SolutionInvalidityName, SolutionInvalidityInfo, SoltionInvalidityNameHash>(
        "SolutionInvalidityRegistry")
{
}

Member Function Documentation

◆ id()

std::size_t GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::id ( const SolutionInvalidityName & key ) const

inherited

Returns: The ID assocated with the key key

Definition at line 32 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_key_to_id_mutex);
  const auto it = _key_to_id.find(key);
  if (it == _key_to_id.end())
    mooseError(_name, ": Key '", key, "' is not registered");
  return it->second;
}

◆ idExists()

bool GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::idExists ( const std::size_t id ) const

inherited

Returns: Whether or not the id id is registered

Definition at line 41 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_id_to_item_mutex);
  return id < _id_to_item.size();
}

◆ item()

const SolutionInvalidityInfo & GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::item ( const std::size_t id ) const

inherited

Returns: The item associated with the key key (thread safe)

Definition at line 46 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_id_to_item_mutex);
  return itemNonLocking(id);
}

◆ itemNonLocking()

const SolutionInvalidityInfo & GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::itemNonLocking ( const std::size_t id ) const

protectedinherited

Returns: The item associated with the key key (not thread safe)

Definition at line 52 of file GeneralRegistry.h.

{
  if (id >= _id_to_item.size())
    mooseError(_name, ": ID '", id, "' is not registered");
  return _id_to_item[id];
}

◆ keyExists()

bool GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::keyExists ( const SolutionInvalidityName & key ) const

inherited

Returns: Whether or not the key key is registered

Definition at line 37 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_key_to_id_mutex);
  return _key_to_id.count(key);
}

◆ registerInvalidity()

InvalidSolutionID moose::internal::SolutionInvalidityRegistry::registerInvalidity	(	const std::string &	object_type,
		const std::string &	message,
		const bool	warning
	)

Call to register an invalid calculation.

Parameters

object_type	The type of the object doing the registration
message	The description of the solution invalid warning
warning	Whether or not it is a warning

Returns: The registered ID

Definition at line 33 of file SolutionInvalidityRegistry.C.

{
  const SolutionInvalidityName name(object_type, message);
  if (keyExists(name))
    mooseAssert(item(id(name)).warning == warning, "Inconsistent registration for a warning");
  const auto create_item = [&object_type, &message, &warning](const std::size_t id)
  { return SolutionInvalidityInfo(object_type, message, id, warning); };
  return registerItem(name, create_item);
}

Referenced by SolutionInvalidInterface::registerInvalidSolutionInternal(), and SolutionInvalidity::syncIteration().

◆ registerItem()

std::size_t GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::registerItem	(	const SolutionInvalidityName &	key,
		CreateItem &	create_item
	)

protectedinherited

Registers an item with key key if said key does not exist.

Parameters

key	The key
create_item	Lambda called to create an item if the key does not exist. Takes a single argument std::size_t which is the

new ID and should return an Item

Returns: The ID of the item

Definition at line 64 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock_key(_key_to_id_mutex);
 
  // Is it already registered?
  const auto it = _key_to_id.find(key);
  if (it != _key_to_id.end())
    return it->second;
 
  // It's not registered
  std::lock_guard<std::mutex> lock_id(_id_to_item_mutex);
  const auto id = _id_to_item.size();
  _key_to_id.emplace(key, id);
  _id_to_item.emplace_back(std::move(create_item(id)));
  return id;
}

◆ size()

std::size_t GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::size ( ) const

inherited

Returns: The number of registered items

Definition at line 27 of file GeneralRegistry.h.

{
  std::lock_guard<std::mutex> lock(_id_to_item_mutex);
  return _id_to_item.size();
}

Friends And Related Symbol Documentation

◆ getSolutionInvalidityRegistry

SolutionInvalidityRegistry & getSolutionInvalidityRegistry ( )

friend

So it can be constructed.

Definition at line 18 of file SolutionInvalidityRegistry.C.

{
  // In C++11 this is even thread safe! (Lookup "Static Initializers")
  static SolutionInvalidityRegistry solution_invalid_registry_singleton;
 
  return solution_invalid_registry_singleton;
}

Member Data Documentation

◆ _id_to_item

std::deque<SolutionInvalidityInfo > GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::_id_to_item

protectedinherited

Vector of IDs to Items.

Definition at line 72 of file GeneralRegistry.h.

◆ _id_to_item_mutex

std::mutex GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::_id_to_item_mutex

mutableprotectedinherited

Mutex for locking access to _id_to_item NOTE: These can be changed to shared_mutexes once we get C++17.

Definition at line 79 of file GeneralRegistry.h.

◆ _key_to_id

std::unordered_map<SolutionInvalidityName , std::size_t, SoltionInvalidityNameHash > GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::_key_to_id

protectedinherited

Map of keys to IDs.

Definition at line 70 of file GeneralRegistry.h.

◆ _key_to_id_mutex

std::mutex GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::_key_to_id_mutex

mutableprotectedinherited

Mutex for locking access to _key_to_id NOTE: These can be changed to shared_mutexes once we get C++17.

Definition at line 76 of file GeneralRegistry.h.

◆ _name

const std::string GeneralRegistry< SolutionInvalidityName , SolutionInvalidityInfo , SoltionInvalidityNameHash >::_name

protectedinherited

The name of this registry; used in error handling.

Definition at line 67 of file GeneralRegistry.h.

◆ SolutionInvalidity

friend moose::internal::SolutionInvalidityRegistry::SolutionInvalidity

private

This is only here so that SolutionInvalidity can access readSectionInfo.

Definition at line 114 of file SolutionInvalidityRegistry.h.

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

include/utils/SolutionInvalidityRegistry.h
src/utils/SolutionInvalidityRegistry.C

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SolutionInvalidityRegistry()

Member Function Documentation

◆ id()

◆ idExists()

◆ item()

◆ itemNonLocking()

◆ keyExists()

◆ registerInvalidity()

◆ registerItem()

new ID and should return an Item

◆ size()

Friends And Related Symbol Documentation

◆ getSolutionInvalidityRegistry

Member Data Documentation

◆ _id_to_item

◆ _id_to_item_mutex

◆ _key_to_id

◆ _key_to_id_mutex

◆ _name

◆ SolutionInvalidity