Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_RowStatLinearOpBase.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
5 // Copyright (2004) 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 Roscoe A. Bartlett (bartlettra@ornl.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef THYRA_ROW_SUM_LINEAR_OP_BASE_HPP
43 #define THYRA_ROW_SUM_LINEAR_OP_BASE_HPP
44 
45 #include "Thyra_LinearOpBase_decl.hpp"
46 
47 
48 namespace Thyra {
49 
50 
51 namespace RowStatLinearOpBaseUtils {
52 
53 
55 enum ERowStat {
57  ROW_STAT_INV_ROW_SUM,
59  ROW_STAT_ROW_SUM,
61  ROW_STAT_INV_COL_SUM,
63  ROW_STAT_COL_SUM
64 };
65 
66 
67 } // namespace RowStatLinearOpBaseUtils
68 
69 
75 template<class Scalar>
76 class RowStatLinearOpBase : virtual public LinearOpBase<Scalar> {
77 public:
78 
81 
84  const RowStatLinearOpBaseUtils::ERowStat rowStat
85  ) const
86  { return rowStatIsSupportedImpl(rowStat); }
87 
92  void getRowStat(
93  const RowStatLinearOpBaseUtils::ERowStat rowStat,
94  const Ptr<VectorBase<Scalar> > &rowStatVec
95  ) const
96  {
98  getRowStatImpl(rowStat, rowStatVec);
99  }
100 
102 
103 protected:
104 
107 
109  virtual bool rowStatIsSupportedImpl(
110  const RowStatLinearOpBaseUtils::ERowStat rowStat) const = 0;
111 
113  virtual void getRowStatImpl(
114  const RowStatLinearOpBaseUtils::ERowStat rowStat,
115  const Ptr<VectorBase<Scalar> > &rowStatVec) const = 0;
116 
118 
119 };
120 
121 
122 } // end namespace Thyra
123 
124 
125 #endif // THYRA_SCALED_LINEAR_OP_BASE_HPP
void getRowStat(const RowStatLinearOpBaseUtils::ERowStat rowStat, const Ptr< VectorBase< Scalar > > &rowStatVec) const
Get some statistics about a supported row.
bool rowStatIsSupported(const RowStatLinearOpBaseUtils::ERowStat rowStat) const
Determine if a given row stat is supported.
Abstract interface for finite-dimensional dense vectors.
virtual void getRowStatImpl(const RowStatLinearOpBaseUtils::ERowStat rowStat, const Ptr< VectorBase< Scalar > > &rowStatVec) const =0
Base class for all linear operators.
virtual bool rowStatIsSupportedImpl(const RowStatLinearOpBaseUtils::ERowStat rowStat) const =0
Interface for exxtracting row statistics as a VectorBase from a supporting LinearOpBase object...
#define TEUCHOS_ASSERT(assertion_test)