MatrixOperations.hpp 23.5 KB
Newer Older
GILLES Sebastien's avatar
GILLES Sebastien committed
1 2 3 4 5 6 7 8 9 10 11 12 13
/*!
//
// \file
//
//
// Created by Sebastien Gilles <sebastien.gilles@inria.fr> on the Fri, 30 Oct 2015 12:41:42 +0100
// Copyright (c) Inria. All rights reserved.
//
// \ingroup ThirdPartyGroup
// \addtogroup ThirdPartyGroup
// \{
*/

14

15 16
#ifndef MOREFEM_x_THIRD_PARTY_x_WRAPPERS_x_PETSC_x_MATRIX_x_MATRIX_OPERATIONS_HPP_
# define MOREFEM_x_THIRD_PARTY_x_WRAPPERS_x_PETSC_x_MATRIX_x_MATRIX_OPERATIONS_HPP_
17 18 19 20

# include <memory>
# include <vector>

21
# include "Utilities/Containers/EnumClass.hpp"
22

23 24
# include "ThirdParty/IncludeWithoutWarning/Petsc/PetscSys.hpp"
# include "ThirdParty/IncludeWithoutWarning/Petsc/PetscMat.hpp"
25

26 27
# include "ThirdParty/Wrappers/Petsc/Matrix/NonZeroPattern.hpp"
# include "ThirdParty/Wrappers/Petsc/Vector/Vector.hpp"
28
# include "ThirdParty/Wrappers/Petsc/Matrix/Internal/BaseMatrix.hpp"
29
# include "ThirdParty/Wrappers/Petsc/Exceptions/Petsc.hpp"
30 31


