SundanceUserDefOpEvaluator.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                             Sundance
//                 Copyright 2011 Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Kevin Long (kevin.long@ttu.edu)
// 

/* @HEADER@ */


#ifndef SUNDANCE_USERDEFOPEVALUATOR_H
#define SUNDANCE_USERDEFOPEVALUATOR_H

#include "SundanceDefs.hpp"

#include "SundanceUserDefFunctorElement.hpp"
#include "SundanceUserDefOpCommonEvaluator.hpp"
#include "SundanceChainRuleEvaluator.hpp"
#include "Teuchos_TimeMonitor.hpp"

namespace Sundance 
{

class UserDefOpElement;
class SymbolicFuncElementEvaluator;
class UserDefOpCommonEvaluator;
/**
 *
 */
class UserDefOpEvaluator : public ChainRuleEvaluator
{
public:
  /** */
  UserDefOpEvaluator(const UserDefOpElement* expr,
    const RCP<const UserDefOpCommonEvaluator>& commonEval,
    const EvalContext& context);

  /** */
  virtual ~UserDefOpEvaluator(){;}


  /** */
  virtual void 
  evalArgDerivs(const EvalManager& mgr,
    const Array<RCP<Array<double> > >& constArgRes,
    const Array<RCP<Array<RCP<EvalVector> > > >& vArgResults,
    Array<double>& constArgDerivs,
    Array<RCP<EvalVector> >& varArgDerivs) const ;

     
        
  /** */
  TEUCHOS_TIMER(evalTimer, "user defined nonlinear op evaluation");

  /** */
  void resetNumCalls() const ;

protected:

  Array<int> findRequiredOrders(const ExprWithChildren* expr, 
    const EvalContext& context) ;

  const UserDefFunctorElement* functor() const {return functor_;}

  const UserDefOpCommonEvaluator* commonEval() const 
    {return commonEval_.get();}

  int myIndex() const {return functor_->myIndex();}

private:
  Array<int> argValueIndex_;
  Array<int> argValueIsConstant_;
  const UserDefFunctorElement* functor_;
  RCP<const UserDefOpCommonEvaluator> commonEval_;
  int maxOrder_;
  int numVarArgDerivs_;
  int numConstArgDerivs_;
  bool allArgsAreConstant_;
}; 
}


#endif