Elements.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright © 2014-2024 Allan Leal
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
// Reaktoro includes
#include <Reaktoro/Common/Index.hpp>
#include <Reaktoro/Common/StringList.hpp>
#include <Reaktoro/Common/Types.hpp>
#include <Reaktoro/Core/Element.hpp>
 
namespace Reaktoro {
 
class Elements
{
public:
    Elements(const Elements&) = delete;
 
    auto operator=(const Elements&) -> Elements& = delete;
 
    static auto instance() -> Elements&;
 
    static auto data() -> Vec<Element> const&;
 
    [[deprecated("Use Elements::data() instead.")]]
    static auto elements() -> Vec<Element> const&;
 
    static auto clear() -> void;
 
    static auto reset() -> void;
 
    static auto append(Element element) -> void;
 
    static auto replace(String const& existingSymbol, Element const& replacement) -> bool;
 
    static auto size() -> std::size_t;
 
    static auto withSymbol(String symbol) -> Optional<Element>;
 
    static auto withName(String name) -> Optional<Element>;
 
    static auto withTag(String tag) -> Vec<Element>;
 
    static auto withTags(StringList const& tags) -> Vec<Element>;
 
    auto begin() const { return data().begin(); }
 
    auto begin() { return data().begin(); }
 
    auto end() const { return data().end(); }
 
    auto end() { return data().end(); }
 
private:
    Vec<Element> m_elements;
 
private:
    Elements();
 
    ~Elements();
};
 
} // namespace Reaktoro