Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_BlockDiagonalOperator.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 
43 #include "EpetraExt_BlockMultiVector.h"
44 #include "Epetra_Map.h"
45 
49  int num_mp_blocks_,
50  const Teuchos::RCP<const Epetra_Map>& domain_base_map_,
51  const Teuchos::RCP<const Epetra_Map>& range_base_map_,
52  const Teuchos::RCP<const Epetra_Map>& domain_mp_map_,
53  const Teuchos::RCP<const Epetra_Map>& range_mp_map_) :
54  label("Stokhos Block Diagonal Operator"),
55  mp_comm(mp_comm_),
56  num_mp_blocks(num_mp_blocks_),
57  domain_base_map(domain_base_map_),
58  range_base_map(range_base_map_),
59  domain_mp_map(domain_mp_map_),
60  range_mp_map(range_mp_map_),
61  block_ops(),
62  useTranspose(false)
63 {
64 }
65 
68 {
69 }
70 
71 void
75 {
76  block_ops = ops;
77 }
78 
82 {
83  return block_ops;
84 }
85 
88 getMPOps() const
89 {
90  return block_ops;
91 }
92 
93 int
95 SetUseTranspose(bool UseTheTranspose)
96 {
97  useTranspose = UseTheTranspose;
98  for (int i=0; i<num_mp_blocks; i++)
99  (*block_ops)[i].SetUseTranspose(useTranspose);
100 
101  return 0;
102 }
103 
104 int
106 Apply(const Epetra_MultiVector& Input, Epetra_MultiVector& Result) const
107 {
108  Teuchos::RCP<const Epetra_BlockMap> input_base_map, result_base_map;
109  if (useTranspose) {
110  input_base_map = range_base_map;
111  result_base_map = domain_base_map;
112  }
113  else {
114  input_base_map = domain_base_map;
115  result_base_map = range_base_map;
116  }
117  EpetraExt::BlockMultiVector mp_input(View, *input_base_map, Input);
118  EpetraExt::BlockMultiVector mp_result(View, *result_base_map, Result);
119  for (int i=0; i<num_mp_blocks; i++) {
120  (*block_ops)[i].Apply(*(mp_input.GetBlock(i)), *(mp_result.GetBlock(i)));
121  }
122 
123  return 0;
124 }
125 
126 int
128  Epetra_MultiVector& Result) const
129 {
130  Teuchos::RCP<const Epetra_BlockMap> input_base_map, result_base_map;
131  if (useTranspose) {
132  input_base_map = domain_base_map;
133  result_base_map = range_base_map;
134  }
135  else {
136  input_base_map = range_base_map;
137  result_base_map = domain_base_map;
138  }
139  EpetraExt::BlockMultiVector mp_input(View, *input_base_map, Input);
140  EpetraExt::BlockMultiVector mp_result(View, *range_base_map, Result);
141  for (int i=0; i<num_mp_blocks; i++) {
142  (*block_ops)[i].ApplyInverse(*(mp_input.GetBlock(i)),
143  *(mp_result.GetBlock(i)));
144  }
145 
146  return 0;
147 }
148 
149 double
151 {
152  double product_nrm = 0.0;
153  for (int i=0; i<num_mp_blocks; i++) {
154  double nrm = (*block_ops)[i].NormInf();
155  if (nrm > product_nrm)
156  product_nrm = nrm;
157  }
158 
159  return product_nrm;
160 }
161 
162 
163 const char*
165 {
166  return const_cast<char*>(label.c_str());
167 }
168 
169 bool
171 {
172  return useTranspose;
173 }
174 
175 bool
177 {
178  if (num_mp_blocks == 0)
179  return false;
180  return (*block_ops)[0].HasNormInf();
181 }
182 
183 const Epetra_Comm &
185 {
186  return *mp_comm;
187 }
188 const Epetra_Map&
190 {
191  if (useTranspose)
192  return *range_mp_map;
193  return *domain_mp_map;
194 }
195 
196 const Epetra_Map&
198 {
199  if (useTranspose)
200  return *domain_mp_map;
201  return *range_mp_map;
202 }
virtual const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range 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 int SetUseTranspose(bool UseTranspose)
Set to true if the transpose of the operator is requested.
BlockDiagonalOperator(const Teuchos::RCP< const EpetraExt::MultiComm > &mp_comm, int num_mp_blocks, 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_mp_map, const Teuchos::RCP< const Epetra_Map > &range_mp_map)
Constructor.
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
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 double NormInf() const
Returns an approximate infinity norm of the operator matrix.
virtual void setupOperator(const Teuchos::RCP< Stokhos::ProductEpetraOperator > &ops)
Setup operator.
virtual bool HasNormInf() const
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
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 const char * Label() const
Returns a character string describing the operator.
virtual const Epetra_Comm & Comm() const
Returns a reference to the Epetra_Comm communicator associated with this operator.