SundanceCoordDeriv.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                              Sundance
//                 Copyright (2005) Sandia Corporation
// 
// Copyright (year first published) Sandia Corporation.  Under the terms 
// of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 
// retains certain rights in this software.
// 
// 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 Kevin Long (krlong@sandia.gov), 
// Sandia National Laboratories, Livermore, California, USA
// 
// ************************************************************************
/* @HEADER@ */

#ifndef SUNDANCE_COORDDERIV_H
#define SUNDANCE_COORDDERIV_H

#include "SundanceDefs.hpp"
#include "SundanceDerivBase.hpp"
#include "SundanceMultiIndex.hpp"

#ifndef DOXYGEN_DEVELOPER_ONLY


namespace Sundance
{
using namespace Teuchos;

/**
 * CoordDeriv represents a single first-order derivative with respect
 * to a coordinate function. It is used internally
 * to represent differentiation of
 * explicit coordinate dependence.
 *
 * @see Deriv
 *
 */
class CoordDeriv : public DerivBase
{
public:
  /** */
  CoordDeriv(int dir);

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

  /** */
  int dir() const {return dir_;}

  /** */
  virtual bool lessThan(const Deriv& other) const ;

  /** */
  virtual std::string toString() const ;

  /* handleable boilerplate */
  GET_RCP(DerivBase);

  /** */
  static int maxDim() {static int rtn=3; return rtn;}
private:
  int dir_;
};
}



#endif /* DOXYGEN_DEVELOPER_ONLY */
#endif