FEI Version of the Day
fei_Aztec_Map.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 #ifndef _fei_Aztec_Map_hpp_
00044 #define _fei_Aztec_Map_hpp_
00045 
00046 
00047 #include <vector>
00048 
00049 //
00050 // Aztec_Map is a wrapper that encapsulates the general
00051 // information needed to describe the layout of an Aztec matrix or
00052 // vector structure. It is a companion/support class that goes with
00053 // the three data class wrappers Aztec_LSVector, AztecDMSR_Matrix and
00054 // AztecDVBR_Matrix (the Aztec_BlockMap specialization is also
00055 // required for DVBR).
00056 //
00057 // Aztec_Map allows the storage and retrieval of information such as
00058 // local and global sizes, the MPI communicator, and the proc_config array.
00059 //
00060 namespace fei_trilinos {
00061 
00062 class Aztec_Map {
00063     
00064   public:
00065     Aztec_Map(int globalSize, int N_update, const int* update, int localOffset,
00066               MPI_Comm comm);
00067 
00068     Aztec_Map(const Aztec_Map& map);            // copy constructor    
00069     virtual ~Aztec_Map(void);
00070 
00071     virtual const int& localSize() const {return(localSize_);}
00072     virtual const int& globalSize() const {return(globalSize_);}
00073     virtual const int& localOffset() const {return(localOffset_);}
00074 
00075     int* getUpdate()
00076     {
00077       return update.size()>0 ? &update[0] : NULL;
00078     }
00079 
00080     virtual MPI_Comm getCommunicator() const {return(comm_);}
00081 
00082     virtual int* getProcConfig()
00083     {
00084       return proc_config.size()>0 ? &proc_config[0] : NULL;
00085     }
00086 
00087     std::vector<int> proc_config;
00088     std::vector<int> update;
00089     int* external;
00090     int* update_index;
00091     int* extern_index;
00092     int* data_org;
00093     std::vector<int> orderingUpdate;
00094 
00095     bool az_transformed;
00096 
00097     int getTransformedEqn(int eqn) const {
00098       if (az_transformed == true) {
00099         return eqn<N_update_ ? update[orderingUpdate[eqn]] : external[eqn-N_update_];
00100       }
00101       return eqn;
00102     }
00103 
00104     bool inUpdate(int globalIndex, int& localIndex) const
00105     {
00106       localIndex = globalIndex - localOffset_;
00107       if (localIndex<0 || localIndex>=localSize_) {
00108         localIndex = -1;
00109         return false;
00110       }
00111       if (az_transformed == true) {
00112         localIndex = update_index[localIndex];
00113       }
00114       return true;
00115     }
00116 
00117   private:
00118     void checkInput();
00119 
00120     int globalSize_;
00121     int localSize_;
00122     int localOffset_;
00123     int N_update_;
00124 
00125     MPI_Comm comm_;
00126 };
00127 
00128 }//namespace fei_trilinos
00129 
00130 #endif
00131 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends