add some fluid state classes

namely BlackoilStateToFluidState which takes a BlackoilState object and exposes it as a opm-material like fluid state object. Similar for ExplicitArraysFluidState, which takes raw arrays. since fluid states are a local API, the index of the cell to be used for these two classes must be set externally. The advantage of this concept is that it is possible to make "saturation functions" which not only depend on saturations but also on arbitrary other quanties (like temperature or phase composition) without having to change the API of the "saturation" functions.
2025-02-25 18:55:30 -06:00 · 2015-06-26 13:11:12 +02:00
parent 55786028fd
commit 5af89a0e55
2 changed files with 191 additions and 0 deletions
--- a/opm/core/simulator/ExplicitArraysFluidState.hpp
+++ b/opm/core/simulator/ExplicitArraysFluidState.hpp
@@ -0,0 +1,97 @@
+/*
+  Copyright 2015 Andreas Lauser
+
+  This file is part of the Open Porous Media project (OPM).
+
+  OPM is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  OPM 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 General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef OPM_EXPLICIT_ARRAYS_FLUID_STATE_HEADER_INCLUDED
+#define OPM_EXPLICIT_ARRAYS_FLUID_STATE_HEADER_INCLUDED
+
+#include <opm/core/simulator/BlackoilState.hpp>
+
+namespace Opm
+{
+
+/*!
+ * \brief This is a fluid state which translates global arrays and translates them to a
+ *        subset of the fluid state API.
+ *
+ * This class is similar to Opm::BlackoilStateToFluidState.
+ */
+class ExplicitArraysFluidState
+{
+public:
+    typedef double Scalar;
+
+    enum { numPhases = 3 };
+    enum { numComponents = 3 };
+
+    ExplicitArraysFluidState()
+    {}
+
+    /*!
+     * \brief Sets the currently used array index.
+     *
+     * After calling this, the values returned by the other methods are specific for this
+     * index.
+     */
+    void setIndex(unsigned arrayIdx)
+    { arrayIdx_ = arrayIdx; }
+
+    /*!
+     * \brief Set the array containing the phase saturations.
+     *
+     * This array is supposed to be of size numPhases*size and is not allowed to be
+     * deleted while the ExplicitArraysFluidState object is alive. This class assumes
+     * that the saturations of all phase saturations for a point are consequtive, i.e.,
+     * in the array the saturations cycle fastest.
+     */
+    void setSaturationArray(const double* saturations)
+    { saturations_ = saturations; }
+
+    /*!
+     * \brief Set the array containing the phase temperatures.
+     *
+     * This array is supposed to be of size 'size' and is not allowed to be
+     * deleted while the ExplicitArraysFluidState object is alive.
+     */
+    void setTemperatureArray(const double* temperature)
+    { temperature_ = temperature; }
+
+    /*!
+     * \brief Returns the saturation of a phase for the current cell index.
+     */
+    Scalar saturation(int phaseIdx) const
+    { return saturations_[numPhases*arrayIdx_ + phaseIdx]; }
+
+    /*!
+     * \brief Returns the temperature [K] of a phase for the current cell index.
+     */
+    Scalar temperature(int phaseIdx) const
+    { return temperature_[arrayIdx_]; }
+
+    // TODO (?) pressure, composition, etc
+
+private:
+    const double* saturations_;
+    const double* temperature_;
+
+    unsigned arrayIdx_;
+};
+
+} // namespace Opm
+
+#endif // OPM_SIMULATORTIMER_HEADER_INCLUDED