Loading...
Searching...
No Matches
PolyhedralGridVanguard.hpp
Go to the documentation of this file.
// -*- 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.
*/
#ifndef OPM_POLYHEDRAL_GRID_VANGUARD_HPP
#define OPM_POLYHEDRAL_GRID_VANGUARD_HPP
#include <opm/grid/polyhedralgrid.hh>
#include <opm/grid/polyhedralgrid/levelcartesianindexmapper.hh>
#include <opm/models/common/multiphasebaseproperties.hh>
#include <opm/simulators/flow/FlowBaseVanguard.hpp>
#include <opm/simulators/flow/Transmissibility.hpp>
#include <array>
#include <functional>
#include <string>
#include <tuple>
#include <unordered_set>
namespace Opm {
template <class TypeTag>
class PolyhedralGridVanguard;
}
namespace Opm::Properties {
namespace TTag {
struct PolyhedralGridVanguard {
using InheritsFrom = std::tuple<FlowBaseVanguard>;
};
}
// declare the properties
template<class TypeTag>
struct Vanguard<TypeTag, TTag::PolyhedralGridVanguard> {
using type = Opm::PolyhedralGridVanguard<TypeTag>;
};
template<class TypeTag>
struct Grid<TypeTag, TTag::PolyhedralGridVanguard> {
using type = Dune::PolyhedralGrid<3, 3>;
};
template<class TypeTag>
struct EquilGrid<TypeTag, TTag::PolyhedralGridVanguard> {
using type = GetPropType<TypeTag, Properties::Grid>;
};
} // namespace Opm::Properties
namespace Opm {
template <class TypeTag>
class PolyhedralGridVanguard : public FlowBaseVanguard<TypeTag>
{
friend class FlowBaseVanguard<TypeTag>;
using ParentType = FlowBaseVanguard<TypeTag>;
using ElementMapper = GetPropType<TypeTag, Properties::ElementMapper>;
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
using Simulator = GetPropType<TypeTag, Properties::Simulator>;
public:
using Grid = GetPropType<TypeTag, Properties::Grid>;
using EquilGrid = GetPropType<TypeTag, Properties::EquilGrid>;
using GridView = GetPropType<TypeTag, Properties::GridView>;
using CartesianIndexMapper = Dune::CartesianIndexMapper<Grid>;
using LevelCartesianIndexMapper = Opm::LevelCartesianIndexMapper<Grid>;
using EquilCartesianIndexMapper = Dune::CartesianIndexMapper<EquilGrid>;
static constexpr int dimension = Grid::dimension;
static constexpr int dimensionworld = Grid::dimensionworld;
private:
using GridPointer = Grid*;
using EquilGridPointer = EquilGrid*;
public:
using TransmissibilityType = Transmissibility<Grid, GridView, ElementMapper,
CartesianIndexMapper, Scalar>;
explicit PolyhedralGridVanguard(Simulator& simulator)
: FlowBaseVanguard<TypeTag>(simulator)
, simulator_(simulator)
{
this->callImplementationInit();
// add a copy in standard vector format to fullfill new interface
const int* globalcellorg = this->grid().globalCell();
int num_cells = this->gridView().size(0);
globalcell_.resize(num_cells);
for(int i=0; i < num_cells; ++i){
globalcell_[i] = globalcellorg[i];
}
}
Grid& grid()
{ return *grid_; }
const Grid& grid() const
{ return *grid_; }
const EquilGrid& equilGrid() const
{ return *grid_; }
void releaseEquilGrid()
{ /* do nothing: The EQUIL grid is the simulation grid! */ }
void loadBalance()
{ /* do nothing: PolyhedralGrid is not parallel! */
}
void addLgrs()
{ /* do nothing: PolyhedralGrid with LGRs not supported yet! */
}
const CartesianIndexMapper& cartesianIndexMapper() const
{ return *cartesianIndexMapper_; }
const LevelCartesianIndexMapper levelCartesianIndexMapper() const
{ return LevelCartesianIndexMapper(*cartesianIndexMapper_); }
const CartesianIndexMapper& equilCartesianIndexMapper() const
{ return *cartesianIndexMapper_; }
const std::vector<int>& globalCell()
{
return globalcell_;
}
unsigned int gridEquilIdxToGridIdx(unsigned int elemIndex) const {
return elemIndex;
}
unsigned int gridIdxToEquilGridIdx(unsigned int elemIndex) const {
return elemIndex;
}
void releaseGlobalTransmissibilities()
{
}
std::unordered_set<std::string> defunctWellNames() const
{ return defunctWellNames_; }
const TransmissibilityType& globalTransmissibility() const
{
return simulator_.problem().eclTransmissibilities();
}
std::function<std::array<double,FlowBaseVanguard<TypeTag>::dimensionworld>(int)>
cellCentroids() const
{
return this->cellCentroids_(this->cartesianIndexMapper(), false);
}
std::vector<int> cellPartition() const
{
// not required for this type of grid yet (only from bdaBridge??)
return {};
}
protected:
void createGrids_()
{
this->grid_ = std::make_unique<Grid>
(this->eclState().getInputGrid(),
this->eclState().fieldProps().porv(true),
this->edgeConformal());
this->cartesianIndexMapper_ =
std::make_unique<CartesianIndexMapper>(*this->grid_);
this->updateGridView_();
this->updateCartesianToCompressedMapping_();
this->updateCellDepths_();
}
void filterConnections_()
{
// not handling the removal of completions for this type of grid yet.
}
Simulator& simulator_;
std::unique_ptr<Grid> grid_;
std::unique_ptr<CartesianIndexMapper> cartesianIndexMapper_;
//CartesianIndexMapperPointer cartesianIndexMapper_;
std::unordered_set<std::string> defunctWellNames_;
std::vector<int> globalcell_;
};
} // namespace Opm
#endif // OPM_POLYHEDRAL_GRID_VANGUARD_HPP
FlowBaseVanguard.hpp
Helper class for grid instantiation of ECL file-format using problems.
Transmissibility.hpp
Dune::CartesianIndexMapper
Definition CollectDataOnIORank.hpp:49
Opm::BaseVanguard::addLgrs
void addLgrs()
Add LGRs to the grid, if any.
Definition basevanguard.hh:117
Opm::BaseVanguard::gridView
const GridView & gridView() const
Returns a reference to the grid view to be used.
Definition basevanguard.hh:70
Opm::FlowBaseVanguard::FlowBaseVanguard
FlowBaseVanguard(Simulator &simulator)
Create the grid for problem data files which use the ECL file format.
Definition FlowBaseVanguard.hpp:118
Opm::FlowBaseVanguard::cellCentroids_
std::function< std::array< double, dimensionworld >(int)> cellCentroids_(const CartMapper &cartMapper, const bool &isCpGrid) const
Get function to query cell centroids for a distributed grid.
Definition FlowBaseVanguard.hpp:302
Opm::FlowGenericVanguard::eclState
const EclipseState & eclState() const
Return a reference to the internalized ECL deck.
Definition FlowGenericVanguard.hpp:168
Opm::LevelCartesianIndexMapper
Definition RelpermDiagnostics.hpp:31
Opm::PolyhedralGridVanguard
Helper class for grid instantiation of ECL file-format using problems.
Definition PolyhedralGridVanguard.hpp:84
Opm::PolyhedralGridVanguard::releaseEquilGrid
void releaseEquilGrid()
Indicates that the initial condition has been computed and the memory used by the EQUIL grid can be r...
Definition PolyhedralGridVanguard.hpp:155
Opm::PolyhedralGridVanguard::equilCartesianIndexMapper
const CartesianIndexMapper & equilCartesianIndexMapper() const
Returns mapper from compressed to cartesian indices for the EQUIL grid.
Definition PolyhedralGridVanguard.hpp:192
Opm::PolyhedralGridVanguard::releaseGlobalTransmissibilities
void releaseGlobalTransmissibilities()
Free the memory occupied by the global transmissibility object.
Definition PolyhedralGridVanguard.hpp:213
Opm::PolyhedralGridVanguard::loadBalance
void loadBalance()
Distribute the simulation grid over multiple processes.
Definition PolyhedralGridVanguard.hpp:163
Opm::PolyhedralGridVanguard::equilGrid
const EquilGrid & equilGrid() const
Returns a refefence to the grid which should be used by the EQUIL initialization code.
Definition PolyhedralGridVanguard.hpp:145
Opm::PolyhedralGridVanguard::grid
Grid & grid()
Return a reference to the simulation grid.
Definition PolyhedralGridVanguard.hpp:127
Opm::PolyhedralGridVanguard::grid
const Grid & grid() const
Return a reference to the simulation grid.
Definition PolyhedralGridVanguard.hpp:133
Opm::PolyhedralGridVanguard::cartesianIndexMapper
const CartesianIndexMapper & cartesianIndexMapper() const
Returns the object which maps a global element index of the simulation grid to the corresponding elem...
Definition PolyhedralGridVanguard.hpp:175
Opm::PolyhedralGridVanguard::levelCartesianIndexMapper
const LevelCartesianIndexMapper levelCartesianIndexMapper() const
Returns the object which maps a global element index of the simulation grid to the corresponding elem...
Definition PolyhedralGridVanguard.hpp:183
Opm::PolyhedralGridVanguard::cellCentroids
std::function< std::array< double, FlowBaseVanguard< TypeTag >::dimensionworld >(int)> cellCentroids() const
Get function to query cell centroids for a distributed grid.
Definition PolyhedralGridVanguard.hpp:233
Opm::Transmissibility
Definition Transmissibility.hpp:54
multiphasebaseproperties.hh
Defines the common properties required by the porous medium multi-phase models.
Opm::Properties::TTag
The generic type tag for problems using the immiscible multi-phase model.
Definition blackoilmodel.hh:81
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43
Opm::GetPropType
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(....
Definition propertysystem.hh:233
Opm::Properties::EquilGrid
Definition FlowBaseVanguard.hpp:70
Opm::Properties::Grid
The type of the DUNE grid.
Definition basicproperties.hh:100
Opm::Properties::TTag::PolyhedralGridVanguard
Definition PolyhedralGridVanguard.hpp:52
Opm::Properties::Vanguard
Property which provides a Vanguard (manages grids).
Definition basicproperties.hh:96