/*! \mainpage Stratimikos: Thyra-based strategies for linear solvers
The package Stratimikos contains a unified set of Thyra-based wrappers to
linear solver and preconditioner capabilities in Trilinos. The word
"stratimikos" has no real meaning in itself; it was created from the Greek
words "stratigiki" and "grammikos" which mean "strategy" and "linear" in
English. The Stratimikos package is also a place where unified testing of
linear solvers and preconditioners can be performed. Given these object, you
can solve individual linear systems (see \ref stratimikos_examples_sec "examples").
Currently, Stratimikos is really just the single class
Stratimikos::LinearSolverBuilder which provides uniform access to
linear solver capabilities in Trilinos where the underlying operator can be
viewed as either an Epetra_CrsMatrix (or Epetra_RowMatrix)
object or a Tpetra::CrsMatrix (or Tpetra::RowMatrix>)
object. This class builds linear solvers using the Thyra linear solver and
preconditioner factory adapters listed below. The linear solver and
preconditioner factories are returned as
Thyra::LinearOpWithSolveFactoryBase and
Thyra::PreconditionerFactoryBase objects respectively.
The class Stratimikos::LinearSolverBuilder is parameter-list
driven. All valid parameters are given below:
\htmlonly
\endhtmlonly
An example parameter list in XML form that selects AztecOO and Ifpack
is shown below:
\verbinclude _aztecoo.ifpack.xml
Many other example XML input files (e.g. *.xml) can be found in the
directory stratimikos/example.
The example simple_stratimikos_example.cpp shows how to wrap Epetra
objects and then use Stratimikos::LinearSolverBuilder to solve
a linear system.
The example MixedOrderPhysicsBasedPreconditioner.cpp shows the use of
Stratimikos in a more sophisticated context.
See how all of the examples and tests are run by looking at
stratimikos/test/definition.
\section stratimikos_lows_adapters_sec Linear solver adapters
These adapters provide concrete subclasses implementing the abstract
interfaces Thyra::LinearOpWithSolveFactoryBase and
Thyra::LinearOpWithSolveBase. It is these implementations that are
used in the implementation of Stratimikos::LinearSolverBuilder
but they can also be used on their own.
- Thyra::AmesosLinearOpWithSolveFactory : Amesos/Thyra adapters.
- Thyra::AztecOOLinearOpWithSolveFactory : AztecOO/Thyra adapters.
- Thyra::BelosLinearOpWithSolveFactory : Belos/Thyra adapters.
\section stratimikos_pf_adapters_sec Preconditioner adapters
These adapters provide concrete subclasses implementing the abstract interface
Thyra::PreconditionerFactoryBase. It is these implementations that
are used in the implementation of
Stratimikos::LinearSolverBuilder but can also be used on their
own.
- Thyra::IfpackPreconditionerFactory : Ifpack/Thyra adapters.
- Thyra::MLPreconditionerFactory : ML/Thyra adapters.
\section stratimikos_examples_sec Stratimikos examples
\section stratimikos_browser_sec Stratimikos browser
You can browse all of Stratimikos as a single
doxygen collection. Warning, this is not the recommended way to learn
about Stratimikos software. However, this is a good way to browse the directory structure of stratimikos, to locate files, etc.
*/