/usr/include/deal.II/lac/trilinos_solver.h is in libdeal.ii-dev 6.3.1-1.1.
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 | //---------------------------------------------------------------------------
// $Id: trilinos_solver.h 21131 2010-05-15 14:05:24Z kronbichler $
// Version: $Name$
//
// Copyright (C) 2008, 2009 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__trilinos_solver_h
#define __deal2__trilinos_solver_h
#include <base/config.h>
#ifdef DEAL_II_USE_TRILINOS
# include <base/std_cxx1x/shared_ptr.h>
# include <lac/exceptions.h>
# include <lac/solver_control.h>
# include <lac/vector.h>
# include <Epetra_LinearProblem.h>
# include <AztecOO.h>
# include <Epetra_Operator.h>
# include <Amesos.h>
DEAL_II_NAMESPACE_OPEN
namespace TrilinosWrappers
{
// forward declarations
class SparseMatrix;
class VectorBase;
class PreconditionBase;
/**
* Base class for solver classes using the Trilinos solvers. Since
* solvers in Trilinos 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. For a general discussion on the Trilinos solver package
* AztecOO, we refer to the <a href =
* "http://trilinos.sandia.gov/packages/aztecoo/AztecOOUserGuide.pdf">AztecOO
* user guide</a>.
*
* This solver class can also be used as a standalone class, where the
* respective Krylov method is set via the flag
* <tt>solver_name</tt>. This can be done at runtime (e.g., when
* parsing the solver from a ParameterList) and is similar to the
* deal.II class SolverSelector.
*
* @ingroup TrilinosWrappers
* @author Martin Kronbichler, 2008, 2009
*/
class SolverBase
{
public:
/**
* Enumeration object that is
* set in the constructor of
* the derived classes and
* tells Trilinos which solver
* to use. This option can also
* be set in the user program,
* so one might use this base
* class instead of one of the
* specialized derived classes
* when the solver should be
* set at runtime. Currently
* enabled options are:
*/
enum SolverName {cg, cgs, gmres, bicgstab, tfqmr} solver_name;
/**
* Standardized data struct to
* pipe additional data to the
* solver.
*/
struct AdditionalData
{
/**
* Sets the additional data field to
* the desired output format and puts
* the restart parameter in case the
* derived class is GMRES.
*
* TODO: Find a better way for
* setting the GMRES restart
* parameter since it is quite
* inelegant to set a specific option
* of one solver in the base class
* for all solvers.
*/
AdditionalData (const bool output_solver_details = false,
const unsigned int gmres_restart_parameter = 30);
/**
* Enables/disables the output of
* solver details (residual in each
* iterations etc.).
*/
const bool output_solver_details;
/**
* Restart parameter for GMRES
* solver.
*/
const unsigned int gmres_restart_parameter;
};
/**
* Constructor. Takes the
* solver control object and
* creates the solver.
*/
SolverBase (SolverControl &cn);
/**
* Second constructor. This
* constructor takes an enum
* object that specifies the
* solver name and sets the
* appropriate Krylov
* method.
*/
SolverBase (const enum SolverName solver_name,
SolverControl &cn);
/**
* 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 Trilinos
* is chosen.
*/
void
solve (const SparseMatrix &A,
VectorBase &x,
const VectorBase &b,
const PreconditionBase &preconditioner);
/**
* 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
* Trilinos is chosen. This class
* works with matrices according to
* the TrilinosWrappers format, but
* can take deal.II vectors as
* argument. Since deal.II are serial
* vectors (not distributed), this
* function does only what you expect
* in case the matrix is locally
* owned. Otherwise, an exception
* will be thrown.
*/
void
solve (const SparseMatrix &A,
dealii::Vector<double> &x,
const dealii::Vector<double> &b,
const PreconditionBase &preconditioner);
/**
* Access to object that controls
* convergence.
*/
SolverControl & control() const;
/**
* Exception
*/
DeclException1 (ExcTrilinosError,
int,
<< "An error with error number " << arg1
<< " occured while calling a Trilinos function");
protected:
/**
* Reference to the object that
* controls convergence of the
* iterative solver. In fact,
* for these Trilinos wrappers,
* Trilinos 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;
private:
/**
* A structure that collects
* the Trilinos sparse matrix,
* the right hand side vector
* and the solution vector,
* which is passed down to the
* Trilinos solver.
*/
std_cxx1x::shared_ptr<Epetra_LinearProblem> linear_problem;
/**
* A structure that contains
* the Trilinos solver and
* preconditioner objects.
*/
AztecOO solver;
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the solver interface using the Trilinos CG
* solver.
*
* @ingroup TrilinosWrappers
* @author Martin Kronbichler, 2008
*/
class SolverCG : public SolverBase
{
public:
/**
* Standardized data struct to
* pipe additional data to the
* solver.
*/
struct AdditionalData
{
/**
* Sets the additional data field to
* the desired output format.
*/
AdditionalData (const bool output_solver_details = false);
/**
* Enables/disables the output of
* solver details (residual in each
* iterations etc.).
*/
bool output_solver_details;
};
/**
* Constructor. In contrast to
* deal.II's own solvers, there is no
* need to give a vector memory
* object.
*
* The last argument takes a structure
* with additional, solver dependent
* flags for tuning.
*/
SolverCG (SolverControl &cn,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the solver interface using the Trilinos CGS
* solver.
*
* @ingroup TrilinosWrappers
* @author Martin Kronbichler, 2008
*/
class SolverCGS : public SolverBase
{
public:
/**
* Standardized data struct to
* pipe additional data to the
* solver.
*/
struct AdditionalData
{
/**
* Sets the additional data field to
* the desired output format.
*/
AdditionalData (const bool output_solver_details = false);
/**
* Enables/disables the output of
* solver details (residual in each
* iterations etc.).
*/
bool output_solver_details;
};
/**
* Constructor. In contrast to
* deal.II's own solvers, there is no
* need to give a vector memory
* object.
*
* The last argument takes a structure
* with additional, solver dependent
* flags for tuning.
*/
SolverCGS (SolverControl &cn,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the solver interface using the Trilinos GMRES
* solver.
*
* @author Martin Kronbichler, 2008
*/
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 bool output_solver_details = false,
const unsigned int restart_parameter = 30);
/**
* Enables/disables the output of
* solver details (residual in each
* iterations etc.).
*/
bool output_solver_details;
/**
* Maximum number of
* tmp vectors.
*/
unsigned int restart_parameter;
};
/**
* Constructor. In contrast to
* deal.II's own solvers, there is no
* need to give a vector memory
* object.
*
* The last argument takes a structure
* with additional, solver dependent
* flags for tuning.
*/
SolverGMRES (SolverControl &cn,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the solver interface using the Trilinos BiCGStab
* solver.
*
* @ingroup TrilinosWrappers
* @author Martin Kronbichler, 2008
*/
class SolverBicgstab : public SolverBase
{
public:
/**
* Standardized data struct to
* pipe additional data to the
* solver.
*/
struct AdditionalData
{
/**
* Sets the additional data field to
* the desired output format.
*/
AdditionalData (const bool output_solver_details = false);
/**
* Enables/disables the output of
* solver details (residual in each
* iterations etc.).
*/
bool output_solver_details;
};
/**
* Constructor. In contrast to
* deal.II's own solvers, there is no
* need to give a vector memory
* object.
*
* The last argument takes a structure
* with additional, solver dependent
* flags for tuning.
*/
SolverBicgstab (SolverControl &cn,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the solver interface using the Trilinos TFQMR
* solver.
*
* @ingroup TrilinosWrappers
* @author Martin Kronbichler, 2008
*/
class SolverTFQMR : public SolverBase
{
public:
/**
* Standardized data struct to
* pipe additional data to the
* solver.
*/
struct AdditionalData
{
/**
* Sets the additional data field to
* the desired output format.
*/
AdditionalData (const bool output_solver_details = false);
/**
* Enables/disables the output of
* solver details (residual in each
* iterations etc.).
*/
bool output_solver_details;
};
/**
* Constructor. In contrast to
* deal.II's own solvers, there is no
* need to give a vector memory
* object.
*
* The last argument takes a structure
* with additional, solver dependent
* flags for tuning.
*/
SolverTFQMR (SolverControl &cn,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the Trilinos KLU direct solver (using the Amesos
* package).
*
* @ingroup TrilinosWrappers
* @author Martin Kronbichler, 2009
*/
class SolverDirect
{
public:
/**
* Standardized data struct to
* pipe additional data to the
* solver.
*/
struct AdditionalData
{
/**
* Sets the additional data field to
* the desired output format.
*/
AdditionalData (const bool output_solver_details = false);
/**
* Enables/disables the output of
* solver details (residual in each
* iterations etc.).
*/
bool output_solver_details;
};
/**
* Constructor. Takes the
* solver control object and
* creates the solver.
*/
SolverDirect (SolverControl &cn,
const AdditionalData &data = AdditionalData());
/**
* Destructor.
*/
virtual ~SolverDirect ();
/**
* Solve the linear system
* <tt>Ax=b</tt>. Creates a KLU
* factorization of the matrix and
* performs the solve. Note that
* there is no need for a
* preconditioner here.
*/
void
solve (const SparseMatrix &A,
VectorBase &x,
const VectorBase &b);
/**
* 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
* Trilinos is chosen. This class
* works with matrices according to
* the TrilinosWrappers format, but
* can take deal.II vectors as
* argument. Since deal.II are serial
* vectors (not distributed), this
* function does only what you expect
* in case the matrix is locally
* owned. Otherwise, an exception
* will be thrown.
*/
void
solve (const SparseMatrix &A,
dealii::Vector<double> &x,
const dealii::Vector<double> &b);
/**
* Access to object that controls
* convergence.
*/
SolverControl & control() const;
/**
* Exception
*/
DeclException1 (ExcTrilinosError,
int,
<< "An error with error number " << arg1
<< " occured while calling a Trilinos function");
private:
/**
* Reference to the object that
* controls convergence of the
* iterative solver. In fact,
* for these Trilinos wrappers,
* Trilinos 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;
/**
* A structure that collects
* the Trilinos sparse matrix,
* the right hand side vector
* and the solution vector,
* which is passed down to the
* Trilinos solver.
*/
std_cxx1x::shared_ptr<Epetra_LinearProblem> linear_problem;
/**
* A structure that contains
* the Trilinos solver and
* preconditioner objects.
*/
std_cxx1x::shared_ptr<Amesos_BaseSolver> solver;
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
};
}
DEAL_II_NAMESPACE_CLOSE
#endif // DEAL_II_USE_TRILINOS
/*---------------------------- trilinos_solver.h ---------------------------*/
#endif
/*---------------------------- trilinos_solver.h ---------------------------*/
|