Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_SGPreconditionerFactory.hpp
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#ifndef STOKHOS_SG_PRECONDITIONER_FACTORY_HPP
43#define STOKHOS_SG_PRECONDITIONER_FACTORY_HPP
44
45#include "Teuchos_RCP.hpp"
46#include "Teuchos_ParameterList.hpp"
48#include "EpetraExt_MultiComm.h"
51#include "Epetra_Map.h"
53
54namespace Stokhos {
55
58 public:
59
62 const Teuchos::RCP<Teuchos::ParameterList>& params);
63
66
68 virtual bool isPrecSupported() const;
69
71 virtual Teuchos::RCP<Stokhos::SGPreconditioner>
72 build(
73 const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
74 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
75 const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
76 const Teuchos::RCP<const Epetra_Map>& base_map,
77 const Teuchos::RCP<const Epetra_Map>& sg_map);
78
79 protected:
80
82 Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>
84
85 private:
86
89
92
93 protected:
94
96 Teuchos::RCP<Teuchos::ParameterList> params;
97
99 std::string prec_method;
100
101 }; // class SGPreconditionerFactory
102
103} // namespace Stokhos
104
105#endif // STOKHOS_SG_PRECONDITIONER_FACTORY_HPP
Abstract base class for multivariate orthogonal polynomials.
Factory for generating stochastic Galerkin preconditioners.
virtual bool isPrecSupported() const
Return whether a preconditioner will be supported.
SGPreconditionerFactory(const SGPreconditionerFactory &)
Private to prohibit copying.
Teuchos::RCP< Teuchos::ParameterList > params
Preconditioner parameters.
SGPreconditionerFactory & operator=(const SGPreconditionerFactory &)
Private to prohibit copying.
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.
Top-level namespace for Stokhos classes and functions.