SundanceCurveNormExpr.hpp
Go to the documentation of this file.
00001 /* @HEADER@ */
00002 // ************************************************************************
00003 // 
00004 //                              Sundance
00005 //                 Copyright (2005) Sandia Corporation
00006 // 
00007 // Copyright (year first published) Sandia Corporation.  Under the terms 
00008 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 
00009 // retains certain rights in this software.
00010 // 
00011 // This library is free software; you can redistribute it and/or modify
00012 // it under the terms of the GNU Lesser General Public License as
00013 // published by the Free Software Foundation; either version 2.1 of the
00014 // License, or (at your option) any later version.
00015 //  
00016 // This library is distributed in the hope that it will be useful, but
00017 // WITHOUT ANY WARRANTY; without even the implied warranty of
00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 // Lesser General Public License for more details.
00020 //                                                                                 
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License along with this library; if not, write to the Free Software
00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 // USA                                                                                
00025 // Questions? Contact Kevin Long (krlong@sandia.gov), 
00026 // Sandia National Laboratories, Livermore, California, USA
00027 // 
00028 // ************************************************************************
00029 /* @HEADER@ */
00030 
00031 #ifndef SUNDANCE_CURVENORMEXPR_H
00032 #define SUNDANCE_CURVENORMEXPR_H
00033 
00034 #include "SundanceEvaluatorFactory.hpp"
00035 #include "SundanceCurveNormEvaluator.hpp"
00036 
00037 namespace Sundance
00038 {
00039   using namespace Sundance;
00040 
00041   /** 
00042    * CurveNormExpr is an
00043    * expression that returns the Cartesian coordinate component
00044    * of the normal vector. Which dimensional component will be returned
00045    * can be specified in the constructor argument. <br>
00046    * The normal vector of the curve is always pointing outwards. This
00047    * outwards direction is in terms of the parameterized curve equation
00048    * from positive values to negative values.
00049    */
00050   class CurveNormExpr : public EvaluatableExpr,
00051                         public GenericEvaluatorFactory<CurveNormExpr, CurveNormEvaluator>
00052     {
00053     public:
00054       /** */
00055     CurveNormExpr(int dir, const std::string& name="");
00056 
00057       /** */
00058       virtual ~CurveNormExpr() {;}
00059 
00060       /** */
00061       virtual XMLObject toXML() const ;
00062 
00063       /** */
00064       int dir() const {return dir_;}
00065 
00066       /** */
00067       const std::string& name() const {return name_;}
00068 
00069       /** Write a simple text description suitable 
00070        * for output to a terminal */
00071       virtual std::ostream& toText(std::ostream& os, bool paren) const 
00072         {os<<name(); return os;}
00073       
00074       /** */
00075       virtual Set<MultipleDeriv> 
00076       internalFindW(int order, const EvalContext& context) const ;
00077       
00078       /* we use the default implementation from the supper class */
00079       //virtual Set<MultipleDeriv>
00080       //internalFindC(int order, const EvalContext& context) const ;
00081       
00082       /*  we use the default implementation from the supper class */
00083       //virtual Set<MultipleDeriv>
00084       //internalFindV(int order, const EvalContext& context) const ;
00085       
00086       /** */
00087       virtual RCP<ExprBase> getRcp() {return rcp(this);}
00088 
00089       /** Ordering operator for use in transforming exprs to standard form */
00090       virtual bool lessThan(const ScalarExpr* other) const ;
00091 
00092       static std::string coordName(int dir, const std::string& name);
00093 
00094     private:
00095       int dir_;
00096       std::string name_;
00097     };
00098 }
00099 
00100 #endif

Site Contact