Thyra_DiagonalQuadraticResponseOnlyModelEvaluator_decl.hpp

/*
// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
// 
// ***********************************************************************
// @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