Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_SGPreconditionerFactory.cpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stokhos Package
5// Copyright (2009) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
38//
39// ***********************************************************************
40// @HEADER
41
42#include "Stokhos_ConfigDefs.h"
52#include "Teuchos_Assert.hpp"
53
55SGPreconditionerFactory(const Teuchos::RCP<Teuchos::ParameterList>& params_) :
56 params(params_)
57{
58 prec_method = params->get("Preconditioner Method", "Mean-based");
59}
60
61bool
63isPrecSupported() const
64{
65 return prec_method != "None";
66}
67
68Teuchos::RCP<Stokhos::SGPreconditioner>
70build(const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
71 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
72 const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
73 const Teuchos::RCP<const Epetra_Map>& base_map,
74 const Teuchos::RCP<const Epetra_Map>& sg_map)
75{
76 Teuchos::RCP<Stokhos::SGPreconditioner> sg_prec;
77
78 if (prec_method == "Mean-based") {
79 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory =
80 buildMeanPreconditionerFactory();
81 sg_prec = Teuchos::rcp(new Stokhos::MeanBasedPreconditioner(
82 sg_comm, sg_basis, epetraCijk,
83 base_map, sg_map, prec_factory,
84 params));
85 }
86 else if (prec_method == "Approximate Gauss-Seidel") {
87 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory =
88 buildMeanPreconditionerFactory();
89 sg_prec = Teuchos::rcp(new Stokhos::ApproxGaussSeidelPreconditioner(
90 sg_comm, sg_basis, epetraCijk,
91 base_map, sg_map, prec_factory,
92 params));
93 }
94 else if (prec_method == "Approximate Jacobi") {
95 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory =
96 buildMeanPreconditionerFactory();
97 sg_prec = Teuchos::rcp(new Stokhos::ApproxJacobiPreconditioner(
98 sg_comm, sg_basis, epetraCijk,
99 base_map, sg_map, prec_factory,
100 params));
101 }
102 else if (prec_method == "Approximate Schur Complement") {
103 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory =
104 buildMeanPreconditionerFactory();
105 sg_prec = Teuchos::rcp(new Stokhos::ApproxSchurComplementPreconditioner(
106 sg_comm, sg_basis, epetraCijk,
107 base_map, sg_map, prec_factory,
108 params));
109 }
110#ifdef HAVE_STOKHOS_NOX
111 else if (prec_method == "Gauss-Seidel") {
112 Teuchos::RCP<NOX::Epetra::LinearSystem> det_solver =
113 params->get< Teuchos::RCP<NOX::Epetra::LinearSystem> >("Deterministic Solver");
114 sg_prec = Teuchos::rcp(new Stokhos::GaussSeidelPreconditioner(
115 sg_comm, sg_basis, epetraCijk,
116 base_map, sg_map, det_solver,
117 params));
118 }
119#endif
120 else if (prec_method == "Kronecker Product") {
121 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> mean_prec_factory =
122 buildMeanPreconditionerFactory();
123 std::string G_prec_name =
124 params->get("G Preconditioner Type", "Ifpack");
125 Teuchos::RCP<Teuchos::ParameterList> G_prec_params =
126 Teuchos::rcp(&(params->sublist("G Preconditioner Parameters")),false);
127 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> G_prec_factory =
128 Teuchos::rcp(new Stokhos::PreconditionerFactory(G_prec_name,
129 G_prec_params));
130 sg_prec = Teuchos::rcp(new Stokhos::KroneckerProductPreconditioner(
131 sg_comm, sg_basis, epetraCijk, base_map, sg_map,
132 mean_prec_factory, G_prec_factory, params));
133 }
134 else if (prec_method == "Fully Assembled") {
135 std::string prec_name =
136 params->get("Fully Assembled Preconditioner Type", "Ifpack");
137 Teuchos::RCP<Teuchos::ParameterList> prec_params =
138 Teuchos::rcp(&(params->sublist("Fully Assembled Preconditioner Parameters")),false);
139 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> prec_factory =
140 Teuchos::rcp(new Stokhos::PreconditionerFactory(prec_name, prec_params));
141 sg_prec = Teuchos::rcp(new Stokhos::FullyAssembledPreconditioner(
142 prec_factory, params));
143 }
144 else if (prec_method == "None")
145 sg_prec = Teuchos::null;
146 else
147 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
148 "Error! Unknown preconditioner method " << prec_method
149 << "." << std::endl);
150
151 return sg_prec;
152}
153
154Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>
157{
158 std::string prec_name =
159 params->get("Mean Preconditioner Type", "Ifpack");
160 Teuchos::RCP<Teuchos::ParameterList> precParams =
161 Teuchos::rcp(&params->sublist("Mean Preconditioner Parameters"),false);
162 return Teuchos::rcp(new Stokhos::PreconditionerFactory(prec_name,
163 precParams));
164}
A stochastic preconditioner based on applying one iteration of approximate Gauss-Seidel.
A stochastic preconditioner based on applying two iterations of approximate Jacobi.
A stochastic preconditioner based on applying the approximate Schur complement preconditioner as defi...
A stochastic preconditioner based on applying a preconditioner to the fully assembled operator.
An Epetra operator representing applying the mean in a block stochastic Galerkin expansion.
A stochastic preconditioner based on applying the inverse of the mean.
Abstract base class for multivariate orthogonal polynomials.
An class for building preconditioners.
virtual bool isPrecSupported() const
Return whether a preconditioner will be supported.
SGPreconditionerFactory(const Teuchos::RCP< Teuchos::ParameterList > &params)
Constructor.
Teuchos::RCP< Teuchos::ParameterList > params
Preconditioner parameters.
std::string prec_method
Preconditioner method.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > buildMeanPreconditionerFactory()
Build preconditioner factory for mean.
virtual Teuchos::RCP< Stokhos::SGPreconditioner > build(const Teuchos::RCP< const EpetraExt::MultiComm > &sg_comm, const Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > &sg_basis, const Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > &epetraCijk, const Teuchos::RCP< const Epetra_Map > &base_map, const Teuchos::RCP< const Epetra_Map > &sg_map)
Build preconditioner operator.