Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_MPMeanBasedPreconditioner.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  mean_prec(),
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  mean_prec = prec_factory->compute(mp_ops->getCoeffPtr(0));
49  if (num_mp_blocks > 0) {
50  label = std::string("Stokhos MP Mean Preconditioner:\n") +
51  std::string(" ***** ") +
52  std::string(mean_prec->Label());
53  }
54 }
55 
56 int
58 SetUseTranspose(bool UseTheTranspose)
59 {
60  useTranspose = UseTheTranspose;
61  mean_prec->SetUseTranspose(useTranspose);
62 
63  return 0;
64 }
65 
66 int
68 Apply(const Epetra_MultiVector& Input, Epetra_MultiVector& Result) const
69 {
70  EpetraExt::BlockMultiVector mp_input(View, *base_map, Input);
71  EpetraExt::BlockMultiVector mp_result(View, *base_map, Result);
72  for (int i=0; i<num_mp_blocks; i++) {
73  mean_prec->Apply(*(mp_input.GetBlock(i)), *(mp_result.GetBlock(i)));
74  }
75 
76  return 0;
77 }
78 
79 int
82 {
83  EpetraExt::BlockMultiVector mp_input(View, *base_map, Input);
84  EpetraExt::BlockMultiVector mp_result(View, *base_map, Result);
85  for (int i=0; i<num_mp_blocks; i++) {
86  mean_prec->ApplyInverse(*(mp_input.GetBlock(i)), *(mp_result.GetBlock(i)));
87  }
88 
89  return 0;
90 }
91 
92 double
94 NormInf() const
95 {
96  return mean_prec->NormInf();
97 }
98 
99 
100 const char*
102 Label () const
103 {
104  return const_cast<char*>(label.c_str());
105 }
106 
107 bool
110 {
111  return useTranspose;
112 }
113 
114 bool
116 HasNormInf() const
117 {
118  return mean_prec->HasNormInf();
119 }
120 
121 const Epetra_Comm &
123 Comm() const
124 {
125  return *mp_comm;
126 }
127 const Epetra_Map&
130 {
131  return *mp_map;
132 }
133 
134 const Epetra_Map&
137 {
138  return *mp_map;
139 }
virtual const char * Label() const
Returns a character string describing the operator.
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 ...
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this matrix operator.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.
virtual void setupPreconditioner(const Teuchos::RCP< Stokhos::BlockDiagonalOperator > &mp_op, const Epetra_Vector &x)
Setup preconditioner.
virtual double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
MPMeanBasedPreconditioner(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 bool UseTranspose() const
Returns the current UseTranspose setting.
virtual Teuchos::RCP< Stokhos::ProductEpetraOperator > getMPOps()
Get multi-point ops.
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 ...