FEI Version of the Day
fei_Aztec_BlockMap.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_BlockMap_h_
00044 #define _fei_Aztec_BlockMap_h_
00045 
00046 
00047 //
00048 // This Aztec_BlockMap class is a wrapper that encapsulates the general
00049 // information needed to describe the layout of an Aztec DVBR matrix.
00050 // It is a companion/support class that goes with the data class wrappers
00051 // Aztec_LSVector and AztecDVBR_Matrix. Aztec_BlockMap inherits from
00052 // Aztec_Map.
00053 //
00054 // Aztec_Map allows the storage and retrieval of information such as
00055 // local and global sizes, the MPI communicator, and the proc_config array.
00056 // Aztec_BlockMap describes the partitioning and layout of a block matrix.
00057 //
00058 
00059 namespace fei_trilinos {
00060 
00061 class Aztec_BlockMap : public Aztec_Map {
00062     
00063   public:
00064     Aztec_BlockMap(int globalSize, int N_update, const int* update, int localOffset,
00065                    MPI_Comm comm,
00066                    int numGlobalBlocks, int numLocalBlocks, const int* blkUpdate,
00067                    int localBlockOffset, int* blockSizes);
00068 
00069     Aztec_BlockMap(const Aztec_BlockMap& map);       // copy constructor
00070     virtual ~Aztec_BlockMap(void);
00071 
00072     const int& getNumGlobalBlocks() const {return(numGlobalBlocks_);}
00073     const int& getNumLocalBlocks() const {return(numLocalBlocks_);}
00074     const int& getLocalBlockOffset() const {return(localBlockOffset_);}
00075 
00076     const int* getBlockSizes() const {return(blockSizes_);}
00077     int* getBlockUpdate() {return(blockUpdate_);}
00078 
00079   private:
00080 
00081     void checkInput();
00082 
00083     int numGlobalBlocks_;
00084     int numLocalBlocks_;
00085     int localBlockOffset_;
00086     int* blockSizes_;
00087     int* blockUpdate_;
00088 };
00089 
00090 }// namespace fei_trilinos
00091 
00092 #endif
00093 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends