Teko Version of the Day
Loading...
Searching...
No Matches
Teko_StridedEpetraOperator.hpp
1/*
2// @HEADER
3//
4// ***********************************************************************
5//
6// Teko: A package for block and physics based preconditioning
7// Copyright 2010 Sandia Corporation
8//
9// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
10// the U.S. Government retains certain rights in this software.
11//
12// Redistribution and use in source and binary forms, with or without
13// modification, are permitted provided that the following conditions are
14// met:
15//
16// 1. Redistributions of source code must retain the above copyright
17// notice, this list of conditions and the following disclaimer.
18//
19// 2. Redistributions in binary form must reproduce the above copyright
20// notice, this list of conditions and the following disclaimer in the
21// documentation and/or other materials provided with the distribution.
22//
23// 3. Neither the name of the Corporation nor the names of the
24// contributors may be used to endorse or promote products derived from
25// this software without specific prior written permission.
26//
27// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38//
39// Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
40//
41// ***********************************************************************
42//
43// @HEADER
44
45*/
46
47#ifndef __Teko_StridedEpetraOperator_hpp__
48#define __Teko_StridedEpetraOperator_hpp__
49
50// Epetra includes
51#include "Epetra_Operator.h"
52
53// Teuchos includes
54#include "Teuchos_RCP.hpp"
55
56#include "Thyra_LinearOpBase.hpp"
57
58// Teko includes
59#include "Teko_BlockedReordering.hpp"
60#include "Teko_EpetraOperatorWrapper.hpp"
61#include "Teko_StridedMappingStrategy.hpp"
62
63namespace Teko {
64namespace Epetra {
65
66class StridedEpetraOperator : public EpetraOperatorWrapper {
67public:
68 enum eNormType { Inf, One, Frobenius};
69
70 StridedEpetraOperator(int numVars,const Teuchos::RCP<const Epetra_Operator> & content,
71 const std::string & label="<ANYM>");
72 StridedEpetraOperator(const std::vector<int> & vars,const Teuchos::RCP<const Epetra_Operator> & content,
73 const std::string & label="<ANYM>");
74
75 virtual void SetContent(const std::vector<int> & vars,const Teuchos::RCP<const Epetra_Operator> & content);
76
77 virtual void RebuildOps()
78 { BuildBlockedOperator(); }
79
80 virtual const Teuchos::RCP<const Epetra_Operator> GetContent() const
81 { return fullContent_; }
82
83 // virtual const Teuchos::RCP<Epetra_Operator> GetContent()
84 // { return fullContent_; }
85
86 const Teuchos::RCP<const Epetra_Operator> GetBlock(int i,int j) const;
87
91 void Reorder(const BlockReorderManager & brm);
92
94 void RemoveReording();
95
98 virtual void WriteBlocks(const std::string & prefix) const;
99
107 virtual std::string PrintNorm(const eNormType & nrmType=Frobenius,const char newline='\n');
108
109 // functions overloading Epetra_Operator
111
112 // destructor
113 virtual ~StridedEpetraOperator() {}
114
115 // attribute set methods
116
117 // don't use transpose...ever!
118 virtual int SetUseTranspose(bool /* useTranspose */)
119 { return -1; }
120
121 virtual int ApplyInverse(const Epetra_MultiVector &/* X */, Epetra_MultiVector &/* Y */) const
122 { TEUCHOS_ASSERT(false); return -1; }
123
124 virtual double NormInf() const
125 { TEUCHOS_ASSERT(false); return 0.0; }
126
127 // attribute access functions
128 virtual bool UseTranspose() const { return false; }
129 virtual bool HasNormInf() const { return false; }
130 virtual const Epetra_Comm & Comm() const { return fullContent_->Comm(); }
131
132
134 bool testAgainstFullOperator(int count,double tol) const;
135
136protected:
137 // gooey center of this shell
138 Teuchos::RCP<const Epetra_Operator> fullContent_;
139 Teuchos::RCP<StridedMappingStrategy> stridedMapping_;
140 Teuchos::RCP<Thyra::LinearOpBase<double> > stridedOperator_;
141 Teuchos::RCP<const BlockReorderManager> reorderManager_;
142
143 std::string label_;
144
145 void BuildBlockedOperator();
146};
147
148} // end namespace Epetra
149} // end namespace Teko
150
151#endif