FEI Version of the Day
fei_FieldMask.hpp
00001 /*
00002 // @HEADER
00003 // ************************************************************************
00004 //             FEI: Finite Element Interface to Linear Solvers
00005 //                  Copyright (2005) Sandia Corporation.
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the
00008 // U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Alan Williams (william@sandia.gov) 
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 */
00042 
00043 
00044 #ifndef _fei_FieldMask_hpp_
00045 #define _fei_FieldMask_hpp_
00046 
00047 #include "fei_macros.hpp"
00048 
00049 #include <vector>
00050 
00051 namespace fei {
00052 
00064   class FieldMask {
00065   public:
00067     FieldMask();
00068 
00070     FieldMask(const FieldMask& fm);
00071 
00073     FieldMask(int numFields,
00074         const int* fieldIDs,
00075         const int* fieldSizes);
00076 
00078     virtual ~FieldMask();
00079 
00081     int getMaskID() { return( maskID_ ); }
00082 
00084     static int calculateMaskID(int numFields,
00085              const int* fieldIDs);
00086 
00088     static int calculateMaskID(const FieldMask& fm,
00089              int fieldID);
00090 
00092     void addField(int fieldID,
00093       int fieldSize);
00094 
00096     bool hasFieldID(int fieldID) const
00097     {
00098       for(size_t i=0; i<fieldIDs_.size(); ++i)
00099         if (fieldIDs_[i] == fieldID) return true;
00100       return false;
00101     }
00102 
00104     size_t getNumFields() const { return(fieldIDs_.size()); }
00105 
00109     int getNumIndices() const { return( numIndices_ ); }
00110 
00114     void setNumIndices(int numInd) { numIndices_ = numInd; }
00115 
00117     std::vector<int>& getFieldIDs() { return(fieldIDs_); }
00118 
00120     const std::vector<int>& getFieldIDs() const { return(fieldIDs_); }
00121 
00123     std::vector<int>& getFieldSizes() { return(fieldSizes_); }
00124 
00126     const std::vector<int>& getFieldSizes() const { return(fieldSizes_); }
00127 
00131     void getFieldEqnOffset(int fieldID, int& offset) const;
00132 
00134     bool operator==(const FieldMask& fm) const
00135       { return( maskID_ == fm.maskID_ ); }
00136 
00138     bool operator!=(const FieldMask& fm) const
00139       { return( maskID_ != fm.maskID_ ); }
00140 
00145     bool isSubSetOf(const FieldMask& fm) const
00146       {
00147         for(unsigned i=0; i<fieldIDs_.size(); ++i) {
00148           if (!fm.hasFieldID(fieldIDs_[i])) return(false);
00149         }
00150         return(true);
00151       }
00152 
00153   private:
00154     FieldMask& operator=(const FieldMask& src);
00155 
00156     int calculateMaskID();
00157 
00158     int maskID_;
00159 
00160     std::vector<int> fieldIDs_;
00161     std::vector<int> fieldSizes_;
00162     std::vector<int> fieldEqnOffsets_;
00163 
00164     int numFields_;
00165     int numIndices_;
00166   };
00167 
00168 } //namespace fei
00169 
00170 #endif // _fei_FieldMask_hpp_
00171 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends