PorousRockState.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright © 2014-2022 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/ChemicalState.hpp>
 
namespace Reaktoro {
 
// Forward declarations
class ChemicalProps;
class ChemicalSystem;
class ChemicalState;
 
// TODO: Implement PorousRockState class in the PorousMedia extension.
 
class PorousRockState : public ChemicalState
{
public:
    explicit PorousRockState(const ChemicalSystem& system);
 
    PorousRockState(const PorousRockState& other);
 
    virtual ~PorousRockState();
 
    auto operator=(PorousRockState other) -> PorousRockState&;
 
    auto setPorosity(real value) -> void;
 
    auto setVolumeFractionAmongFluids(Index iphase, real value) -> void;
 
    auto setVolumeFractionAmongFluids(String phasename, real value) -> void;
 
    auto setVolumeFractionAmongSolids(Index iphase, real value) -> void;
 
    auto setVolumeFractionAmongSolids(String phasename, real value) -> void;
 
    auto equilibrate() -> void;
 
private:
    struct Impl;
 
    std::unique_ptr<Impl> pimpl;
};
 
auto operator<<(std::ostream& out, const PorousRockState& state) -> std::ostream&;
 
} // namespace Reaktoro