Thyra_ModelEvaluatorDelegatorBase.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_DEFAULT_MODEL_EVALUATOR_DELEGETOR_BASE_HPP
#define THYRA_DEFAULT_MODEL_EVALUATOR_DELEGETOR_BASE_HPP

#include "Thyra_ModelEvaluator.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"

namespace Thyra {

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


  ModelEvaluatorDelegatorBase();

  ModelEvaluatorDelegatorBase(
    const Teuchos::RefCountPtr<ModelEvaluator<Scalar> >   &model
    );

  ModelEvaluatorDelegatorBase(
    const Teuchos::RefCountPtr<const ModelEvaluator<Scalar> >   &model
    );

  void initialize(
    const Teuchos::RefCountPtr<ModelEvaluator<Scalar> >   &model
    );

  void initialize(
    const Teuchos::RefCountPtr<const ModelEvaluator<Scalar> >   &model
    );

  void uninitialize();



  virtual bool isUnderlyingModelConst() const;

  virtual Teuchos::RefCountPtr<ModelEvaluator<Scalar> > getNonconstUnderlyingModel();

  virtual Teuchos::RefCountPtr<const ModelEvaluator<Scalar> > getUnderlyingModel() const;



  int Np() const;
  int Ng() const;
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > get_x_space() const;
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > get_f_space() 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;
  ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
  ModelEvaluatorBase::OutArgs<Scalar> createOutArgs() const;
  void reportFinalPoint(
    const ModelEvaluatorBase::InArgs<Scalar>      &finalPoint
    ,const bool                                   wasSolved
    );


private:

  Teuchos::ConstNonconstObjectContainer<ModelEvaluator<Scalar> > model_;
  
};

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

// Constructors/initializers

template<class Scalar>
ModelEvaluatorDelegatorBase<Scalar>::ModelEvaluatorDelegatorBase()
{}

template<class Scalar>
ModelEvaluatorDelegatorBase<Scalar>::ModelEvaluatorDelegatorBase(
  const Teuchos::RefCountPtr<ModelEvaluator<Scalar> >   &model
  )
{
  this->initialize(model);
}

template<class Scalar>
ModelEvaluatorDelegatorBase<Scalar>::ModelEvaluatorDelegatorBase(
  const Teuchos::RefCountPtr<const ModelEvaluator<Scalar> >   &model
  )
{
  this->initialize(model);
}

template<class Scalar>
void ModelEvaluatorDelegatorBase<Scalar>::initialize(
  const Teuchos::RefCountPtr<ModelEvaluator<Scalar> >   &model
  )
{
  model_.initialize(model);
}

template<class Scalar>
void ModelEvaluatorDelegatorBase<Scalar>::initialize(
  const Teuchos::RefCountPtr<const ModelEvaluator<Scalar> >   &model
  )
{
  model_.initialize(model);
}

template<class Scalar>
void ModelEvaluatorDelegatorBase<Scalar>::uninitialize()
{
  model_.uninitialize();
}

// Virtual functions that can overriden

template<class Scalar>
bool ModelEvaluatorDelegatorBase<Scalar>::isUnderlyingModelConst() const
{
  return model_.isConst();
}

template<class Scalar>
Teuchos::RefCountPtr<ModelEvaluator<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::getNonconstUnderlyingModel()
{
  return model_.getNonconstObj();
}

template<class Scalar>
Teuchos::RefCountPtr<const ModelEvaluator<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::getUnderlyingModel() const
{
  return model_.getConstObj();
}

// Overridden from ModelEvaulator.

template<class Scalar>
int ModelEvaluatorDelegatorBase<Scalar>::Np() const
{
  return getUnderlyingModel()->Np();
}

template<class Scalar>
int ModelEvaluatorDelegatorBase<Scalar>::Ng() const
{
  return getUnderlyingModel()->Ng();
}

template<class Scalar>
Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::get_x_space() const
{
  return getUnderlyingModel()->get_x_space();
}

template<class Scalar>
Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::get_f_space() const
{
  return getUnderlyingModel()->get_f_space();
}

template<class Scalar>
Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::get_p_space(int l) const
{
  return getUnderlyingModel()->get_p_space(l);
}

template<class Scalar>
Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::get_g_space(int j) const
{
  return getUnderlyingModel()->get_g_space(j);
}

template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
ModelEvaluatorDelegatorBase<Scalar>::getNominalValues() const
{
  return getUnderlyingModel()->getNominalValues();
}

template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
ModelEvaluatorDelegatorBase<Scalar>::getLowerBounds() const
{
  return getUnderlyingModel()->getLowerBounds();
}

template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
ModelEvaluatorDelegatorBase<Scalar>::getUpperBounds() const
{
  return getUnderlyingModel()->getUpperBounds();
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::create_W() const
{
  return getUnderlyingModel()->create_W();
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::create_W_op() const
{
  return getUnderlyingModel()->create_W_op();
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::create_DfDp_op(int l) const
{
  return getUnderlyingModel()->create_DfDp_op(l);
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::create_DgDx_op(int j) const
{
  return getUnderlyingModel()->create_DgDx_op(j);
}

template<class Scalar>
Teuchos::RefCountPtr<LinearOpBase<Scalar> >
ModelEvaluatorDelegatorBase<Scalar>::create_DgDp_op( int j, int l ) const
{
  return getUnderlyingModel()->create_DgDp_op(j,l);
}

template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
ModelEvaluatorDelegatorBase<Scalar>::createInArgs() const
{
  ModelEvaluatorBase::InArgsSetup<Scalar> inArgs = getUnderlyingModel()->createInArgs();
  inArgs.setModelEvalDescription(this->description());
  return inArgs;
}

template<class Scalar>
ModelEvaluatorBase::OutArgs<Scalar>
ModelEvaluatorDelegatorBase<Scalar>::createOutArgs() const
{
  ModelEvaluatorBase::OutArgsSetup<Scalar> outArgs = getUnderlyingModel()->createOutArgs();
  outArgs.setModelEvalDescription(this->description());
  return outArgs;
}

template<class Scalar>
void ModelEvaluatorDelegatorBase<Scalar>::reportFinalPoint(
  const ModelEvaluatorBase::InArgs<Scalar>      &finalPoint
  ,const bool                                   wasSolved
  )
{
  getNonconstUnderlyingModel()->reportFinalPoint(finalPoint,wasSolved);
}

} // namespace Thyra

#endif // THYRA_DEFAULT_MODEL_EVALUATOR_DELEGETOR_BASE_HPP

---