5#ifndef DUNE_ISTL_SCALEDIDMATRIX_HH
6#define DUNE_ISTL_SCALEDIDMATRIX_HH
18#include <dune/common/exceptions.hh>
19#include <dune/common/fmatrix.hh>
20#include <dune/common/diagonalmatrix.hh>
21#include <dune/common/ftraits.hh>
28 template<
class K,
int n>
31 typedef DiagonalMatrixWrapper< ScaledIdentityMatrix<K,n> > WrapperType;
46 [[deprecated(
"Use free function blockLevel(). Will be removed after 2.8.")]]
84 return (
this==&other);
89 typedef ContainerWrapperIterator<const WrapperType, reference, reference>
Iterator;
100 return Iterator(WrapperType(
this),0);
106 return Iterator(WrapperType(
this),n);
113 return Iterator(WrapperType(
this),n-1);
120 return Iterator(WrapperType(
this),-1);
125 typedef ContainerWrapperIterator<const WrapperType, const_reference, const_reference>
ConstIterator;
205 template <
class Scalar,
206 std::enable_if_t<IsNumber<Scalar>::value,
int> = 0>
213 template <
class Scalar,
214 std::enable_if_t<IsNumber<Scalar>::value,
int> = 0>
225 return p_==other.
scalar();
231 return p_!=other.
scalar();
237 template<
class X,
class Y>
238 void mv (
const X& x, Y& y)
const
240#ifdef DUNE_FMatrix_WITH_CHECKING
241 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
242 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
249 template<
class X,
class Y>
250 void mtv (
const X& x, Y& y)
const
256 template<
class X,
class Y>
257 void umv (
const X& x, Y& y)
const
259#ifdef DUNE_FMatrix_WITH_CHECKING
260 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
261 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
268 template<
class X,
class Y>
269 void umtv (
const X& x, Y& y)
const
271#ifdef DUNE_FMatrix_WITH_CHECKING
272 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
273 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
280 template<
class X,
class Y>
281 void umhv (
const X& x, Y& y)
const
283#ifdef DUNE_FMatrix_WITH_CHECKING
284 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
285 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
288 y[i] += conjugateComplex(p_)*x[i];
292 template<
class X,
class Y>
293 void mmv (
const X& x, Y& y)
const
295#ifdef DUNE_FMatrix_WITH_CHECKING
296 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
297 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
304 template<
class X,
class Y>
305 void mmtv (
const X& x, Y& y)
const
307#ifdef DUNE_FMatrix_WITH_CHECKING
308 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
309 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
316 template<
class X,
class Y>
317 void mmhv (
const X& x, Y& y)
const
319#ifdef DUNE_FMatrix_WITH_CHECKING
320 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
321 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
324 y[i] -= conjugateComplex(p_)*x[i];
328 template<
class X,
class Y>
329 void usmv (
const K& alpha,
const X& x, Y& y)
const
331#ifdef DUNE_FMatrix_WITH_CHECKING
332 if (x.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
333 if (y.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
336 y[i] += alpha * p_ * x[i];
340 template<
class X,
class Y>
341 void usmtv (
const K& alpha,
const X& x, Y& y)
const
343#ifdef DUNE_FMatrix_WITH_CHECKING
344 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
345 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
348 y[i] += alpha * p_ * x[i];
352 template<
class X,
class Y>
353 void usmhv (
const K& alpha,
const X& x, Y& y)
const
355#ifdef DUNE_FMatrix_WITH_CHECKING
356 if (x.N()!=
N()) DUNE_THROW(FMatrixError,
"index out of range");
357 if (y.N()!=
M()) DUNE_THROW(FMatrixError,
"index out of range");
360 y[i] += alpha * conjugateComplex(p_) * x[i];
368 return fvmeta::sqrt(n*p_*p_);
386 return fvmeta::absreal(p_);
396 for (
int i=0; i<n; i++)
409 return std::pow(p_,n);
431#ifdef DUNE_FMatrix_WITH_CHECKING
432 if (i<0 || i>=n) DUNE_THROW(FMatrixError,
"row index out of range");
433 if (j<0 || j>=n) DUNE_THROW(FMatrixError,
"column index out of range");
445 s << ((i==j) ? a.p_ : 0) <<
" ";
454 return reference(
const_cast<K*
>(&p_), i);
495 template <
class DenseMatrix,
class field,
int N>
497 static void apply(DenseMatrix& denseMatrix,
499 assert(denseMatrix.M() == N);
500 assert(denseMatrix.N() == N);
501 denseMatrix = field(0);
502 for (
int i = 0; i < N; ++i)
503 denseMatrix[i][i] = rhs.
scalar();
507 template<
class K,
int n>
511 using real_type =
typename FieldTraits<field_type>::real_type;
Definition: allocator.hh:11
A multiple of the identity matrix of static size.
Definition: scaledidmatrix.hh:30
void usmhv(const K &alpha, const X &x, Y &y) const
y += alpha A^H x
Definition: scaledidmatrix.hh:353
void mmtv(const X &x, Y &y) const
y -= A^T x
Definition: scaledidmatrix.hh:305
ScaledIdentityMatrix & operator-=(const ScaledIdentityMatrix &y)
vector space subtraction
Definition: scaledidmatrix.hh:169
const_row_type::ConstIterator ConstColIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:131
ConstIterator end() const
end iterator
Definition: scaledidmatrix.hh:140
Iterator beforeBegin()
Definition: scaledidmatrix.hh:118
bool operator!=(const ScaledIdentityMatrix &other) const
incomparison operator
Definition: scaledidmatrix.hh:229
void mmv(const X &x, Y &y) const
y -= A x
Definition: scaledidmatrix.hh:293
std::size_t size_type
The type used for the index access and size operations.
Definition: scaledidmatrix.hh:43
void usmv(const K &alpha, const X &x, Y &y) const
y += alpha A x
Definition: scaledidmatrix.hh:329
row_type::Iterator ColIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:95
const_row_type const_reference
Definition: scaledidmatrix.hh:53
void mv(const X &x, Y &y) const
y = A x
Definition: scaledidmatrix.hh:238
void umtv(const X &x, Y &y) const
y += A^T x
Definition: scaledidmatrix.hh:269
void umhv(const X &x, Y &y) const
y += A^H x
Definition: scaledidmatrix.hh:281
DiagonalRowVector< K, n > row_type
Each row is implemented by a field vector.
Definition: scaledidmatrix.hh:50
ContainerWrapperIterator< const WrapperType, reference, reference > Iterator
Iterator class for sequential access.
Definition: scaledidmatrix.hh:89
Iterator beforeEnd()
Definition: scaledidmatrix.hh:111
K determinant() const
calculates the determinant of this matrix
Definition: scaledidmatrix.hh:408
K field_type
export the type representing the field
Definition: scaledidmatrix.hh:37
void usmtv(const K &alpha, const X &x, Y &y) const
y += alpha A^T x
Definition: scaledidmatrix.hh:341
Iterator end()
end iterator
Definition: scaledidmatrix.hh:104
Iterator iterator
typedef for stl compliant access
Definition: scaledidmatrix.hh:91
const K & scalar() const
Get const reference to the scalar diagonal value.
Definition: scaledidmatrix.hh:477
void umv(const X &x, Y &y) const
y += A x
Definition: scaledidmatrix.hh:257
static constexpr std::size_t blocklevel
We are at the leaf of the block recursion.
Definition: scaledidmatrix.hh:47
const K & diagonal(size_type) const
Get const reference to diagonal entry.
Definition: scaledidmatrix.hh:464
@ rows
The number of rows.
Definition: scaledidmatrix.hh:58
@ cols
The number of columns.
Definition: scaledidmatrix.hh:60
ScaledIdentityMatrix & operator=(const K &k)
Definition: scaledidmatrix.hh:75
ContainerWrapperIterator< const WrapperType, const_reference, const_reference > ConstIterator
Iterator class for sequential access.
Definition: scaledidmatrix.hh:125
K & diagonal(size_type)
Get reference to diagonal entry.
Definition: scaledidmatrix.hh:470
void solve(V &x, const V &b) const
Solve system A x = b.
Definition: scaledidmatrix.hh:394
bool exists(size_type i, size_type j) const
return true when (i,j) is in pattern
Definition: scaledidmatrix.hh:429
Iterator RowIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:93
ConstIterator const_iterator
typedef for stl compliant access
Definition: scaledidmatrix.hh:127
ScaledIdentityMatrix()
Default constructor.
Definition: scaledidmatrix.hh:66
bool operator==(const ScaledIdentityMatrix &other) const
comparison operator
Definition: scaledidmatrix.hh:223
ConstIterator beforeBegin() const
Definition: scaledidmatrix.hh:154
ScaledIdentityMatrix & operator/=(const K &k)
vector space division by scalar
Definition: scaledidmatrix.hh:196
friend std::ostream & operator<<(std::ostream &s, const ScaledIdentityMatrix< K, n > &a)
Sends the matrix to an output stream.
Definition: scaledidmatrix.hh:441
FieldTraits< field_type >::real_type frobenius_norm2() const
square of frobenius norm, need for block recursion
Definition: scaledidmatrix.hh:372
FieldTraits< field_type >::real_type frobenius_norm() const
frobenius norm: sqrt(sum over squared values of entries)
Definition: scaledidmatrix.hh:366
FieldTraits< field_type >::real_type infinity_norm() const
infinity norm (row sum norm, how to generalize for blocks?)
Definition: scaledidmatrix.hh:378
ConstIterator ConstRowIterator
rename the iterators for easier access
Definition: scaledidmatrix.hh:129
ConstIterator beforeEnd() const
Definition: scaledidmatrix.hh:147
size_type M() const
number of blocks in column direction
Definition: scaledidmatrix.hh:421
const_reference operator[](size_type i) const
Return const_reference object as row replacement.
Definition: scaledidmatrix.hh:458
ScaledIdentityMatrix(const K &k)
Constructor initializing the whole matrix with a scalar.
Definition: scaledidmatrix.hh:70
friend auto operator*(const ScaledIdentityMatrix &matrix, Scalar scalar)
vector space multiplication with scalar
Definition: scaledidmatrix.hh:207
FieldTraits< field_type >::real_type infinity_norm_real() const
simplified infinity norm (uses Manhattan norm for complex values)
Definition: scaledidmatrix.hh:384
ScaledIdentityMatrix & operator*=(const K &k)
vector space multiplication with scalar
Definition: scaledidmatrix.hh:189
bool identical(const ScaledIdentityMatrix< K, n > &other) const
Definition: scaledidmatrix.hh:82
void invert()
Compute inverse.
Definition: scaledidmatrix.hh:402
Iterator begin()
begin iterator
Definition: scaledidmatrix.hh:98
K & scalar()
Get reference to the scalar diagonal value.
Definition: scaledidmatrix.hh:484
row_type reference
Definition: scaledidmatrix.hh:51
K block_type
export the type representing the components
Definition: scaledidmatrix.hh:40
void mmhv(const X &x, Y &y) const
y -= A^H x
Definition: scaledidmatrix.hh:317
ScaledIdentityMatrix & operator+=(const ScaledIdentityMatrix &y)
vector space addition
Definition: scaledidmatrix.hh:162
DiagonalRowVectorConst< K, n > const_row_type
Definition: scaledidmatrix.hh:52
void mtv(const X &x, Y &y) const
y = A^T x
Definition: scaledidmatrix.hh:250
reference operator[](size_type i)
Return reference object as row replacement.
Definition: scaledidmatrix.hh:452
ConstIterator begin() const
begin iterator
Definition: scaledidmatrix.hh:134
size_type N() const
number of blocks in row direction
Definition: scaledidmatrix.hh:415
static void apply(DenseMatrix &denseMatrix, ScaledIdentityMatrix< field, N > const &rhs)
Definition: scaledidmatrix.hh:497
typename ScaledIdentityMatrix< K, n >::field_type field_type
Definition: scaledidmatrix.hh:510
typename FieldTraits< field_type >::real_type real_type
Definition: scaledidmatrix.hh:511