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_ALGEBRASPECIFIER_HPP 00032 #define SUNDANCE_ALGEBRASPECIFIER_HPP 00033 00034 #include "SundanceEnumTypeField.hpp" 00035 00036 namespace Sundance 00037 { 00038 using namespace Sundance; 00039 00040 /** */ 00041 enum AlgebraType {VectorAT, NormalAT, CoordCompAT, ScalarAT}; 00042 00043 /** AlgebraSpecifier is used to indicate whether a given object represents 00044 * a vector, scalar, component of a vector, etc. 00045 */ 00046 class AlgebraSpecifier : public EnumTypeField<AlgebraType> 00047 { 00048 public: 00049 /** */ 00050 AlgebraSpecifier(); 00051 00052 /** */ 00053 AlgebraSpecifier(int direction); 00054 00055 /** */ 00056 AlgebraSpecifier(const AlgebraType& vct); 00057 00058 /** Return true iff I am a scalar */ 00059 bool isScalar() const {return isType(ScalarAT);} 00060 00061 /** Return true iff I am a normal component of a vector */ 00062 bool isNormal() const {return isType(NormalAT);} 00063 00064 /** Return true iff I am a vector */ 00065 bool isVector() const {return isType(VectorAT);} 00066 00067 /** Return true iff I am a coordinate component of a vector */ 00068 bool isCoordinateComponent() const {return isType(CoordCompAT);} 00069 00070 /** Return coordinate direction if I am a coordinate component, 00071 * otherwise, throw an exception. */ 00072 int direction() const ; 00073 00074 /** Write a std::string representation */ 00075 std::string toString() const ; 00076 00077 /** Comparison operator for use in sorted containers */ 00078 bool operator<(const AlgebraSpecifier& other) const ; 00079 00080 private: 00081 int direction_; 00082 }; 00083 00084 /** \relates AlgebraSpecifier */ 00085 AlgebraSpecifier vectorAlgebraSpec(); 00086 00087 /** \relates AlgebraSpecifier */ 00088 AlgebraSpecifier scalarAlgebraSpec(); 00089 00090 /** \relates AlgebraSpecifier */ 00091 AlgebraSpecifier normalAlgebraSpec(); 00092 00093 /** \relates AlgebraSpecifier */ 00094 AlgebraSpecifier coordAlgebraSpec(int dir); 00095 00096 } 00097 00098 00099 namespace std 00100 { 00101 /** \relates AlgebraSpecifier */ 00102 ostream& operator<<(std::ostream& os, const Sundance::AlgebraSpecifier& vcs); 00103 /** \relates AlgebraSpecifier */ 00104 ostream& operator<<(std::ostream& os, const Sundance::AlgebraType& vct); 00105 } 00106 00107 00108 #endif