Thyra_RowStatLinearOpBase.hpp

// @HEADER
// *****************************************************************************
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//
// Copyright 2004 NTESS and the Thyra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef THYRA_ROW_SUM_LINEAR_OP_BASE_HPP
#define THYRA_ROW_SUM_LINEAR_OP_BASE_HPP

#include "Thyra_LinearOpBase_decl.hpp"


namespace Thyra {


namespace RowStatLinearOpBaseUtils {


enum ERowStat {
  ROW_STAT_INV_ROW_SUM,
  ROW_STAT_ROW_SUM,
  ROW_STAT_INV_COL_SUM,
  ROW_STAT_COL_SUM
};


} // namespace RowStatLinearOpBaseUtils


template<class Scalar>
class RowStatLinearOpBase : virtual public LinearOpBase<Scalar> {
public:


  bool rowStatIsSupported(
    const RowStatLinearOpBaseUtils::ERowStat rowStat
    ) const
    { return rowStatIsSupportedImpl(rowStat); }

  void getRowStat(
    const RowStatLinearOpBaseUtils::ERowStat rowStat,
    const Ptr<VectorBase<Scalar> > &rowStatVec
    ) const
    {
      TEUCHOS_ASSERT(rowStatIsSupported(rowStat));
      getRowStatImpl(rowStat, rowStatVec);
    }


protected:


  virtual bool rowStatIsSupportedImpl(
    const RowStatLinearOpBaseUtils::ERowStat rowStat) const = 0;

  virtual void getRowStatImpl(
    const RowStatLinearOpBaseUtils::ERowStat rowStat,
    const Ptr<VectorBase<Scalar> > &rowStatVec) const = 0;


};


} // end namespace Thyra


#endif  // THYRA_SCALED_LINEAR_OP_BASE_HPP