MaterialPropertyRegistry.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 <string>
#include <unordered_map>
#include <vector>
#include <optional>

#include "libmesh/simple_range.h"

class MaterialPropertyStorage;

class MaterialPropertyRegistry
{
public:
  bool hasProperty(const std::string & name) const { return _name_to_id.count(name); }

  bool hasProperty(const unsigned int id) const { return id < _id_to_name.size(); }

  class WriteKey
  {
    friend class MaterialPropertyStorage;
    WriteKey() {}
    WriteKey(const WriteKey &) {}
  };

  unsigned int addOrGetID(const std::string & name, const WriteKey);

  unsigned int getID(const std::string & name) const;

  std::optional<unsigned int> queryID(const std::string & name) const;

  const std::string & getName(const unsigned int id) const;

  auto idsToNamesBegin() const { return _id_to_name.begin(); }
  auto idsToNamesEnd() const { return _id_to_name.end(); }
  auto idsToNamesRange() const { return libMesh::SimpleRange(idsToNamesBegin(), idsToNamesEnd()); }

  std::size_t size() const { return _id_to_name.size(); }

private:
  std::unordered_map<std::string, unsigned int> _name_to_id;
  std::vector<std::string> _id_to_name;
};