SundanceUserDefOpCommonEvaluator.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_USERDEFOPCOMMONEVALUATOR_H
#define SUNDANCE_USERDEFOPCOMMONEVALUATOR_H

#include "SundanceDefs.hpp"
#include "SundanceUserDefFunctor.hpp"
#include "SundanceEvaluator.hpp"
#include "SundanceEvalVector.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "Teuchos_TimeMonitor.hpp"

namespace Sundance {

class UserDefOpElement;
class EvalContext;

/** 
 * UserDefOpCommonEvaluator provides a single evaluation point for all
 * components of a vector-valued functor. 
 */
class UserDefOpCommonEvaluator : public ObjectWithClassVerbosity<Evaluator>
{
public:
  /** */
  UserDefOpCommonEvaluator(const UserDefFunctor* op,
    const UserDefOpElement* expr,
    const EvalContext& context);

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

  /** Evaluate all vector components at the specified argument values. */
  void evalAllComponents(const EvalManager& mgr,
    const Array<RCP<Array<double> > >& constArgDerivVals,
    const Array<RCP<Array<RCP<EvalVector> > > >& vArgDerivVals) const ;

      
      
  /** Get the cached constant-valued argument derivative values
   * for the specified vector component */
  const Array<double>& constArgDerivCache(int elemIndex) const 
    {return *(constArgDerivCache_[elemIndex]);}

  /** Get the cached vector-valued argument derivative values
   * for the specified vector component */
  const Array<RCP<EvalVector> >& varArgDerivCache(int elemIndex) const 
    {return varArgDerivCache_[elemIndex];}

  /** Indicate whether the cached argument derivative values are valid */
  bool cacheIsValid() const {return cacheIsValid_;}

  /** Mark the cache as valid.  */
  void markCacheAsValid() const {cacheIsValid_ = true;}

  /** Mark the cache as invalid */
  void markCacheAsInvalid() const {cacheIsValid_ = false;}

  /** */
  int maxDiffOrder() const {return maxOrder_;}

  /** */
  void updateMaxOrder(int maxOrder) const {maxOrder_ = maxOrder;}


protected:

  /** Access the functor that implements this operator */
  const UserDefFunctor* functor() const {return functor_;}

private:
  mutable int maxOrder_;
  Array<int> argValueIndex_;
  Array<int> argValueIsConstant_;
  mutable Array<RCP<Array<double> > > constArgDerivCache_;
  mutable Array<Array<RCP<EvalVector> > > varArgDerivCache_;
  mutable bool cacheIsValid_;
  const UserDefFunctor* functor_;
      
}; 
}


#endif