/usr/include/deal.II/lac/petsc_solver.h is in libdeal.ii-dev 8.4.2-2+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 | // ---------------------------------------------------------------------
//
// Copyright (C) 2004 - 2016 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef dealii__petsc_solver_h
#define dealii__petsc_solver_h
#include <deal.II/base/config.h>
#ifdef DEAL_II_WITH_PETSC
# include <deal.II/lac/exceptions.h>
# include <deal.II/lac/solver_control.h>
# include <deal.II/base/std_cxx11/shared_ptr.h>
# include <petscksp.h>
#ifdef DEAL_II_WITH_SLEPC
#include <deal.II/lac/slepc_spectral_transformation.h>
#endif
DEAL_II_NAMESPACE_OPEN
#ifdef DEAL_II_WITH_SLEPC
namespace SLEPcWrappers
{
// forward declarations
class TransformationBase;
}
#endif
namespace PETScWrappers
{
// forward declarations
class MatrixBase;
class VectorBase;
class PreconditionerBase;
/**
* Base class for solver classes using the PETSc solvers. Since solvers in
* PETSc are selected based on flags passed to a generic solver object,
* basically all the actual solver calls happen in this class, and derived
* classes simply set the right flags to select one solver or another, or to
* set certain parameters for individual solvers.
*
* Optionally, the user can create a solver derived from the SolverBase
* class and can set the default arguments necessary to solve the linear
* system of equations with SolverControl. These default options can be
* overridden by specifying command line arguments of the form @p -ksp_*.
* For example, @p -ksp_monitor_true_residual prints out true residual norm
* (unpreconditioned) at each iteration and @p -ksp_view provides
* information about the linear solver and the preconditioner used in the
* current context. The type of the solver can also be changed during
* runtime by specifying @p -ksp_type {richardson, cg, gmres, fgmres, ..} to
* dynamically test the optimal solver along with a suitable preconditioner
* set using @p -pc_type {jacobi, bjacobi, ilu, lu, ..}. There are several
* other command line options available to modify the behavior of the PETSc
* linear solver and can be obtained from the <a
* href="http://www.mcs.anl.gov/petsc">documentation and manual pages</a>.
*
* @note Repeated calls to solve() on a solver object with a Preconditioner
* must be used with care. The preconditioner is initialized in the first
* call to solve() and subsequent calls reuse the solver and preconditioner
* object. This is done for performance reasons. The solver and
* preconditioner can be reset by calling reset().
*
* One of the gotchas of PETSc is that -- in particular in MPI mode -- it
* often does not produce very helpful error messages. In order to save
* other users some time in searching a hard to track down error, here is
* one situation and the error message one gets there: when you don't
* specify an MPI communicator to your solver's constructor. In this case,
* you will get an error of the following form from each of your parallel
* processes:
* @verbatim
* [1]PETSC ERROR: PCSetVector() line 1173 in src/ksp/pc/interface/precon.c
* [1]PETSC ERROR: Arguments must have same communicators!
* [1]PETSC ERROR: Different communicators in the two objects: Argument # 1 and 2!
* [1]PETSC ERROR: KSPSetUp() line 195 in src/ksp/ksp/interface/itfunc.c
* @endverbatim
*
* This error, on which one can spend a very long time figuring out what
* exactly goes wrong, results from not specifying an MPI communicator. Note
* that the communicator @em must match that of the matrix and all vectors
* in the linear system which we want to solve. Aggravating the situation is
* the fact that the default argument to the solver classes, @p
* PETSC_COMM_SELF, is the appropriate argument for the sequential case
* (which is why it is the default argument), so this error only shows up in
* parallel mode.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverBase
{
public:
/**
* Constructor. Takes the solver control object and the MPI communicator
* over which parallel computations are to happen.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverBase (SolverControl &cn,
const MPI_Comm &mpi_communicator);
/**
* Destructor.
*/
virtual ~SolverBase ();
/**
* Solve the linear system <tt>Ax=b</tt>. Depending on the information
* provided by derived classes and the object passed as a preconditioner,
* one of the linear solvers and preconditioners of PETSc is chosen.
* Repeated calls to solve() do not reconstruct the preconditioner for
* performance reasons. See class Documentation.
*/
void
solve (const MatrixBase &A,
VectorBase &x,
const VectorBase &b,
const PreconditionerBase &preconditioner);
/**
* Resets the contained preconditioner and solver object. See class
* description for more details.
*/
virtual void reset();
/**
* Sets a prefix name for the solver object. Useful when customizing the
* PETSc KSP object with command-line options.
*/
void set_prefix(const std::string &prefix);
/**
* Access to object that controls convergence.
*/
SolverControl &control() const;
/**
* initialize the solver with the preconditioner. This function is
* intended for use with SLEPc spectral transformation class.
*/
void initialize(const PreconditionerBase &preconditioner);
/**
* Exception
*/
DeclException1 (ExcPETScError,
int,
<< "An error with error number " << arg1
<< " occurred while calling a PETSc function");
protected:
/**
* Reference to the object that controls convergence of the iterative
* solver. In fact, for these PETSc wrappers, PETSc does so itself, but we
* copy the data from this object before starting the solution process,
* and copy the data back into it afterwards.
*/
SolverControl &solver_control;
/**
* Copy of the MPI communicator object to be used for the solver.
*/
const MPI_Comm mpi_communicator;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is requested by the derived class.
*/
virtual void set_solver_type (KSP &ksp) const = 0;
/**
* Solver prefix name to qualify options specific to the PETSc KSP object
* in the current context. Note: A hyphen (-) must NOT be given at the
* beginning of the prefix name. The first character of all runtime
* options is AUTOMATICALLY the hyphen.
*/
std::string prefix_name;
private:
/**
* A function that is used in PETSc as a callback to check on convergence.
* It takes the information provided from PETSc and checks it against
* deal.II's own SolverControl objects to see if convergence has been
* reached.
*/
static
PetscErrorCode convergence_test (KSP ksp,
const PetscInt iteration,
const PetscReal residual_norm,
KSPConvergedReason *reason,
void *solver_control);
/**
* A structure that contains the PETSc solver and preconditioner objects.
* This object is preserved between subsequent calls to the solver if the
* same preconditioner is used as in the previous solver step. This may
* save some computation time, if setting up a preconditioner is
* expensive, such as in the case of an ILU for example.
*
* The actual declaration of this class is complicated by the fact that
* PETSc changed its solver interface completely and incompatibly between
* versions 2.1.6 and 2.2.0 :-(
*
* Objects of this type are explicitly created, but are destroyed when the
* surrounding solver object goes out of scope, or when we assign a new
* value to the pointer to this object. The respective *Destroy functions
* are therefore written into the destructor of this object, even though
* the object does not have a constructor.
*/
struct SolverData
{
/**
* Destructor
*/
~SolverData ();
/**
* Object for Krylov subspace solvers.
*/
KSP ksp;
};
/**
* Pointer to an object that stores the solver context. This is recreated
* in the main solver routine if necessary.
*/
std_cxx11::shared_ptr<SolverData> solver_data;
#ifdef DEAL_II_WITH_SLEPC
/**
* Make the transformation class a friend, since it needs to set the KSP
* solver.
*/
friend class SLEPcWrappers::TransformationBase;
#endif
};
/**
* An implementation of the solver interface using the PETSc Richardson
* solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverRichardson : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{
/**
* Constructor. By default, set the damping parameter to one.
*/
explicit
AdditionalData (const double omega = 1);
/**
* Relaxation parameter.
*/
double omega;
};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverRichardson (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc Chebyshev (or,
* prior version 3.3, Chebychev) solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverChebychev : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverChebychev (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc CG solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverCG : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverCG (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc BiCG solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverBiCG : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverBiCG (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc GMRES solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverGMRES : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{
/**
* Constructor. By default, set the number of temporary vectors to 30,
* i.e. do a restart every 30 iterations.
*/
AdditionalData (const unsigned int restart_parameter = 30,
const bool right_preconditioning = false);
/**
* Maximum number of tmp vectors.
*/
unsigned int restart_parameter;
/**
* Flag for right preconditioning.
*/
bool right_preconditioning;
};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverGMRES (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc BiCGStab
* solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverBicgstab : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverBicgstab (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc CG Squared
* solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverCGS : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverCGS (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc TFQMR solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverTFQMR : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverTFQMR (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc TFQMR-2 solver
* (called TCQMR in PETSc). Note that this solver had a serious bug in
* versions up to and including PETSc 2.1.6, in that it did not check
* convergence and always returned an error code. Thus, this class will
* abort with an error indicating failure to converge with PETSc 2.1.6 and
* prior. This should be fixed in later versions of PETSc, though.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverTCQMR : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverTCQMR (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc CR solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverCR : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverCR (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc Least Squares
* solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004
*/
class SolverLSQR : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverLSQR (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the PETSc PREONLY solver.
* Actually this is NOT a real solution algorithm. solve() only applies the
* preconditioner once and returns immediately. Its only purpose is to
* provide a solver object, when the preconditioner should be used as a real
* solver. It is very useful in conjunction with the complete LU
* decomposition preconditioner <tt> PreconditionLU </tt>, which in
* conjunction with this solver class becomes a direct solver.
*
* @ingroup PETScWrappers
* @author Wolfgang Bangerth, 2004, Oliver Kayser-Herold, 2004
*/
class SolverPreOnly : public SolverBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor. In contrast to deal.II's own solvers, there is no need to
* give a vector memory object. However, PETSc solvers want to have an MPI
* communicator context over which computations are parallelized. By
* default, @p PETSC_COMM_SELF is used here, but you can change this. Note
* that for single processor (non-MPI) versions, this parameter does not
* have any effect.
*
* The last argument takes a structure with additional, solver dependent
* flags for tuning.
*
* Note that the communicator used here must match the communicator used
* in the system matrix, solution, and right hand side object of the solve
* to be done with this solver. Otherwise, PETSc will generate hard to
* track down errors, see the documentation of the SolverBase class.
*/
SolverPreOnly (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void set_solver_type (KSP &ksp) const;
};
/**
* An implementation of the solver interface using the sparse direct MUMPS
* solver through PETSc. This class has the usual interface of all other
* solver classes but it is of course different in that it doesn't implement
* an iterative solver. As a consequence, things like the SolverControl
* object have no particular meaning here.
*
* MUMPS allows to make use of symmetry in this matrix. In this class this
* is made possible by the set_symmetric_mode() function. If your matrix is
* symmetric, you can use this class as follows:
* @code
* SolverControl cn;
* PETScWrappers::SparseDirectMUMPS solver(cn, mpi_communicator);
* solver.set_symmetric_mode(true);
* solver.solve(system_matrix, solution, system_rhs);
* @endcode
*
* @note The class internally calls KSPSetFromOptions thus you are able to
* use all the PETSc parameters for MATSOLVERMUMPS package. See
* http://www.mcs.anl.gov/petsc/petsc-
* current/docs/manualpages/Mat/MATSOLVERMUMPS.html
*
* @ingroup PETScWrappers
* @author Daniel Brauss, Alexander Grayver, 2012
*/
class SparseDirectMUMPS : public SolverBase
{
public:
/**
* Standardized data structure to pipe additional data to the solver.
*/
struct AdditionalData
{};
/**
* Constructor
*/
SparseDirectMUMPS (SolverControl &cn,
const MPI_Comm &mpi_communicator = PETSC_COMM_SELF,
const AdditionalData &data = AdditionalData());
/**
* The method to solve the linear system.
*/
void solve (const MatrixBase &A,
VectorBase &x,
const VectorBase &b);
/**
* The method allows to take advantage if the system matrix is symmetric
* by using LDL^T decomposition instead of more expensive LU. The argument
* indicates whether the matrix is symmetric or not.
*/
void set_symmetric_mode (const bool flag);
protected:
/**
* Store a copy of flags for this particular solver.
*/
const AdditionalData additional_data;
virtual void set_solver_type (KSP &ksp) const;
private:
/**
* A function that is used in PETSc as a callback to check convergence. It
* takes the information provided from PETSc and checks it against
* deal.II's own SolverControl objects to see if convergence has been
* reached.
*/
static
PetscErrorCode convergence_test (KSP ksp,
const PetscInt iteration,
const PetscReal residual_norm,
KSPConvergedReason *reason,
void *solver_control);
/**
* A structure that contains the PETSc solver and preconditioner objects.
* Since the solve member function in the base is not used here, the
* private SolverData struct located in the base could not be used either.
*/
struct SolverDataMUMPS
{
/**
* Destructor
*/
~SolverDataMUMPS ();
KSP ksp;
PC pc;
};
std_cxx11::shared_ptr<SolverDataMUMPS> solver_data;
/**
* Flag specifies whether matrix being factorized is symmetric or not. It
* influences the type of the used preconditioner (PCLU or PCCHOLESKY)
*/
bool symmetric_mode;
};
}
DEAL_II_NAMESPACE_CLOSE
#endif // DEAL_II_WITH_PETSC
/*---------------------------- petsc_solver.h ---------------------------*/
#endif
/*---------------------------- petsc_solver.h ---------------------------*/
|