Thyra_DefaultNominalBoundsOverrideModelEvaluator.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_DEFAULT_NOMINAL_BOUNDS_OVERRIDE_MODEL_EVALUATOR_HPP
#define THYRA_DEFAULT_NOMINAL_BOUNDS_OVERRIDE_MODEL_EVALUATOR_HPP


#include "Thyra_ModelEvaluatorDelegatorBase.hpp"
#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
#include "Teuchos_Time.hpp"


namespace Thyra {


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

  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;


  DefaultNominalBoundsOverrideModelEvaluator();

  DefaultNominalBoundsOverrideModelEvaluator(
    const RCP<ModelEvaluator<Scalar> > &thyraModel,
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &nominalValues,
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &lowerBounds = Teuchos::null,
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &upperBounds = Teuchos::null
    );

  void initialize(
    const RCP<ModelEvaluator<Scalar> > &thyraModel,
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &nominalValues,
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &lowerBounds = Teuchos::null,
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &upperBounds = Teuchos::null
    );
  
  void setNominalValues(
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> >  &nominalValues
    );
  
  void setLowerBounds(
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> >  &lowerBounds
    );
  
  void setUpperBounds(
    const RCP<const ModelEvaluatorBase::InArgs<Scalar> >  &upperBounds
    );
  
  // ToDo: Add functions to reset lower and upper bounds when needed!



  std::string description() const;



  ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
  ModelEvaluatorBase::InArgs<Scalar> getLowerBounds() const;
  ModelEvaluatorBase::InArgs<Scalar> getUpperBounds() const;


private:


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


private:

  RCP<const ModelEvaluatorBase::InArgs<Scalar> >  nominalValues_;
  RCP<const ModelEvaluatorBase::InArgs<Scalar> >  lowerBounds_;
  RCP<const ModelEvaluatorBase::InArgs<Scalar> >  upperBounds_;
  
};


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


// Constructors/initializers/accessors/utilities


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


template<class Scalar>
DefaultNominalBoundsOverrideModelEvaluator<Scalar>::DefaultNominalBoundsOverrideModelEvaluator(
  const RCP<ModelEvaluator<Scalar> > &thyraModel,
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &nominalValues,
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &lowerBounds,
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &upperBounds
  )
{
  initialize(thyraModel,nominalValues,lowerBounds,upperBounds);
}


template<class Scalar>
void DefaultNominalBoundsOverrideModelEvaluator<Scalar>::initialize(
  const RCP<ModelEvaluator<Scalar> > &thyraModel,
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &nominalValues,
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &lowerBounds,
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> > &upperBounds
  )
{
  this->ModelEvaluatorDelegatorBase<Scalar>::initialize(thyraModel);
  nominalValues_ = nominalValues;
  lowerBounds_ = lowerBounds;
  upperBounds_ = upperBounds;
}


template<class Scalar>
void DefaultNominalBoundsOverrideModelEvaluator<Scalar>::setNominalValues(
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> >  &nominalValues
  )
{
  nominalValues_ = nominalValues;
}


template<class Scalar>
void DefaultNominalBoundsOverrideModelEvaluator<Scalar>::setLowerBounds(
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> >  &lowerBounds
  )
{
  lowerBounds_ = lowerBounds;
}


template<class Scalar>
void DefaultNominalBoundsOverrideModelEvaluator<Scalar>::setUpperBounds(
  const RCP<const ModelEvaluatorBase::InArgs<Scalar> >  &upperBounds
  )
{
  upperBounds_ = upperBounds;
}


// Public functions overridden from Teuchos::Describable


template<class Scalar>
std::string DefaultNominalBoundsOverrideModelEvaluator<Scalar>::description() const
{
  const RCP<const ModelEvaluator<Scalar> >
    thyraModel = this->getUnderlyingModel();
  std::ostringstream oss;
  oss << "Thyra::DefaultNominalBoundsOverrideModelEvaluator{";
  oss << "thyraModel=";
  if(thyraModel.get())
    oss << "\'"<<thyraModel->description()<<"\'";
  else
    oss << "NULL";
  oss << "}";
  return oss.str();
}


// Overridden from ModelEvaulator.


template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
DefaultNominalBoundsOverrideModelEvaluator<Scalar>::getNominalValues() const
{
  if(nominalValues_.get())
    return *nominalValues_;
  return this->getUnderlyingModel()->getNominalValues();
}


template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
DefaultNominalBoundsOverrideModelEvaluator<Scalar>::getLowerBounds() const
{
  if(lowerBounds_.get())
    return *lowerBounds_;
  return this->getUnderlyingModel()->getLowerBounds();
}


template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
DefaultNominalBoundsOverrideModelEvaluator<Scalar>::getUpperBounds() const
{
  if(upperBounds_.get())
    return *upperBounds_;
  return this->getUnderlyingModel()->getUpperBounds();
}


// Private functions overridden from ModelEvaulatorDefaultBase


template<class Scalar>
void DefaultNominalBoundsOverrideModelEvaluator<Scalar>::evalModelImpl(
  const ModelEvaluatorBase::InArgs<Scalar> &inArgs,
  const ModelEvaluatorBase::OutArgs<Scalar> &outArgs
  ) const
{

  using Teuchos::rcp;
  using Teuchos::rcp_const_cast;
  using Teuchos::rcp_dynamic_cast;
  using Teuchos::OSTab;
  typedef ModelEvaluatorBase MEB;

  THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_BEGIN(
    "Thyra::DefaultNominalBoundsOverrideModelEvaluator",inArgs,outArgs
    );

  // First set the inArgs to what was overridden
  MEB::InArgs<Scalar>
    wrappedInArgs = ( !is_null(nominalValues_) ? *nominalValues_ : this->createInArgs() );

  if(out.get() && static_cast<int>(verbLevel) >= static_cast<int>(Teuchos::VERB_EXTREME))
    *out
      << "\nwrappedInArgs after assigning to nominalValues =\n" << Teuchos::describe(wrappedInArgs,verbLevel);

  // Reset those not at their nominal values
  wrappedInArgs.setArgs(inArgs);

  // This is a special exception: see evalModel() in Thyra::ME
  // documentation.  If inArgs() supports x_dot (or x_dot_dot) but the
  // evaluate call passes in a null value, then we need to make sure
  // the null value gets passed on instead of the nominal value.
  if (wrappedInArgs.supports(Thyra::ModelEvaluatorBase::IN_ARG_x_dot)) {
    if (is_null(inArgs.get_x_dot())) {
      wrappedInArgs.set_x_dot(Teuchos::null);
    }
  }
  if (wrappedInArgs.supports(Thyra::ModelEvaluatorBase::IN_ARG_x_dot_dot)) {
    if (is_null(inArgs.get_x_dot_dot())) {
      wrappedInArgs.set_x_dot_dot(Teuchos::null);
    }
  }

  if(out.get() && static_cast<int>(verbLevel) >= static_cast<int>(Teuchos::VERB_EXTREME))
    *out
      << "\nwrappedInArgs after setting input values =\n" << Teuchos::describe(wrappedInArgs,verbLevel);

  thyraModel->evalModel(wrappedInArgs,outArgs);

  THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_END();
  
}


} // namespace Thyra


#endif // THYRA_DEFAULT_NOMINAL_BOUNDS_OVERRIDE_MODEL_EVALUATOR_HPP