Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_FullyAssembledPreconditioner.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 
44 
47  const Teuchos::RCP<Stokhos::AbstractPreconditionerFactory>& prec_factory_,
48  const Teuchos::RCP<Teuchos::ParameterList>& params_) :
49  label("Stokhos Fully Assembled Preconditioner"),
50  prec_factory(prec_factory_),
51  prec()
52 {
53 }
54 
57 {
58 }
59 
60 void
62 setupPreconditioner(const Teuchos::RCP<Stokhos::SGOperator>& sg_op,
63  const Epetra_Vector& x)
64 {
65 
66  Teuchos::RCP<Stokhos::FullyAssembledOperator > fa_op =
67  Teuchos::rcp_dynamic_cast<Stokhos::FullyAssembledOperator>(sg_op, true);
68  prec = prec_factory->compute(Teuchos::rcp_dynamic_cast<Epetra_CrsMatrix>(fa_op));
69  label = std::string("Stokhos Fully Assembled Preconditioner:\n") +
70  std::string(" ***** ") +
71  std::string(prec->Label());
72 }
73 
74 int
76 SetUseTranspose(bool UseTheTranspose)
77 {
78  return prec->SetUseTranspose(UseTheTranspose);
79 }
80 
81 int
83 Apply(const Epetra_MultiVector& Input, Epetra_MultiVector& Result) const
84 {
85  return prec->Apply(Input, Result);
86 }
87 
88 int
90 ApplyInverse(const Epetra_MultiVector& Input, Epetra_MultiVector& Result) const
91 {
92  return prec->ApplyInverse(Input, Result);
93 }
94 
95 double
97 NormInf() const
98 {
99  return prec->NormInf();
100 }
101 
102 
103 const char*
105 Label () const
106 {
107  return const_cast<char*>(label.c_str());
108 }
109 
110 bool
113 {
114  return prec->UseTranspose();
115 }
116 
117 bool
119 HasNormInf() const
120 {
121  return prec->HasNormInf();
122 }
123 
124 const Epetra_Comm &
126 Comm() const
127 {
128  return prec->Comm();
129 }
130 const Epetra_Map&
133 {
134  return prec->OperatorDomainMap();
135 }
136 
137 const Epetra_Map&
140 {
141  return prec->OperatorRangeMap();
142 }
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
FullyAssembledPreconditioner(const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &prec_factory, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Constructor.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
virtual int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as ...
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
const IndexType const IndexType const IndexType const IndexType const ValueType const ValueType * x
Definition: csr_vector.h:260
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)
Setup preconditioner.
virtual int Apply(const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described ...
virtual const char * Label() const
Returns a character string describing the operator.
An Epetra operator representing the block stochastic Galerkin operator generated by fully assembling ...