opm-simulators/opm/models/io/vtkscalarfunction.hh
Arne Morten Kvarving e4d6acc23b changed: get rid of OPM_UNUSED macro usage
prefer anonymous parameters and c++17 [[maybe_unused]]
2021-08-03 10:10:01 +02:00

127 lines
3.8 KiB
C++

// -*- 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::VtkScalarFunction
*/
#ifndef VTK_SCALAR_FUNCTION_HH
#define VTK_SCALAR_FUNCTION_HH
#include <opm/models/io/baseoutputwriter.hh>
#include <dune/grid/io/file/vtk/function.hh>
#include <dune/istl/bvector.hh>
#include <dune/common/fvector.hh>
#include <dune/common/version.hh>
#include <opm/material/common/Unused.hpp>
#include <opm/material/common/Exceptions.hpp>
#include <string>
#include <limits>
#include <vector>
namespace Opm {
/*!
* \brief Provides a vector-valued function using Dune::FieldVectors
* as elements.
*/
template <class GridView, class Mapper>
class VtkScalarFunction : public Dune::VTKFunction<GridView>
{
enum { dim = GridView::dimension };
using ctype = typename GridView::ctype;
using Element = typename GridView::template Codim<0>::Entity;
using ScalarBuffer = BaseOutputWriter::ScalarBuffer;
public:
VtkScalarFunction(std::string name,
const GridView& gridView,
const Mapper& mapper,
const ScalarBuffer& buf,
unsigned codim)
: name_(name)
, gridView_(gridView)
, mapper_(mapper)
, buf_(buf)
, codim_(codim)
{ assert(int(buf_.size()) == int(mapper_.size())); }
virtual std::string name() const
{ return name_; }
virtual int ncomps() const
{ return 1; }
virtual double evaluate(int,
const Element& e,
const Dune::FieldVector<ctype, dim>& xi) const
{
unsigned idx;
if (codim_ == 0) {
// cells. map element to the index
idx = static_cast<unsigned>(mapper_.index(e));
}
else if (codim_ == dim) {
// find vertex which is closest to xi in local
// coordinates. This code is based on Dune::P1VTKFunction
double min = 1e100;
int imin = -1;
Dune::GeometryType gt = e.type();
int n = static_cast<int>(e.subEntities(dim));
for (int i = 0; i < n; ++i) {
Dune::FieldVector<ctype, dim> local =
Dune::ReferenceElements<ctype, dim>::general(gt).position(i, dim);
local -= xi;
if (local.infinity_norm() < min) {
min = local.infinity_norm();
imin = static_cast<int>(i);
}
}
// map vertex to an index
idx = static_cast<unsigned>(mapper_.subIndex(e, imin, codim_));
}
else
throw std::logic_error("Only element and vertex based vector fields are"
" supported so far.");
return static_cast<double>(static_cast<float>(buf_[idx]));
}
private:
const std::string name_;
const GridView gridView_;
const Mapper& mapper_;
const ScalarBuffer& buf_;
unsigned codim_;
};
} // namespace Opm
#endif