Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_SGOperatorFactory.hpp
Go to the documentation of this file.
1// $Id$
2// $Source$
3// @HEADER
4// ***********************************************************************
5//
6// Stokhos Package
7// Copyright (2009) Sandia Corporation
8//
9// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10// license for use of this work by or on behalf of the U.S. Government.
11//
12// Redistribution and use in source and binary forms, with or without
13// modification, are permitted provided that the following conditions are
14// met:
15//
16// 1. Redistributions of source code must retain the above copyright
17// notice, this list of conditions and the following disclaimer.
18//
19// 2. Redistributions in binary form must reproduce the above copyright
20// notice, this list of conditions and the following disclaimer in the
21// documentation and/or other materials provided with the distribution.
22//
23// 3. Neither the name of the Corporation nor the names of the
24// contributors may be used to endorse or promote products derived from
25// this software without specific prior written permission.
26//
27// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38//
39// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
40//
41// ***********************************************************************
42// @HEADER
43
44#ifndef STOKHOS_SG_OPERATOR_FACTORY_HPP
45#define STOKHOS_SG_OPERATOR_FACTORY_HPP
46
47#include "Teuchos_RCP.hpp"
48#include "Teuchos_ParameterList.hpp"
50#include "EpetraExt_MultiComm.h"
53#include "Epetra_Map.h"
54
55namespace Stokhos {
56
59 public:
60
63 const Teuchos::RCP<Teuchos::ParameterList>& params);
64
66 virtual ~SGOperatorFactory() {}
67
69 virtual Teuchos::RCP<Stokhos::SGOperator>
70 build(
71 const Teuchos::RCP<const EpetraExt::MultiComm>& sg_comm,
72 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
73 const Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>& epetraCijk,
74 const Teuchos::RCP<const Epetra_Map>& domain_base_map,
75 const Teuchos::RCP<const Epetra_Map>& range_base_map,
76 const Teuchos::RCP<const Epetra_Map>& domain_sg_map,
77 const Teuchos::RCP<const Epetra_Map>& range_sg_map);
78
79 private:
80
83
86
87 protected:
88
90 Teuchos::RCP<Teuchos::ParameterList> params;
91
92 }; // class SGOperatorFactory
93
94} // namespace Stokhos
95
96#endif // STOKHOS_SG_OPERATOR_FACTORY_HPP
Abstract base class for multivariate orthogonal polynomials.
Factory for generating stochastic Galerkin preconditioners.
virtual Teuchos::RCP< Stokhos::SGOperator > 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 > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map, const Teuchos::RCP< const Epetra_Map > &domain_sg_map, const Teuchos::RCP< const Epetra_Map > &range_sg_map)
Build preconditioner operator.
Teuchos::RCP< Teuchos::ParameterList > params
Operator parameters.
SGOperatorFactory(const Teuchos::RCP< Teuchos::ParameterList > &params)
Constructor.
SGOperatorFactory & operator=(const SGOperatorFactory &)
Private to prohibit copying.
SGOperatorFactory(const SGOperatorFactory &)
Private to prohibit copying.
Top-level namespace for Stokhos classes and functions.