Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_SchurPreconditioner.hpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Stokhos Package
6 // Copyright (2009) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 
45 
46 #ifndef STOKHOS_SCHURPRECONDITIONER_HPP
47 #define STOKHOS_SCHURPRECONDITIONER_HPP
48 
49 #include "Teuchos_RCP.hpp"
50 #include "Stokhos_Operator.hpp"
52 
53 namespace Stokhos {
54 
55  template <typename ordinal_type, typename value_type>
57  public Stokhos::Operator<ordinal_type, value_type> {
58  public:
59 
63  const ordinal_type p, const ordinal_type m, const ordinal_type diag);
64 
66  virtual ~SchurPreconditioner();
67 
68  virtual ordinal_type ApplyInverse(
71  ordinal_type prec_iters) const;
72 
73  protected:
76 
78  const ordinal_type p;
79  const ordinal_type m;
81 
82  }; // class SchurPreconditioner
83 
84 } // namespace Stokhos
85 
87 
88 #endif // STOKHOS_SCHURPRECONDITIONER_HPP
89 
Teuchos_RCP.hpp
Stokhos::SchurPreconditioner::p
const ordinal_type p
Definition: Stokhos_SchurPreconditioner.hpp:78
Stokhos::SchurPreconditioner::m
const ordinal_type m
Definition: Stokhos_SchurPreconditioner.hpp:79
Stokhos_SchurPreconditionerImp.hpp
Stokhos::SchurPreconditioner::diag
const ordinal_type diag
Definition: Stokhos_SchurPreconditioner.hpp:80
Stokhos::SchurPreconditioner::~SchurPreconditioner
virtual ~SchurPreconditioner()
Destructor.
Definition: Stokhos_SchurPreconditionerImp.hpp:62
TotalOrderBasisUnitTest::ordinal_type
int ordinal_type
Definition: Stokhos_LexicographicTreeBasisUnitTest.cpp:69
Stokhos
Top-level namespace for Stokhos classes and functions.
Definition: Stokhos_AbstractPreconditionerFactory.hpp:48
Stokhos::SchurPreconditioner::fact
ordinal_type fact(ordinal_type n) const
Definition: Stokhos_SchurPreconditionerImp.hpp:69
Teuchos_SerialDenseMatrix.hpp
Stokhos_Operator.hpp
Stokhos::SchurPreconditioner::size
ordinal_type size(ordinal_type n, ordinal_type m) const
Definition: Stokhos_SchurPreconditionerImp.hpp:81
Stokhos::SchurPreconditioner::K
const Teuchos::SerialDenseMatrix< ordinal_type, value_type > & K
Definition: Stokhos_SchurPreconditioner.hpp:77
Stokhos::Operator
Definition: Stokhos_Operator.hpp:52
Stokhos::SchurPreconditioner::ApplyInverse
virtual ordinal_type ApplyInverse(const Teuchos::SerialDenseMatrix< ordinal_type, value_type > &Input, Teuchos::SerialDenseMatrix< ordinal_type, value_type > &Result, ordinal_type prec_iters) const
Returns the result of a Operator inverse applied to a Teuchos::SerialDenseMatrix Input in Result.
Definition: Stokhos_SchurPreconditionerImp.hpp:106
Stokhos::SchurPreconditioner
Definition: Stokhos_SchurPreconditioner.hpp:56
Stokhos::SchurPreconditioner::SchurPreconditioner
SchurPreconditioner(const Teuchos::SerialDenseMatrix< ordinal_type, value_type > &K, const ordinal_type p, const ordinal_type m, const ordinal_type diag)
Constructor.
Definition: Stokhos_SchurPreconditionerImp.hpp:50
Teuchos::SerialDenseMatrix< ordinal_type, value_type >
n
int n