mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-01 05:19:09 -06:00
310 lines
10 KiB
C++
310 lines
10 KiB
C++
/*
|
|
Copyright 2013 SINTEF ICT, Applied Mathematics.
|
|
|
|
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 3 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/>.
|
|
*/
|
|
|
|
#ifndef OPM_AUTODIFFBLOCK_HEADER_INCLUDED
|
|
#define OPM_AUTODIFFBLOCK_HEADER_INCLUDED
|
|
|
|
#include "AutoDiff.hpp"
|
|
#include <Eigen/Eigen>
|
|
#include <Eigen/Sparse>
|
|
#include <vector>
|
|
#include <cassert>
|
|
|
|
namespace AutoDiff
|
|
{
|
|
|
|
template <typename Scalar>
|
|
class ForwardBlock
|
|
{
|
|
public:
|
|
/// Underlying types for scalar vectors and jacobians.
|
|
typedef Eigen::Array<Scalar, Eigen::Dynamic, 1> V;
|
|
typedef Eigen::SparseMatrix<Scalar> M;
|
|
|
|
/// Named constructor pattern used here.
|
|
static ForwardBlock constant(const V& val, const std::vector<int>& blocksizes)
|
|
{
|
|
std::vector<M> jac;
|
|
const int num_elem = val.size();
|
|
const int num_blocks = blocksizes.size();
|
|
// For constants, all jacobian blocks are zero.
|
|
jac.resize(num_blocks);
|
|
for (int i = 0; i < num_blocks; ++i) {
|
|
jac[i] = M(num_elem, blocksizes[i]);
|
|
}
|
|
return ForwardBlock(val, jac);
|
|
}
|
|
|
|
static ForwardBlock variable(const int index, const V& val, const std::vector<int>& blocksizes)
|
|
{
|
|
std::vector<M> jac;
|
|
const int num_elem = val.size();
|
|
const int num_blocks = blocksizes.size();
|
|
// First, set all jacobian blocks to zero...
|
|
jac.resize(num_blocks);
|
|
for (int i = 0; i < num_blocks; ++i) {
|
|
jac[i] = M(num_elem, blocksizes[i]);
|
|
}
|
|
// ... then set the one corrresponding to this variable to identity.
|
|
assert(blocksizes[index] == num_elem);
|
|
jac[index].reserve(Eigen::VectorXi::Constant(val.size(), 1));
|
|
for (typename M::Index row = 0; row < val.size(); ++row) {
|
|
jac[index].insert(row, row) = Scalar(1.0);
|
|
}
|
|
return ForwardBlock(val, jac);
|
|
}
|
|
|
|
static ForwardBlock function(const V& val, const std::vector<M>& jac)
|
|
{
|
|
return ForwardBlock(val, jac);
|
|
}
|
|
|
|
/// Construct a set of primary variables,
|
|
/// each initialized to a given vector.
|
|
static std::vector<ForwardBlock> variables(const std::vector<V>& initial_values)
|
|
{
|
|
const int num_vars = initial_values.size();
|
|
std::vector<int> bpat;
|
|
for (int v = 0; v < num_vars; ++v) {
|
|
bpat.push_back(initial_values[v].size());
|
|
}
|
|
std::vector<ForwardBlock> vars;
|
|
for (int v = 0; v < num_vars; ++v) {
|
|
vars.emplace_back(variable(v, initial_values[v], bpat));
|
|
}
|
|
return vars;
|
|
}
|
|
|
|
/// Operator +
|
|
ForwardBlock operator+(const ForwardBlock& rhs) const
|
|
{
|
|
std::vector<M> jac = jac_;
|
|
assert(numBlocks() == rhs.numBlocks());
|
|
int num_blocks = numBlocks();
|
|
for (int block = 0; block < num_blocks; ++block) {
|
|
assert(jac[block].rows() == rhs.jac_[block].rows());
|
|
assert(jac[block].cols() == rhs.jac_[block].cols());
|
|
jac[block] += rhs.jac_[block];
|
|
}
|
|
return function(val_ + rhs.val_, jac);
|
|
}
|
|
|
|
/// Operator -
|
|
ForwardBlock operator-(const ForwardBlock& rhs) const
|
|
{
|
|
std::vector<M> jac = jac_;
|
|
assert(numBlocks() == rhs.numBlocks());
|
|
int num_blocks = numBlocks();
|
|
for (int block = 0; block < num_blocks; ++block) {
|
|
assert(jac[block].rows() == rhs.jac_[block].rows());
|
|
assert(jac[block].cols() == rhs.jac_[block].cols());
|
|
jac[block] -= rhs.jac_[block];
|
|
}
|
|
return function(val_ - rhs.val_, jac);
|
|
}
|
|
|
|
/// Operator *
|
|
ForwardBlock operator*(const ForwardBlock& rhs) const
|
|
{
|
|
int num_blocks = numBlocks();
|
|
std::vector<M> jac(num_blocks);
|
|
assert(numBlocks() == rhs.numBlocks());
|
|
typedef Eigen::DiagonalMatrix<Scalar, Eigen::Dynamic> D;
|
|
D D1 = val_.matrix().asDiagonal();
|
|
D D2 = rhs.val_.matrix().asDiagonal();
|
|
for (int block = 0; block < num_blocks; ++block) {
|
|
assert(jac_[block].rows() == rhs.jac_[block].rows());
|
|
assert(jac_[block].cols() == rhs.jac_[block].cols());
|
|
jac[block] = D2*jac_[block] + D1*rhs.jac_[block];
|
|
}
|
|
return function(val_ * rhs.val_, jac);
|
|
}
|
|
|
|
/// Operator /
|
|
ForwardBlock operator/(const ForwardBlock& rhs) const
|
|
{
|
|
int num_blocks = numBlocks();
|
|
std::vector<M> jac(num_blocks);
|
|
assert(numBlocks() == rhs.numBlocks());
|
|
typedef Eigen::DiagonalMatrix<Scalar, Eigen::Dynamic> D;
|
|
D D1 = val_.matrix().asDiagonal();
|
|
D D2 = rhs.val_.matrix().asDiagonal();
|
|
D D3 = std::pow(rhs.val_, -2).matrix().asDiagonal();
|
|
for (int block = 0; block < num_blocks; ++block) {
|
|
assert(jac_[block].rows() == rhs.jac_[block].rows());
|
|
assert(jac_[block].cols() == rhs.jac_[block].cols());
|
|
jac[block] = D3 * (D2*jac_[block] - D1*rhs.jac_[block]);
|
|
}
|
|
return function(val_ / rhs.val_, jac);
|
|
}
|
|
/// I/O.
|
|
template <class Ostream>
|
|
Ostream&
|
|
print(Ostream& os) const
|
|
{
|
|
int num_blocks = jac_.size();
|
|
os << "Value =\n" << val_ << "\n\nJacobian =\n";
|
|
for (int i = 0; i < num_blocks; ++i) {
|
|
os << "Sub Jacobian #" << i << '\n' << jac_[i] << "\n";
|
|
}
|
|
return os;
|
|
}
|
|
|
|
/// Number of variables or Jacobian blocks.
|
|
int numBlocks() const
|
|
{
|
|
return jac_.size();
|
|
}
|
|
|
|
/// Sizes (number of columns) of Jacobian blocks.
|
|
std::vector<int> blockPattern() const
|
|
{
|
|
const int nb = numBlocks();
|
|
std::vector<int> bp(nb);
|
|
for (int block = 0; block < nb; ++block) {
|
|
bp[block] = jac_[block].cols();
|
|
}
|
|
return bp;
|
|
}
|
|
|
|
/// Function value
|
|
const V& value() const
|
|
{
|
|
return val_;
|
|
}
|
|
|
|
/// Function derivatives
|
|
const std::vector<M>& derivative() const
|
|
{
|
|
return jac_;
|
|
}
|
|
|
|
private:
|
|
ForwardBlock(const V& val,
|
|
const std::vector<M>& jac)
|
|
: val_(val), jac_(jac)
|
|
{
|
|
#ifndef NDEBUG
|
|
const int num_elem = val_.size();
|
|
const int num_blocks = jac_.size();
|
|
for (int block = 0; block < num_blocks; ++block) {
|
|
assert(num_elem == jac_[block].rows());
|
|
}
|
|
#endif
|
|
}
|
|
|
|
V val_;
|
|
std::vector<M> jac_;
|
|
};
|
|
|
|
|
|
template <class Ostream, typename Scalar>
|
|
Ostream&
|
|
operator<<(Ostream& os, const ForwardBlock<Scalar>& fw)
|
|
{
|
|
return fw.print(os);
|
|
}
|
|
|
|
|
|
/// Multiply with sparse matrix from the left.
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator*(const typename ForwardBlock<Scalar>::M& lhs,
|
|
const ForwardBlock<Scalar>& rhs)
|
|
{
|
|
int num_blocks = rhs.numBlocks();
|
|
std::vector<typename ForwardBlock<Scalar>::M> jac(num_blocks);
|
|
assert(lhs.cols() == rhs.value().rows());
|
|
for (int block = 0; block < num_blocks; ++block) {
|
|
jac[block] = lhs*rhs.derivative()[block];
|
|
}
|
|
typename ForwardBlock<Scalar>::V val = lhs*rhs.value().matrix();
|
|
return ForwardBlock<Scalar>::function(val, jac);
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator*(const typename ForwardBlock<Scalar>::V& lhs,
|
|
const ForwardBlock<Scalar>& rhs)
|
|
{
|
|
return ForwardBlock<Scalar>::constant(lhs, rhs.blockPattern()) * rhs;
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator*(const ForwardBlock<Scalar>& lhs,
|
|
const typename ForwardBlock<Scalar>::V& rhs)
|
|
{
|
|
return rhs * lhs; // Commutative operation.
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator+(const typename ForwardBlock<Scalar>::V& lhs,
|
|
const ForwardBlock<Scalar>& rhs)
|
|
{
|
|
return ForwardBlock<Scalar>::constant(lhs, rhs.blockPattern()) + rhs;
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator+(const ForwardBlock<Scalar>& lhs,
|
|
const typename ForwardBlock<Scalar>::V& rhs)
|
|
{
|
|
return rhs + lhs; // Commutative operation.
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator-(const typename ForwardBlock<Scalar>::V& lhs,
|
|
const ForwardBlock<Scalar>& rhs)
|
|
{
|
|
return ForwardBlock<Scalar>::constant(lhs, rhs.blockPattern()) - rhs;
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator-(const ForwardBlock<Scalar>& lhs,
|
|
const typename ForwardBlock<Scalar>::V& rhs)
|
|
{
|
|
return lhs - ForwardBlock<Scalar>::constant(rhs, lhs.blockPattern());
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator/(const typename ForwardBlock<Scalar>::V& lhs,
|
|
const ForwardBlock<Scalar>& rhs)
|
|
{
|
|
return ForwardBlock<Scalar>::constant(lhs, rhs.blockPattern()) / rhs;
|
|
}
|
|
|
|
|
|
template <typename Scalar>
|
|
ForwardBlock<Scalar> operator/(const ForwardBlock<Scalar>& lhs,
|
|
const typename ForwardBlock<Scalar>::V& rhs)
|
|
{
|
|
return lhs / ForwardBlock<Scalar>::constant(rhs, lhs.blockPattern());
|
|
}
|
|
|
|
|
|
} // namespace Autodiff
|
|
|
|
|
|
|
|
#endif // OPM_AUTODIFFBLOCK_HEADER_INCLUDED
|