Thyra_DiagonalQuadraticResponseOnlyModelEvaluator_decl.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_DIAGONAL_QUADRATIC_RESPONSE_ONLY_MODEL_EVALUATOR_DECL_HPP
#define THYRA_DIAGONAL_QUADRATIC_RESPONSE_ONLY_MODEL_EVALUATOR_DECL_HPP


#include "Thyra_ResponseOnlyModelEvaluatorBase.hpp"
#include "Teuchos_Comm.hpp"


namespace Thyra {


template<class Scalar>
class DiagonalQuadraticResponseOnlyModelEvaluator
   : public ResponseOnlyModelEvaluatorBase<Scalar>
{
public:



  DiagonalQuadraticResponseOnlyModelEvaluator(
    const int localDim,
    const RCP<const Teuchos::Comm<Ordinal> > &comm = Teuchos::null
    );

  void setSolutionVector(const RCP<const VectorBase<Scalar> > &ps);

  const RCP<const VectorBase<Scalar> >
  getSolutionVector() const;
  
  void setDiagonalVector(const RCP<const VectorBase<Scalar> > &diag);
  
  void setDiagonalBarVector(const RCP<const VectorBase<Scalar> > &diag_bar);

  void setNonlinearTermFactor(const Scalar &nonlinearTermFactor);

  void setScalarOffset(const Scalar &g_offset);



  int Np() const;
  int Ng() const;
  RCP<const VectorSpaceBase<Scalar> > get_p_space(int l) const;
  RCP<const VectorSpaceBase<Scalar> > get_g_space(int j) const;
  ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;


private:


  ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
  void evalModelImpl(
    const ModelEvaluatorBase::InArgs<Scalar>& inArgs,
    const ModelEvaluatorBase::OutArgs<Scalar>& outArgs
    ) const;


private:

  // //////////////////////
  // Private data members

  int Np_;
  int Ng_;
  RCP<const Teuchos::Comm<Ordinal> > comm_;
  const int localDim_;

  RCP<const VectorSpaceBase<Scalar> > g_space_;

  // Declared non-const so we can change the space in place!
  RCP<VectorSpaceBase<Scalar> > p_space_;

  RCP<const VectorBase<Scalar> > ps_;
  RCP<const VectorBase<Scalar> > diag_;
  Scalar nonlinearTermFactor_;
  Scalar g_offset_;

  RCP<const VectorBase<Scalar> > diag_bar_;
  RCP<const VectorBase<Scalar> > s_bar_;

};


template<class Scalar>
RCP<DiagonalQuadraticResponseOnlyModelEvaluator<Scalar> >
diagonalQuadraticResponseOnlyModelEvaluator(
  const int localDim,
  const RCP<const Teuchos::Comm<Ordinal> > &comm = Teuchos::null
  )
{
  using Teuchos::rcp;
  return rcp(new DiagonalQuadraticResponseOnlyModelEvaluator<Scalar>(localDim, comm));
}


} // namespace Thyra


#endif // THYRA_DIAGONAL_QUADRATIC_RESPONSE_ONLY_MODEL_EVALUATOR_DECL_HPP