Teko Version of the Day
Loading...
Searching...
No Matches
Teko_BlockedTpetraOperator.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_BlockedTpetraOperator_hpp__
48#define __Teko_BlockedTpetraOperator_hpp__
49
50// Tpetra includes
51#include "Tpetra_Operator.hpp"
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_TpetraOperatorWrapper.hpp"
61#include "Teko_TpetraBlockedMappingStrategy.hpp"
62#include "Teko_ConfigDefs.hpp"
63
64namespace Teko {
65namespace TpetraHelpers {
66
71public:
72
81 BlockedTpetraOperator(const std::vector<std::vector<GO> > & vars,
82 const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & content,
83 const std::string & label="<ANYM>");
84
93 virtual void SetContent(const std::vector<std::vector<GO> > & vars,
94 const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & content);
95
99 virtual void RebuildOps()
100 { BuildBlockedOperator(); }
101
102 virtual const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > GetContent() const
103 { return fullContent_; }
104
105 virtual const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > GetContent()
106 { return fullContent_; }
107
108 const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > GetBlock(int i,int j) const;
109
113 void Reorder(const BlockReorderManager & brm);
114
116 void RemoveReording();
117
120 virtual void WriteBlocks(const std::string & prefix) const;
121
122 // functions overloading Tpetra::Operator<ST,LO,GO,NT>
124
125 // destructor
126 virtual ~BlockedTpetraOperator() {}
127
128 // attribute set methods
129
130 // don't use transpose...ever!
131 virtual int SetUseTranspose(bool /* useTranspose */)
132 { return -1; }
133
134 virtual int ApplyInverse(const Tpetra::MultiVector<ST,LO,GO,NT> &/* X */, Tpetra::MultiVector<ST,LO,GO,NT> &/* Y */) const
135 { TEUCHOS_ASSERT(false); return -1; }
136
137 virtual double NormInf() const
138 { TEUCHOS_ASSERT(false); return 0.0; }
139
140 // attribute access functions
141 virtual bool UseTranspose() const { return false; }
142 virtual bool HasNormInf() const { return false; }
143 virtual const Teuchos::Comm<int> & Comm() const { return *fullContent_->getRangeMap()->getComm(); }
144
146 bool testAgainstFullOperator(int count,ST tol) const;
147
148protected:
149 // gooey center of this shell
150 Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > fullContent_;
151 Teuchos::RCP<TpetraBlockedMappingStrategy> blockedMapping_;
152 Teuchos::RCP<Thyra::LinearOpBase<ST> > blockedOperator_;
153 Teuchos::RCP<const BlockReorderManager> reorderManager_;
154
155 std::string label_;
156
157 void BuildBlockedOperator();
158};
159
160} // end namespace TpetraHelpers
161} // end namespace Teko
162
163#endif
Tear about a user specified Tpetra::Operator<ST,LO,GO,NT> (CrsMatrix) using a vector of vectors of GI...
virtual void SetContent(const std::vector< std::vector< GO > > &vars, const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &content)
virtual void WriteBlocks(const std::string &prefix) const
BlockedTpetraOperator(const std::vector< std::vector< GO > > &vars, const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &content, const std::string &label="<ANYM>")
bool testAgainstFullOperator(int count, ST tol) const
Helps perform sanity checks.
void RemoveReording()
Remove any reordering on this object.
Implements the Epetra_Operator interface with a Thyra LinearOperator. This enables the use of absrtac...