SolutionInvalidityRegistry.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 "GeneralRegistry.h"
#include "MooseTypes.h"
#include "MooseHashing.h"

#include <mutex>

// Forward Declarations
class SolutionInvalidity;
void dataStore(std::ostream &, SolutionInvalidity &, void *);

namespace moose::internal
{
class SolutionInvalidityRegistry;

SolutionInvalidityRegistry & getSolutionInvalidityRegistry();

class SolutionInvalidityName
{
public:
  SolutionInvalidityName(const std::string & object_type, const std::string & message)
    : object_type(object_type), message(message)
  {
  }

  bool operator==(const SolutionInvalidityName & other) const
  {
    return object_type == other.object_type && message == other.message;
  }

  std::string object_type;
  std::string message;
};

struct SoltionInvalidityNameHash
{
  inline size_t operator()(const SolutionInvalidityName & name) const
  {
    size_t seed = 0;
    Moose::hash_combine(seed, name.object_type, name.message);
    return seed;
  }
};

std::ostream & operator<<(std::ostream & os, const SolutionInvalidityName & name);

class SolutionInvalidityInfo : public SolutionInvalidityName
{
public:
  SolutionInvalidityInfo(const std::string & object_type,
                         const std::string & message,
                         const InvalidSolutionID id,
                         const bool warning)
    : SolutionInvalidityName(object_type, message), id(id), warning(warning)
  {
  }

  InvalidSolutionID id;
  bool warning;
};

class SolutionInvalidityRegistry : public GeneralRegistry<SolutionInvalidityName,
                                                          SolutionInvalidityInfo,
                                                          SoltionInvalidityNameHash>
{
public:
  InvalidSolutionID registerInvalidity(const std::string & object_type,
                                       const std::string & message,
                                       const bool warning);

private:
  SolutionInvalidityRegistry();

  friend SolutionInvalidityRegistry & getSolutionInvalidityRegistry();
  friend SolutionInvalidity;
};
}