Loading...
Searching...
No Matches
GenericTracerModel.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_GENERIC_TRACER_MODEL_HPP
#define OPM_GENERIC_TRACER_MODEL_HPP
#include <dune/istl/bcrsmatrix.hh>
#include <opm/grid/common/CartesianIndexMapper.hpp>
#include <opm/input/eclipse/EclipseState/Phase.hpp>
#include <opm/models/blackoil/blackoilmodel.hh>
#include <opm/simulators/linalg/matrixblock.hh>
#include <opm/simulators/wells/WellTracerRate.hpp>
#include <array>
#include <cstddef>
#include <functional>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
namespace Opm {
class EclipseState;
class Well;
template<class Grid, class GridView, class DofMapper, class Stencil, class FluidSystem, class Scalar>
class GenericTracerModel {
public:
using TracerVectorSingle = Dune::BlockVector<Dune::FieldVector<Scalar, 1>>;
using TracerMatrix = Dune::BCRSMatrix<Opm::MatrixBlock<Scalar, 2, 2>>;
using TracerVector = Dune::BlockVector<Dune::FieldVector<Scalar, 2>>;
using CartesianIndexMapper = Dune::CartesianIndexMapper<Grid>;
static constexpr int dimWorld = Grid::dimensionworld;
int numTracers() const;
const std::string& name(int tracerIdx) const;
std::string fname(int tracerIdx) const;
std::string sname(int tracerIdx) const;
std::string wellfname(int tracerIdx) const;
std::string wellsname(int tracerIdx) const;
Phase phase(int tracerIdx) const;
const std::vector<bool>& enableSolTracers() const;
Scalar freeTracerConcentration(int tracerIdx, int globalDofIdx) const;
Scalar solTracerConcentration(int tracerIdx, int globalDofIdx) const;
void setFreeTracerConcentration(int tracerIdx, int globalDofIdx, Scalar value);
void setSolTracerConcentration(int tracerIdx, int globalDofIdx, Scalar value);
void setEnableSolTracers(int tracerIdx, bool enableSolTracer);
const std::unordered_map<int, std::vector<WellTracerRate<Scalar>>>&
getWellTracerRates() const
{ return wellTracerRate_; }
const std::unordered_map<int, std::vector<WellTracerRate<Scalar>>>&
getWellFreeTracerRates() const
{ return wellFreeTracerRate_; }
const std::unordered_map<int, std::vector<WellTracerRate<Scalar>>>&
getWellSolTracerRates() const
{ return wellSolTracerRate_; }
const std::unordered_map<int, std::vector<MSWellTracerRate<Scalar>>>&
getMswTracerRates() const {return mSwTracerRate_;}
template<class Serializer>
void serializeOp(Serializer& serializer)
{
serializer(tracerConcentration_);
serializer(freeTracerConcentration_);
serializer(solTracerConcentration_);
serializer(wellTracerRate_);
serializer(wellFreeTracerRate_);
serializer(wellSolTracerRate_);
serializer(mSwTracerRate_);
}
protected:
GenericTracerModel(const GridView& gridView,
const EclipseState& eclState,
const CartesianIndexMapper& cartMapper,
const DofMapper& dofMapper,
const std::function<std::array<double,dimWorld>(int)> centroids);
void doInit(bool rst,
std::size_t numGridDof,
std::size_t gasPhaseIdx,
std::size_t oilPhaseIdx,
std::size_t waterPhaseIdx);
bool linearSolve_(const TracerMatrix& M, TracerVector& x, TracerVector& b);
bool linearSolveBatchwise_(const TracerMatrix& M,
std::vector<TracerVector>& x,
std::vector<TracerVector>& b);
Scalar currentConcentration_(const Well& eclWell,
const std::string& trName,
const SummaryState& summaryState) const;
enum TracerTypeIdx {
Free = 0,
Solution = 1,
};
const GridView& gridView_;
const EclipseState& eclState_;
const CartesianIndexMapper& cartMapper_;
const DofMapper& dofMapper_;
std::vector<int> tracerPhaseIdx_;
std::vector<bool> enableSolTracers_;
std::vector<TracerVector> tracerConcentration_;
std::unique_ptr<TracerMatrix> tracerMatrix_;
std::vector<TracerVectorSingle> freeTracerConcentration_;
std::vector<TracerVectorSingle> solTracerConcentration_;
// well_index -> tracer rates
std::unordered_map<int, std::vector<WellTracerRate<Scalar>>> wellTracerRate_;
std::unordered_map<int, std::vector<WellTracerRate<Scalar>>> wellFreeTracerRate_;
std::unordered_map<int, std::vector<WellTracerRate<Scalar>>> wellSolTracerRate_;
std::unordered_map<int, std::vector<MSWellTracerRate<Scalar>>> mSwTracerRate_;
std::function<std::array<double,dimWorld>(int)> centroids_;
};
} // namespace Opm
#endif // OPM_GENERIC_TRACER_MODEL_HPP
blackoilmodel.hh
A fully-implicit black-oil flow model.
Dune::CartesianIndexMapper
Definition CollectDataOnIORank.hpp:49
Opm::GenericTracerModel::numTracers
int numTracers() const
Return the number of tracers considered by the tracerModel.
Definition GenericTracerModel_impl.hpp:162
Opm::GenericTracerModel::getWellTracerRates
const std::unordered_map< int, std::vector< WellTracerRate< Scalar > > > & getWellTracerRates() const
Return well tracer rates.
Definition GenericTracerModel.hpp:93
Opm::GenericTracerModel::doInit
void doInit(bool rst, std::size_t numGridDof, std::size_t gasPhaseIdx, std::size_t oilPhaseIdx, std::size_t waterPhaseIdx)
Initialize all internal data structures needed by the tracer module.
Definition GenericTracerModel_impl.hpp:227
Opm::GenericTracerModel::name
const std::string & name(int tracerIdx) const
Return the tracer name.
Definition GenericTracerModel_impl.hpp:220
Opm::GenericTracerModel< GetPropType< TypeTag, Properties::Grid >, GetPropType< TypeTag, Properties::GridView >, GetPropType< TypeTag, Properties::DofMapper >, GetPropType< TypeTag, Properties::Stencil >, GetPropType< TypeTag, Properties::FluidSystem >, GetPropType< TypeTag, Properties::Scalar > >::centroids_
std::function< std::array< double, dimWorld >(int)> centroids_
Definition GenericTracerModel.hpp:171
Opm::GenericTracerModel::TracerTypeIdx
TracerTypeIdx
Tracer type index.
Definition GenericTracerModel.hpp:146
Opm::GenericTracerModel::freeTracerConcentration
Scalar freeTracerConcentration(int tracerIdx, int globalDofIdx) const
Return the tracer concentration for tracer index and global DofIdx.
Definition GenericTracerModel_impl.hpp:117
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43