FEI Version of the Day
fei_Pattern.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_Pattern_hpp_
00045 #define _fei_Pattern_hpp_
00046 
00047 #include "fei_macros.hpp"
00048 
00049 #include <vector>
00050 
00051 namespace snl_fei {
00052   class RecordCollection;
00053 }
00054 
00055 namespace fei {
00056 
00064   class Pattern {
00065   public:
00067     enum PatternType { NO_FIELD, SIMPLE, SINGLE_IDTYPE, GENERAL };
00068 
00070     Pattern(int numIDs, int idType, snl_fei::RecordCollection* records);
00071 
00075     Pattern(int numIDs, int idType, snl_fei::RecordCollection* records,
00076       int fieldID, int fieldSize);
00077 
00081     Pattern(int numIDs, int idType, snl_fei::RecordCollection* records,
00082       const int* numFieldsPerID,
00083       const int* fieldIDs, const int* fieldSizes);
00084 
00088     Pattern(int numIDs, const int* idTypes, snl_fei::RecordCollection*const* records,
00089       const int* numFieldsPerID,
00090       const int* fieldIDs, const int* fieldSizes);
00091 
00092     virtual ~Pattern();
00093 
00096     PatternType getPatternType() const { return( type_ ); }
00097 
00099     int getNumIDs() const { return( numIDs_ ); }
00100 
00102     const int* getIDTypes() const { return( idTypes_ ); }
00103 
00105     snl_fei::RecordCollection*const* getRecordCollections() const { return &recordCollections_[0]; }
00106 
00108     const int* getNumFieldsPerID() const { return( numFieldsPerID_ ); }
00109 
00111     const int* getFieldIDs() const { return( fieldIDs_ ); }
00112 
00114     const int* getNumIndicesPerID() const
00115     {
00116       return( numIndicesPerID_ );
00117     }
00118 
00120     int getTotalNumFields() const { return( totalNumFields_ ); }
00121 
00127     int getNumIndices() const { return( numIndices_ ); }
00128 
00131     bool operator==(const Pattern& rhs) const;
00132 
00135     bool operator!=(const Pattern& rhs) const;
00136 
00137   private:
00138     PatternType type_;
00139     int numIDs_;
00140     int totalNumFields_;
00141     int numIndices_;
00142     std::vector<int> data_;
00143     std::vector<snl_fei::RecordCollection*> recordCollections_;
00144 
00145     const int* idTypes_;
00146     const int* numFieldsPerID_;
00147     const int* fieldIDs_;
00148     const int* numIndicesPerID_;
00149   };
00150 
00151 } //namespace fei
00152 
00153 #endif // _fei_Pattern_hpp_
00154 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends