SurfaceList.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/Types.hpp>
#include <Reaktoro/Common/StringList.hpp>
#include <Reaktoro/Core/Surface.hpp>
 
namespace Reaktoro {
 
class SurfaceList
{
public:
    SurfaceList();
 
    SurfaceList(std::initializer_list<Surface> surfaces);
 
    SurfaceList(Vec<Surface> const& surfaces);
 
    auto append(Surface const& surface) -> void;
 
    auto data() const -> Vec<Surface> const&;
 
    auto empty() const -> bool;
 
    auto size() const -> Index;
 
    auto operator[](Index i) const -> Surface const&;
 
    auto operator[](Index i) -> Surface&;
 
    auto find(String const& name) const -> Index;
 
    auto findWithName(String const& name) const -> Index;
 
    auto index(String const& name) const -> Index;
 
    auto indexWithName(String const& name) const -> Index;
 
    auto get(String const& name) const -> Surface const&;
 
    auto getWithName(String const& name) const -> Surface const&;
 
    auto withNames(StringList const& names) const -> SurfaceList;
 
    operator Vec<Surface>&();
 
    operator Vec<Surface>const&() const;
 
private:
    Vec<Surface> m_surfaces;
 
public:
    template<typename InputIterator>
    SurfaceList(InputIterator begin, InputIterator end) : m_surfaces(begin, end) {}
 
    auto begin() const { return m_surfaces.begin(); }
 
    auto begin() { return m_surfaces.begin(); }
 
    auto end() const { return m_surfaces.end(); }
 
    auto end() { return m_surfaces.end(); }
 
    auto push_back(Surface const& surfaces) -> void { append(surfaces); }
 
    template<typename Iterator, typename InputIterator>
    auto insert(Iterator pos, InputIterator begin, InputIterator end) -> void { m_surfaces.insert(pos, begin, end); }
 
    using value_type = Surface;
};
 
auto operator+(SurfaceList const& a, SurfaceList const& b) -> SurfaceList;
 
} // namespace Reaktoro