Thyra_StateFuncModelEvaluatorBase.hpp

Go to the documentation of this file.

// @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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_STATE_FUNC_MODEL_EVALUATOR_BASE_HPP
#define THYRA_STATE_FUNC_MODEL_EVALUATOR_BASE_HPP

#include "Thyra_ModelEvaluator.hpp"

namespace Thyra {

template<class Scalar>
class StateFuncModelEvaluatorBase : virtual public ModelEvaluator<Scalar> {
public:


  int Np() const;
  int Ng() const;
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > get_p_space(int l) const;
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > get_g_space(int j) const;
  ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
  ModelEvaluatorBase::InArgs<Scalar> getLowerBounds() const;
  ModelEvaluatorBase::InArgs<Scalar> getUpperBounds() const;
  Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> > create_W() const;
  Teuchos::RefCountPtr<LinearOpBase<Scalar> > create_W_op() const;
  Teuchos::RefCountPtr<LinearOpBase<Scalar> > create_DfDp_op(int l) const;
  Teuchos::RefCountPtr<LinearOpBase<Scalar> > create_DgDx_op(int j) const;
  Teuchos::RefCountPtr<LinearOpBase<Scalar> > create_DgDp_op( int j, int l ) const;
  void reportFinalPoint(
    const ModelEvaluatorBase::InArgs<Scalar>      &finalPoint
    ,const bool                                   wasSolved
    );

  
};

// /////////////////////////////////
// Implementations

// Public functions overridden from ModelEvaulator

template<class Scalar>
int StateFuncModelEvaluatorBase<Scalar>::Np() const
{ return 0; }

template<class Scalar>
int StateFuncModelEvaluatorBase<Scalar>::Ng() const
{ return 0; }

template<class Scalar>
Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >
StateFuncModelEvaluatorBase<Scalar>::get_p_space(int l) const
{
  TEST_FOR_EXCEPTION(
    true,std::logic_error
    ,"ModelEvaluator<"<<Teuchos::ScalarTraits<Scalar>::name()<<">::get_p_space(l): "
    "Error, this function was not overridden in *this = \'"<<this->description()<<"\'!"
    );
  return Teuchos::null;
}

template<class Scalar>
Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >
StateFuncModelEvaluatorBase<Scalar>::get_g_space(int j) const
{
  TEST_FOR_EXCEPTION(
    true,std::logic_error
    ,"ModelEvaluator<"<<Teuchos::ScalarTraits<Scalar>::name()<<">::get_g_space(j): "
    " Error, this function was not overridden in \'"
    <<this->description()<<"\'!"
    );
  return Teuchos::null;
}

template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
StateFuncModelEvaluatorBase<Scalar>::getNominalValues() const
{ return this->createInArgs(); }

template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
StateFuncModelEvaluatorBase<Scalar>::getLowerBounds() const
{ return this->createInArgs(); }

template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
StateFuncModelEvaluatorBase<Scalar>::getUpperBounds() const
{ return this->createInArgs(); }

template<class Scalar>
Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> >
StateFuncModelEvaluatorBase<Scalar>::create_W() const
{
  TEST_FOR_EXCEPTION(
    true, std::logic_error
    ,"Error, if \'W\' is supported by the ModelEvaluator subclass then"
    " this function create_W() must be overridden by the subclass to return"
    " a non-null object!"
    );
  return Teuchos::null; // Should never be called!
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
StateFuncModelEvaluatorBase<Scalar>::create_W_op() const
{
  TEST_FOR_EXCEPTION(
    true, std::logic_error
    ,"Error, if \'W\' is supported by the ModelEvaluator subclass then"
    " this function create_W() must be overridden by the subclass "
    <<this->description()<<" to return a non-null object!"
    );
  return Teuchos::null; // Should never be called!
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
StateFuncModelEvaluatorBase<Scalar>::create_DfDp_op(int l) const
{
  typedef ModelEvaluatorBase MEB;
  MEB::OutArgs<Scalar> outArgs = this->createOutArgs();
  TEST_FOR_EXCEPTION(
    outArgs.supports(MEB::OUT_ARG_DfDp,l).supports(MEB::DERIV_LINEAR_OP), std::logic_error
    ,"Error, The ModelEvaluator subclass "<<this->description()<<" says that it"
    " supports the LinearOpBae form of DfDp("<<l<<") (as determined from its OutArgs object created by createOutArgs())"
    " but this function create_DfDp_op(...) has not been overriden to create such an object!"
    );
  return Teuchos::null;
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
StateFuncModelEvaluatorBase<Scalar>::create_DgDx_op(int j) const
{
  typedef ModelEvaluatorBase MEB;
  MEB::OutArgs<Scalar> outArgs = this->createOutArgs();
  TEST_FOR_EXCEPTION(
    outArgs.supports(MEB::OUT_ARG_DgDx,j).supports(MEB::DERIV_LINEAR_OP), std::logic_error
    ,"Error, The ModelEvaluator subclass "<<this->description()<<" says that it"
    " supports the LinearOpBae form of DgDx("<<j<<") (as determined from its OutArgs object created by createOutArgs())"
    " but this function create_DgDx_op(...) has not been overriden to create such an object!"
    );
  return Teuchos::null;
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
StateFuncModelEvaluatorBase<Scalar>::create_DgDp_op( int j, int l ) const
{
  typedef ModelEvaluatorBase MEB;
  MEB::OutArgs<Scalar> outArgs = this->createOutArgs();
  TEST_FOR_EXCEPTION(
    outArgs.supports(MEB::OUT_ARG_DgDp,j,l).supports(MEB::DERIV_LINEAR_OP), std::logic_error
    ,"Error, The ModelEvaluator subclass "<<this->description()<<" says that it"
    " supports the LinearOpBae form of DgDp("<<j<<","<<l<<") (as determined from its OutArgs object created by createOutArgs())"
    " but this function create_DgDp_op(...) has not been overriden to create such an object!"
    );
  return Teuchos::null;
}

template<class Scalar>
void StateFuncModelEvaluatorBase<Scalar>::reportFinalPoint(
  const ModelEvaluatorBase::InArgs<Scalar>      &finalPoint
  ,const bool                                   wasSolved
  )
{
  // This final point is just ignored by default!
}

} // namespace Thyra

#endif // THYRA_STATE_FUNC_MODEL_EVALUATOR_BASE_HPP

---