32
namespace MoReFEM
33
{
34 35


36 37 38 39
    // ============================
    //! \cond IGNORE_BLOCK_IN_DOXYGEN
    // Forward declarations.
    // ============================
40 41 42



43
    // Matrix actually used in MoReFEM, that wraps a Wrappers::Petsc::Matrix.
44
    class GlobalMatrix;
45

46 47 48 49 50 51 52

    // ============================
    // End of forward declarations.
    //! \endcond IGNORE_BLOCK_IN_DOXYGEN
    // ============================


53 54
    namespace Wrappers
    {
55 56


57 58
        namespace Petsc
        {
59 60


61 62 63 64 65 66 67 68
            /*!
             * \class doxygen_hide_petsc_do_reuse_matrix
             *
             * Whether matrix must be reused or initialized from scratch in functions such
             * as MatTransposeMatMult.
             * If yes, it must have been called once with no beforehand, and one has to be sure the pattern
             * of the matrices involved is still the same.
             */
69

70 71 72 73 74
            /*!
             * \class doxygen_hide_petsc_do_reuse_matrix_arg
             *
             * \param[in] do_reuse_matrix \copydetails doxygen_hide_petsc_do_reuse_matrix
             */
75 76


77 78 79 80
            /*!
             * \brief \copydoc doxygen_hide_petsc_do_reuse_matrix
             */
            enum class DoReuseMatrix { yes, no };
81

82 83 84
            /*!
             * \brief Wrapper over MatAXPY, that performs Y = a * X + Y.
             *
85
             *
86
             * \tparam NonZeroPatternT This value indicates the level of similarity between X and Y non zero patterns.
87
             * \warning Beware: if X and Y aren't following the same pattern, 'Same' won't yield what
88
             * you expect! In the case you're considering adding a part computed by a transfert matrix, you should
89
             * use 'Subset'. In MoReFEM, I advise you to call in debug mode AssertSameNumberingSubset()
90
             * (defined in Core) just before or after the function call; if the assert is raised it means you can't
91
             * use 'Same'. \todo This could be enforced by a proper overload (but it mix Utilities and Core
92
             * libraries...), but for the time being the separate assert will do.
93 94 95 96 97
             * \copydoc doxygen_hide_invoking_file_and_line
             *
             * \param[in] a See formula above.
             * \param[in] X See formula above.
             * \param[in] Y See formula above.
98
             */
99 100
            template
            <
101
                NonZeroPattern NonZeroPatternT,
102 103 104 105 106
                class MatrixT,
                class MatrixU
            >
            std::enable_if_t
            <
107 108
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
             && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value,
109 110
                void
            >
111
            AXPY(PetscScalar a,
112
                 const MatrixT& X,
113
                 MatrixU& Y,
114
                 const char* invoking_file, int invoking_line);
115 116


117 118 119
            /*!
             * \brief Wrapper over MatShift, that performs M = M + a I, where a is a PetscScalar and I is the identity matrix.
             *
120 121 122
             * \param[in] matrix See formula above.
             * \param[in] a See formula above.
             * \copydoc doxygen_hide_invoking_file_and_line
123 124 125 126
             */
            template<class MatrixT>
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
            MatShift(const PetscScalar a, MatrixT& matrix, const char* invoking_file, int invoking_line);
127 128


129 130 131
            /*!
             * \brief Wrapper over MatMult, that performs v2 = matrix * v1.
             *
132 133 134 135
             * \copydoc doxygen_hide_invoking_file_and_line
             * \param[in] matrix See formula above.
             * \param[in] v1 See formula above.
             * \param[in] v2 See formula above.
136
             * \copydoc doxygen_hide_do_update_ghost_arg
137 138
             */
            template<class MatrixT>
139
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
140 141 142
            MatMult(const MatrixT& matrix,
                    const Vector& v1,
                    Vector& v2,
143 144
                    const char* invoking_file, int invoking_line,
                    update_ghost do_update_ghost = update_ghost::yes);
145

146 147 148
            /*!
             * \brief Wrapper over MatTranspose, that performs in-place or out-of-place transpose of a matrix.
             *
149 150 151
             * \copydoc doxygen_hide_invoking_file_and_line
             * \param[in] matrix1 Matrix to transpose.
             * \param[in] matrix2 Matrix to contain the result of the transpose.
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
             *
             */
            template
            <
            class MatrixT,
            class MatrixU
            >
            std::enable_if_t
            <
            std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
            && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value,
            void
            >
            MatTranspose(MatrixT& matrix1,
                         MatrixU& matrix2,
                         const char* invoking_file, int invoking_line);
168 169


170 171 172
            /*!
             * \brief Wrapper over MatMultAdd, that performs v3 = v2 + matrix * v1.
             *
173 174 175 176 177
             * \copydoc doxygen_hide_invoking_file_and_line
             * \param[in] matrix See formula above.
             * \param[in] v1 See formula above.
             * \param[in] v2 See formula above.
             * \param[in] v3 See formula above.
178
             * \copydoc doxygen_hide_do_update_ghost_arg
179 180
             */
            template<class MatrixT>
181
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
182 183 184 185
            MatMultAdd(const MatrixT& matrix,
                       const Vector& v1,
                       const Vector& v2,
                       Vector& v3,
186 187
                       const char* invoking_file, int invoking_line,
                       update_ghost do_update_ghost = update_ghost::yes);
188 189 190



191 192 193
            /*!
             * \brief Wrapper over MatMultTranspose, that performs v2 = transpose(matrix) * v1.
             *
194
             * \copydoc doxygen_hide_invoking_file_and_line
195
             * \copydoc doxygen_hide_do_update_ghost_arg
196 197 198
             * \param[in] matrix See formula above.
             * \param[in] v1 See formula above.
             * \param[in] v2 See formula above.
199 200
             */
            template<class MatrixT>
201
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
202 203 204
            MatMultTranspose(const MatrixT& matrix,
                             const Vector& v1,
                             Vector& v2,
205 206
                             const char* invoking_file, int invoking_line,
                             update_ghost do_update_ghost = update_ghost::yes);
207 208


209 210 211
            /*!
             * \brief Wrapper over MatMultTransposeAdd, that performs v3 = v2 + transpose(matrix) * v1.
             *
212
             * \copydoc doxygen_hide_invoking_file_and_line
213
             * \copydoc doxygen_hide_do_update_ghost_arg
214 215 216 217
             * \param[in] matrix See formula above.
             * \param[in] v1 See formula above.
             * \param[in] v2 See formula above.
             * \param[in] v3 See formula above.
218 219
             */
            template<class MatrixT>
220
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
221 222 223 224
            MatMultTransposeAdd(const MatrixT& matrix,
                                const Vector& v1,
                                const Vector& v2,
                                Vector& v3,
225 226
                                const char* invoking_file, int invoking_line,
                                update_ghost do_update_ghost = update_ghost::yes);
227

228 229 230 231 232
            /*!
             * \class doxygen_hide_matmatmult_warning
             *
             * \attention In Petsc, matrix-matrix multiplication functions compute on the fly the
             * pattern for the resulting matrix. However, it is possible this pattern isn't the one expected;
233
             * in the richer MoReFEM interface you should call in debug mode \a AssertMatrixRespectPattern()
234
             * to make sure the resulting matrix respects the pattern defined for the \a GlobalMatrix pair
235
             * of \a NumberingSubset.
236 237 238 239 240
             *
             * \internal <b><tt>[internal]</tt></b> If you know Petsc, you might see I didn't give access to
             * argument MatReuse, setting it each time to MAT_INITIAL_MATRIX and skipping entirely MAT_REUSE_MATRIX.
             * This is because at the time being MatMatMult operations are seldom in the code (only Poromechanics so
             * far) and using Symbolic/Numeric seems more elegant. Of course, reintroducing the argument is really easy;
241
             * feel free to do so if you need it (for instance for MatMatMatMult support: Symbolic/Numeric doesn't
242 243
             * work for them and Petsc guys seemed unlikely to fix that in our exchanges).
             *
244
             * \internal <b><tt>[internal]</tt></b> \todo #684 Investigate to use the argument fill, which provides an
245
             * estimation of the non zero of the resulting matrix. Currently PETSC_DEFAULT is used.
246
             */
247 248 249



250
            /*!
251
             * \brief Wrapper over MatMatMult, that performs m3 = m1 * m2.
252
             *
253 254
             * \copydetails doxygen_hide_matmatmult_warning
             *
255 256
             * If the operation is performed many times with each time the same non zero pattern for the matrices,
             * rather use MatMatMultSymbolic/MatMatMultNumeric to improve efficiency.
257

258
             * One can also reuse a pattern for several matrices, but so far I do not need that in MoReFEM so
259
             * I equally use the default setting.
260 261 262
             * \param[in] m1 See formula above.
             * \param[in] m2 See formula above.
             * \param[in] m3 See formula above.
263
             *
264
             * \copydetails doxygen_hide_petsc_do_reuse_matrix_arg
265
             * \copydoc doxygen_hide_invoking_file_and_line
266
             */
267 268
            template
            <
269
            class MatrixT,
270 271
            class MatrixU,
            class MatrixV
272 273 274
            >
            std::enable_if_t
            <
275
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
276 277
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixV>::value,
278 279
                void
            >
280
            MatMatMult(const MatrixT& m1,
281 282
                       const MatrixU& m2,
                       MatrixV& m3,
283 284
                       const char* invoking_file, int invoking_line,
                       DoReuseMatrix do_reuse_matrix = DoReuseMatrix::no);
285 286


287
            /*!
288
             * \brief Wrapper over MatMatMatMult, that performs m4 = m1 * m2 * m3.
289
             *
290 291 292 293
             * \param[in] m1 See formula above.
             * \param[in] m2 See formula above.
             * \param[in] m3 See formula above.
             * \param[in] m4 See formula above.
294
             * \copydetails doxygen_hide_petsc_do_reuse_matrix_arg
295
             * \copydoc doxygen_hide_invoking_file_and_line
296
             */
297 298
            template
            <
299
            class MatrixT,
300 301 302
            class MatrixU,
            class MatrixV,
            class MatrixW
303 304 305
            >
            std::enable_if_t
            <
306
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
307 308 309
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixV>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixW>::value,
310 311
                void
            >
312
            MatMatMatMult(const MatrixT& m1,
313 314 315
                          const MatrixU& m2,
                          const MatrixV& m3,
                          MatrixW& m4,
316 317
                          const char* invoking_file, int invoking_line,
                          DoReuseMatrix do_reuse_matrix = DoReuseMatrix::no);
318

319 320 321
            /*!
             * \brief Creates a new matrix object that behaves like A'.
             *
322
             * The transpose A' is NOT actually formed! Rather the new matrix object performs the matrix-vector product
323 324 325
             * by using the MatMultTranspose() on the original matrix.
             *
             * \param[in] A matrix to transpose.
326
             * \param[out] transpose The matrix that figuratively represents A'. This matrix must not have been
327
             * allocated!
328
             * \copydoc doxygen_hide_invoking_file_and_line
329
             */
330 331 332 333 334
            template
            <
            class MatrixT,
            class MatrixU
            >
335 336
            std::enable_if_t
            <
337 338
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value,
339 340 341
                void
            >
            MatCreateTranspose(const MatrixT& A,
342
                               MatrixU& transpose,
343
                               const char* invoking_file, int invoking_line);
344 345


346
            /*!
347
             * \class doxygen_hide_mat_transpose_mat_mult
348
             *
349 350
             * Formula is:
             * \verbatim
351
             m3 = m1^T * m2.
352 353 354 355 356 357 358
             * \endverbatim
             *
             * \copydetails doxygen_hide_matmatmult_warning
             * \param[in] m1 See formula above.
             * \param[in] m2 See formula above.
             * \param[out] m3 See formula above. The matrix must be not allocated when this function is called.
             * \copydoc doxygen_hide_invoking_file_and_line
359
             */
360 361


362
            /*!
363
             * \brief Performs Matrix-Matrix Multiplication m3 = m1^T * m2.
364 365
             *
             * \copydetails doxygen_hide_mat_transpose_mat_mult
366
             * \copydetails doxygen_hide_petsc_do_reuse_matrix_arg
367
             */
368 369
            template
            <
370 371 372
                class MatrixT,
                class MatrixU,
                class MatrixV
373 374 375
            >
            std::enable_if_t
            <
376
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
377
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixV>::value,
378 379
                void
            >
380
            MatTransposeMatMult(const MatrixT& m1,
381 382
                                const MatrixU& m2,
                                MatrixV& m3,
383 384
                                const char* invoking_file, int invoking_line,
                                DoReuseMatrix do_reuse_matrix = DoReuseMatrix::no);
385 386 387



388 389 390
            /*!
             * \brief Performs Matrix-Matrix Multiplication C = A * B^T.
             *
391
             * \copydetails doxygen_hide_matmatmult_warning
392
             * \copydetails doxygen_hide_petsc_do_reuse_matrix_arg
393
             *
394 395 396
             * \param[in] matrix1 A in C = A * B^T.
             * \param[in] matrix2 B in C = A * B^T.
             * \param[out] matrix3 C in B in C = A * B^T. The matrix must be not allocated when this function is called.
397
             * \copydoc doxygen_hide_invoking_file_and_line
398 399 400
             */
            template
            <
401
            class MatrixT,
402 403
            class MatrixU,
            class MatrixV
404 405 406
            >
            std::enable_if_t
            <
407
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
408 409
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixV>::value,
410 411 412
                void
            >
            MatMatTransposeMult(const MatrixT& matrix1,
413 414
                                const MatrixU& matrix2,
                                MatrixV& matrix3,
415 416
                                const char* invoking_file, int invoking_line,
                                DoReuseMatrix do_reuse_matrix = DoReuseMatrix::no);
417 418


419 420 421
            /*!
             * \class doxygen_hide_mat_pt_a_p
             *
422
             * \warning Unfortunately a simple test with P = I leads to error
423
             * \verbatim
424 425 426
             [0;39m[0;49m[0]PETSC ERROR: Nonconforming object sizes
             [0]PETSC ERROR: Expected fill=-2 must be >= 1.0
             \endverbatim
427
             * The reason is that PETSC_DEFAULT may not be supported (I've asked Petsc developers); but even with
428 429 430 431 432 433 434 435 436
             * hand-tailored fill it doesn't seem to work...
             * So unfortunately I have to advise instead MatMatMult followed by MatTransposeMatMult instead...
             *
             * \copydetails doxygen_hide_matmatmult_warning
             *
             * \param[in] A A in C = P^T * A * P.
             * \param[in] P P in C = P^T * A * P
             * \param[out] out C in C = P^T * A * P. The matrix must be not allocated when this function is called.
             * \copydetails doxygen_hide_invoking_file_and_line
437
             * \copydoc doxygen_hide_petsc_do_reuse_matrix_arg
438
             */
439

440 441 442 443 444 445 446 447 448
            /*!
             * \brief Performs the matrix product C = P^T * A * P
             *
             * \copydoc doxygen_hide_mat_pt_a_p
             *
             *
             */
            template
            <
449
            class MatrixT,
450 451
            class MatrixU,
            class MatrixV
452 453 454
            >
            std::enable_if_t
            <
455
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
456 457
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixV>::value,
458 459 460
                void
            >
            PtAP(const MatrixT& A,
461 462
                 const MatrixU& P,
                 MatrixV& out,
463 464
                 const char* invoking_file, int invoking_line,
                 DoReuseMatrix do_reuse_matrix = DoReuseMatrix::no);
465 466 467



468 469 470 471 472 473
            /*!
             * \brief Wrapper over MatGetOrdering, gets a reordering for a matrix to reduce fill or to improve numerical stability of LU factorization.
             *
             * \see http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/MatOrderings/MatGetOrdering.html#MatGetOrdering
             * for more details.
             *
474 475 476 477
             * \param[in] A Matrix to get the ordering.
             * \param[in] type Type of the ordering.
             * \param[in] rperm Row permutation for the ordering.
             * \param[in] cperm Column permutation for the ordering.
478
             * \copydetails doxygen_hide_invoking_file_and_line
479 480 481 482 483 484 485 486 487
             *
             */
            template<class MatrixT>
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
            GetOrdering(MatrixT& A,
                        MatOrderingType type,
                        IS *rperm,
                        IS *cperm,
                        const char* invoking_file, int invoking_line);
488 489


490
            /*!
491
             * \brief Wrapper over MatLUFactor, that performs in-place LU factorization of matrix.
492 493 494 495
             *
             * \see http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/MatLUFactor.html#MatLUFactor
             * for more details.
             *
496 497 498 499 500
             * \param[in] A Matrix to factor.
             * \param[in] row Result of the GetOrdering.
             * \param[in] col Result of the GetOrdering.
             * \param[in] info Info of LUFactor.
             * \copydetails doxygen_hide_invoking_file_and_line
501 502 503 504 505 506 507 508
             *
             */
            template<class MatrixT>
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
            LUFactor(MatrixT& A,
                     IS row, IS col,
                     const MatFactorInfo *info,
                     const char* invoking_file, int invoking_line);
509 510


511 512 513 514 515 516
            /*!
             * \brief Wrapper over MatMatSolve, solves A X = B, given a factored matrix.
             *
             * \see http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/MatMatSolve.html
             * for more details.
             *
517 518 519 520
             * \param[in] A See formula above.
             * \param[in] B See formula above.
             * \param[in] X See formula above.
             * \copydetails doxygen_hide_invoking_file_and_line
521 522 523 524
             *
             */
            template
            <
GILLES Sebastien's avatar
GILLES Sebastien committed
525 526 527
                class MatrixT,
                class MatrixU,
                class MatrixV
528 529 530
            >
            std::enable_if_t
            <
GILLES Sebastien's avatar
GILLES Sebastien committed
531 532 533 534
                std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixU>::value
                && std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixV>::value,
                void
535 536 537 538 539
            >
            MatMatSolve(const MatrixT& A,
                        const MatrixU& B,
                        MatrixV& X,
                        const char* invoking_file, int invoking_line);
540 541


542 543 544 545 546 547
            /*!
             * \brief Wrapper over MatCholeskyFactor, that performs in-place Cholesky factorization of a symmetric matrix.
             *
             * \see http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/MatCholeskyFactor.html
             * for more details.
             *
548
             * \attention Not used yet, but might be useful in midterm developments. If finally too unwieldy for our
549 550
             * purposes it will be removed.
             *
551 552 553 554 555 556 557 558 559 560 561 562
             * \param[in] mat Matrix to factor.
             * \param[in] perm Result of the GetOrdering, row and column permutations.
             * \param[in] info Info of CholeskyFactor.
             * \copydetails doxygen_hide_invoking_file_and_line
             *
             */
            template<class MatrixT>
            std::enable_if_t<std::is_base_of<Internal::Wrappers::Petsc::BaseMatrix, MatrixT>::value, void>
            CholeskyFactor(MatrixT& mat,
                           IS perm,
                           const MatFactorInfo *info,
                           const char* invoking_file, int invoking_line);
563 564


565 566


567
        } //namespace Petsc
568 569


570
    } // namespace Wrappers
571 572 573 574



    /*!
575 576
     * \brief Convenient alias to avoid repeating the namespaces in each call.
     *
577
     * It should be used anyway only as template arguments of functions within this namespaces, such as
578 579 580
     * Wrappers::Petsc::AXPY.
     */
    using NonZeroPattern = Wrappers::Petsc::NonZeroPattern;
581 582


583
} // namespace MoReFEM
584 585


586 587 588
/// @} // addtogroup ThirdPartyGroup


589
# include "ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hxx"
590 591


592
#endif // MOREFEM_x_THIRD_PARTY_x_WRAPPERS_x_PETSC_x_MATRIX_x_MATRIX_OPERATIONS_HPP_