// -*- 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 . 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::EclCpGridVanguard */ #ifndef EWOMS_ECL_CP_GRID_GENERIC_VANGUARD_HH #define EWOMS_ECL_CP_GRID_GENERIC_VANGUARD_HH #include #include #include #include #include namespace Opm { class EclipseState; class Schedule; class Well; class ParallelEclipseState; } namespace Opm { /// \brief optional functor returning external load balancing information /// /// If it is set then this will be used during loadbalance. extern std::optional (const Dune::CpGrid&)>> externalLoadBalancer; template class EclGenericCpGridVanguard { protected: using CartesianIndexMapper = Dune::CartesianIndexMapper; using Element = typename GridView::template Codim<0>::Entity; public: EclGenericCpGridVanguard(); virtual ~EclGenericCpGridVanguard() = default; /*! * \brief Return a reference to the simulation grid. */ Dune::CpGrid& grid() { return *grid_; } /*! * \brief Return a reference to the simulation grid. */ const Dune::CpGrid& grid() const { return *grid_; } /*! * \brief Returns a refefence to the grid which should be used by the EQUIL * initialization code. * * The EQUIL keyword is used to specify the initial condition of the reservoir in * hydrostatic equilibrium. Since the code which does this is not accepting arbitrary * DUNE grids (the code is part of the opm-core module), this is not necessarily the * same as the grid which is used for the actual simulation. */ const Dune::CpGrid& equilGrid() const; /*! * \brief Indicates that the initial condition has been computed and the memory used * by the EQUIL grid can be released. * * Depending on the implementation, subsequent accesses to the EQUIL grid lead to * crashes. */ void releaseEquilGrid(); /// \brief Sets a function that returns external load balancing information when passed the grid /// /// The information is a vector of integers indication the partition index for each cell id. static void setExternalLoadBalancer(const std::function (const Dune::CpGrid&)>& loadBalancer) { externalLoadBalancer = loadBalancer; } /*! * \brief Returns the object which maps a global element index of the simulation grid * to the corresponding element index of the logically Cartesian index. */ const CartesianIndexMapper& cartesianIndexMapper() const; /*! * \brief Returns mapper from compressed to cartesian indices for the EQUIL grid */ const CartesianIndexMapper& equilCartesianIndexMapper() const; const std::vector& cellPartition() const { return this->cell_part_; } protected: /*! * \brief Distribute the simulation grid over multiple processes * * (For parallel simulation runs.) */ #if HAVE_MPI void doLoadBalance_(const Dune::EdgeWeightMethod edgeWeightsMethod, const bool ownersFirst, const bool serialPartitioning, const bool enableDistributedWells, const double zoltanImbalanceTol, const GridView& gridView, const Schedule& schedule, std::vector& centroids, EclipseState& eclState, EclGenericVanguard::ParallelWellStruct& parallelWells, const int numJacobiBlocks); void distributeFieldProps_(EclipseState& eclState); private: std::vector extractFaceTrans(const GridView& gridView) const; void distributeGrid(const Dune::EdgeWeightMethod edgeWeightsMethod, const bool ownersFirst, const bool serialPartitioning, const bool enableDistributedWells, const double zoltanImbalanceTol, const bool loadBalancerSet, const std::vector& faceTrans, const std::vector& wells, std::vector& centroids, EclipseState& eclState, EclGenericVanguard::ParallelWellStruct& parallelWells); void distributeGrid(const Dune::EdgeWeightMethod edgeWeightsMethod, const bool ownersFirst, const bool serialPartitioning, const bool enableDistributedWells, const double zoltanImbalanceTol, const bool loadBalancerSet, const std::vector& faceTrans, const std::vector& wells, std::vector& centroids, ParallelEclipseState* eclState, EclGenericVanguard::ParallelWellStruct& parallelWells); protected: virtual const std::string& zoltanParams() const = 0; #endif // HAVE_MPI void allocCartMapper(); void doCreateGrids_(EclipseState& eclState); virtual void allocTrans() = 0; virtual double getTransmissibility(unsigned I, unsigned J) const = 0; // removing some connection located in inactive grid cells void doFilterConnections_(Schedule& schedule); Scalar computeCellThickness(const Element& element) const; std::unique_ptr grid_; std::unique_ptr equilGrid_; std::unique_ptr cartesianIndexMapper_; std::unique_ptr equilCartesianIndexMapper_; int mpiRank; std::vector cell_part_{}; }; } // namespace Opm #endif