add a FIPContainer class

this is a container for the FIP map and associated code
in OutputBlackoilModule.

start by adding allocation functionality. for now the container
only owns a reference to the map

CMakeLists_files.cmake

@@ -93,6 +93,7 @@ list (APPEND MAIN_SOURCE_FILES
   opm/simulators/flow/ConvergenceOutputConfiguration.cpp
   opm/simulators/flow/EclGenericWriter.cpp
   opm/simulators/flow/ExtraConvergenceOutputThread.cpp
+  opm/simulators/flow/FIPContainer.cpp
   opm/simulators/flow/FlowGenericProblem.cpp
   opm/simulators/flow/FlowGenericVanguard.cpp
   opm/simulators/flow/FlowProblemParameters.cpp
@@ -816,6 +817,7 @@ list (APPEND PUBLIC_HEADER_FILES
   opm/simulators/flow/ExtraConvergenceOutputThread.hpp
   opm/simulators/flow/FemCpGridCompat.hpp
   opm/simulators/flow/FIBlackoilModel.hpp
+  opm/simulators/flow/FIPContainer.hpp
   opm/simulators/flow/FlowBaseProblemProperties.hpp
   opm/simulators/flow/FlowBaseVanguard.hpp
   opm/simulators/flow/FlowGenericProblem.hpp

opm/simulators/flow/FIPContainer.cpp

@@ -0,0 +1,86 @@
+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*
+  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 2 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/>.
+  Consult the COPYING file in the top-level source directory of this
+  module for the precise wording of the license and the list of
+  copyright holders.
+*/
+
+#include <config.h>
+#include <opm/simulators/flow/FIPContainer.hpp>
+
+#include <opm/input/eclipse/EclipseState/SummaryConfig/SummaryConfig.hpp>
+
+#include <opm/material/fluidsystems/BlackOilDefaultIndexTraits.hpp>
+#include <opm/material/fluidsystems/BlackOilFluidSystem.hpp>
+#include <opm/material/fluidsystems/GenericOilGasFluidSystem.hpp>
+
+namespace Opm {
+
+template<class FluidSystem>
+bool
+FIPContainer<FluidSystem>::
+allocate(const std::size_t bufferSize,
+         const SummaryConfig& summaryConfig,
+         const bool forceAlloc)
+{
+    bool computeFip = false;
+    bufferSize_ = bufferSize;
+    for (const auto& phase : Inplace::phases()) {
+        if (forceAlloc || summaryConfig.require3DField(Inplace::EclString(phase))) {
+            this->add(phase);
+            computeFip = true;
+        }
+        else {
+            this->fip_[phase].clear();
+        }
+    }
+
+    return computeFip;
+}
+
+template<class FluidSystem>
+void
+FIPContainer<FluidSystem>::add(const Inplace::Phase phase)
+{
+    this->fip_[phase].resize(bufferSize_, 0.0);
+}
+
+template<class T> using FS = BlackOilFluidSystem<T,BlackOilDefaultIndexTraits>;
+
+#define INSTANTIATE_TYPE(T) \
+    template class FIPContainer<FS<T>>;
+
+INSTANTIATE_TYPE(double)
+
+#if FLOW_INSTANTIATE_FLOAT
+INSTANTIATE_TYPE(float)
+#endif
+
+#define INSTANTIATE_COMP(NUM) \
+    template<class T> using FS##NUM = GenericOilGasFluidSystem<T, NUM>; \
+    template class FIPContainer<FS##NUM<double>>;
+
+INSTANTIATE_COMP(0)
+INSTANTIATE_COMP(2)
+INSTANTIATE_COMP(3)
+INSTANTIATE_COMP(4)
+INSTANTIATE_COMP(5)
+INSTANTIATE_COMP(6)
+INSTANTIATE_COMP(7)
+
+} // namespace Opm

opm/simulators/flow/FIPContainer.hpp

@@ -0,0 +1,62 @@
+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*
+  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 2 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/>.
+  Consult the COPYING file in the top-level source directory of this
+  module for the precise wording of the license and the list of
+  copyright holders.
+*/
+/*!
+ * \file
+ * \copydoc Opm::OutputBlackOilModule
+ */
+#ifndef OPM_FIP_CONTAINER_HPP
+#define OPM_FIP_CONTAINER_HPP
+
+#include <opm/output/eclipse/Inplace.hpp>
+
+#include <cstddef>
+#include <unordered_map>
+#include <vector>
+
+namespace Opm {
+
+class SummaryConfig;
+
+template<class FluidSystem>
+class FIPContainer {
+public:
+    using Scalar = typename FluidSystem::Scalar;
+    using FIPMap = std::unordered_map<Inplace::Phase, std::vector<Scalar>>;
+
+    // Temporary constructor until we are ready to own the map
+    explicit FIPContainer(FIPMap& fip)
+        : fip_(fip) {}
+
+    bool allocate(const std::size_t bufferSize,
+                  const SummaryConfig& summaryConfig,
+                  const bool forceAlloc);
+
+    void add(const Inplace::Phase phase);
+
+private:
+    FIPMap& fip_;
+    std::size_t bufferSize_ = 0;
+};
+
+} // namespace Opm
+
+#endif // OPM_FIP_CONTAINER_HPP

opm/simulators/flow/GenericOutputBlackoilModule.cpp

@@ -125,6 +125,7 @@ GenericOutputBlackoilModule(const EclipseState& eclState,
     , enableExtbo_(enableExtbo)
     , enableMICP_(enableMICP)
     , isCompositional_(isCompositional)
+    , fipC_(fip_)
     , local_data_valid_(false)
 {
     const auto& fp = eclState_.fieldProps();
@@ -946,15 +947,9 @@ doAllocBuffers(const unsigned bufferSize,
             }
         }
 
-        for (const auto& phase : Inplace::phases()) {
-            if (!substep || summaryConfig_.require3DField(Inplace::EclString(phase))) {
-                this->fip_[phase].resize(bufferSize, 0.0);
-                this->computeFip_ = true;
-            }
-            else {
-                this->fip_[phase].clear();
-            }
-        }
+        this->computeFip_ = this->fipC_.allocate(bufferSize,
+                                                 summaryConfig_,
+                                                 !substep);
     }
 
     const auto needAvgPress = !substep         ||
@@ -967,7 +962,7 @@ doAllocBuffers(const unsigned bufferSize,
         this->summaryConfig_.match("RHPV*");
 
     if (needPoreVolume) {
-        this->fip_[Inplace::Phase::PoreVolume].resize(bufferSize, 0.0);
+        this->fipC_.add(Inplace::Phase::PoreVolume);
         this->dynamicPoreVolume_.resize(bufferSize, 0.0);
         this->hydrocarbonPoreVolume_.resize(bufferSize, 0.0);
     }

opm/simulators/flow/GenericOutputBlackoilModule.hpp

@@ -32,6 +32,7 @@
 #include <opm/output/data/Wells.hpp>
 #include <opm/output/eclipse/Inplace.hpp>
 
+#include <opm/simulators/flow/FIPContainer.hpp>
 #include <opm/simulators/flow/FlowsData.hpp>
 #include <opm/simulators/flow/InterRegFlows.hpp>
 #include <opm/simulators/flow/LogOutputHelper.hpp>
@@ -462,6 +463,7 @@ protected:
     bool enableFloresn_{false};
 
     std::unordered_map<Inplace::Phase, ScalarBuffer> fip_;
+    FIPContainer<FluidSystem> fipC_;
     std::unordered_map<std::string, std::vector<int>> regions_;
     std::unordered_map<Inplace::Phase, std::vector<SummaryConfigNode>> regionNodes_;