Surface.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/Core/SurfaceAreaModel.hpp>
 
namespace Reaktoro {
 
// Forward declarations
class ChemicalProps;
 
class Surface
{
public:
    Surface();
 
    explicit Surface(String const& name);
 
    Surface(String const& name, SurfaceAreaModel const& model);
 
    auto clone() const -> Surface;
 
    auto withName(String const& name) const -> Surface;
 
    auto withAreaModel(SurfaceAreaModel const& model) const -> Surface;
 
    auto name() const -> String const&;
 
    auto areaModel() const -> SurfaceAreaModel const&;
 
    auto area(ChemicalProps const& props) const -> real;
 
private:
    struct Impl;
 
    SharedPtr<Impl> pimpl;
};
 
auto operator<(Surface const& lhs, Surface const& rhs) -> bool;
 
auto operator==(Surface const& lhs, Surface const& rhs) -> bool;
 
} // namespace Reaktoro
 
// Custom specialization of std::hash for Reaktoro::Surface
namespace std {
 
template<>
struct hash<Reaktoro::Surface>
{
    std::size_t operator()(Reaktoro::Surface const& s) const noexcept
    {
        return std::hash<std::string>{}(s.name());
    }
};
 
} // namespace std