Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_MPBlockDiagonalPreconditioner.cpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Stokhos Package
4 //
5 // Copyright 2009 NTESS and the Stokhos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
11 #include "EpetraExt_BlockMultiVector.h"
12 
16  int num_mp_blocks_,
17  const Teuchos::RCP<const Epetra_Map>& base_map_,
18  const Teuchos::RCP<const Epetra_Map>& mp_map_,
20  const Teuchos::RCP<Teuchos::ParameterList>& params_) :
21  label("Stokhos MP Block Diagonal Preconditioner"),
22  mp_comm(mp_comm_),
23  num_mp_blocks(num_mp_blocks_),
24  base_map(base_map_),
25  mp_map(mp_map_),
26  prec_factory(prec_factory_),
27  block_precs(num_mp_blocks),
28  useTranspose(false)
29 {
30 }
31 
34 {
35 }
36 
37 void
40  const Epetra_Vector& x)
41 {
42  TEUCHOS_TEST_FOR_EXCEPTION(prec_factory == Teuchos::null, std::logic_error,
43  "Error! setupPreconditioner() cannot be called when " <<
44  "prec_factory is null!" << std::endl);
45 
47  mp_op->getMPOps();
48  for (int i=0; i<num_mp_blocks; i++)
49  block_precs[i] = prec_factory->compute(mp_ops->getCoeffPtr(i));
50  if (num_mp_blocks > 0) {
51  label = std::string("Stokhos MP Block Diagonal Preconditioner:\n") +
52  std::string(" ***** ") +
53  std::string(block_precs[0]->Label());
54  }
55 }
56 
57 int
59 SetUseTranspose(bool UseTheTranspose)
60 {
61  useTranspose = UseTheTranspose;
62  for (int i=0; i<num_mp_blocks; i++)
63  block_precs[i]->SetUseTranspose(useTranspose);
64 
65  return 0;
66 }
67 
68 int
70 Apply(const Epetra_MultiVector& Input, Epetra_MultiVector& Result) const
71 {
72  EpetraExt::BlockMultiVector mp_input(View, *base_map, Input);
73  EpetraExt::BlockMultiVector mp_result(View, *base_map, Result);
74  for (int i=0; i<num_mp_blocks; i++) {
75  block_precs[i]->Apply(*(mp_input.GetBlock(i)), *(mp_result.GetBlock(i)));
76  }
77 
78  return 0;
79 }
80 
81 int
84 {
85  EpetraExt::BlockMultiVector mp_input(View, *base_map, Input);
86  EpetraExt::BlockMultiVector mp_result(View, *base_map, Result);
87  for (int i=0; i<num_mp_blocks; i++) {
88  block_precs[i]->ApplyInverse(*(mp_input.GetBlock(i)),
89  *(mp_result.GetBlock(i)));
90  }
91 
92  return 0;
93 }
94 
95 double
97 NormInf() const
98 {
99  double product_nrm = 0.0;
100  for (int i=0; i<num_mp_blocks; i++) {
101  double nrm = block_precs[i]->NormInf();
102  if (nrm > product_nrm)
103  product_nrm = nrm;
104  }
105 
106  return product_nrm;
107 }
108 
109 
110 const char*
112 Label () const
113 {
114  return const_cast<char*>(label.c_str());
115 }
116 
117 bool
120 {
121  return useTranspose;
122 }
123 
124 bool
126 HasNormInf() const
127 {
128  if (num_mp_blocks == 0)
129  return false;
130  return block_precs[0]->HasNormInf();
131 }
132 
133 const Epetra_Comm &
135 Comm() const
136 {
137  return *mp_comm;
138 }
139 const Epetra_Map&
142 {
143  return *mp_map;
144 }
145 
146 const Epetra_Map&
149 {
150  return *mp_map;
151 }
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::BlockDiagonalOperator > &mp_op, const Epetra_Vector &x)
Setup preconditioner.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
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 const char * Label() const
Returns a character string describing the operator.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
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.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this matrix operator. ...
virtual Teuchos::RCP< Stokhos::ProductEpetraOperator > getMPOps()
Get multi-point ops.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
MPBlockDiagonalPreconditioner(const Teuchos::RCP< const EpetraExt::MultiComm > &mp_comm, int num_mp_blocks, const Teuchos::RCP< const Epetra_Map > &base_map, const Teuchos::RCP< const Epetra_Map > &mp_map, const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &prec_factory, const Teuchos::RCP< Teuchos::ParameterList > &params)
Constructor.
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 ...