FEI Version of the Day
fei_BlockLinearProblemManager.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_BlockLinearProblemManager_hpp_
00045 #define _fei_BlockLinearProblemManager_hpp_
00046 
00047 #include <fei_macros.hpp>
00048 #include <fei_SharedPtr.hpp>
00049 #include <fei_mpi.h>
00050 
00051 namespace fei {
00052   class ParameterSet;
00053   class SparseRowGraph;
00054 
00062   class BlockLinearProblemManager {
00063    public:
00065 
00067     virtual ~BlockLinearProblemManager(){}
00068 
00070 
00071 
00087     virtual void setRowDistribution(const std::vector<int>& ownedIDs,
00088                                     const std::vector<int>& dofPerOwnedID,
00089                                     const std::vector<int>& ghostIDs,
00090                                     const std::vector<int>& dofPerGhostID)=0;
00091 
00095     virtual void setMatrixGraph(fei::SharedPtr<fei::SparseRowGraph> matrixGraph)=0;
00096 
00098 
00099 
00102     virtual void setMatrixValues(double scalar)=0;
00103 
00106     virtual int getNumOwnedIDs()=0;
00107 
00113     virtual int getRowPointLength(int ownedID)=0;
00114 
00118     virtual int getRowBlockLength(int ownedID)=0;
00119 
00145     virtual int copyOutMatrixRow(int ownedID, int dofOffset,
00146                                  int numColIDs, int numCoefs,
00147                                  int* colIDs,
00148                                  int* dofPerColID,
00149                                  double* coefs);
00150 
00158     virtual int insertMatrixValues(int rowID, int numRowDof,
00159                                    int colID, int numColDof,
00160                                    const double* const* values,
00161                                    bool sum_into)=0;
00162 
00168     virtual int insertMatrixValues(int rowID, int rowDofOffset,
00169                                    int colID, int colDofOffset,
00170                                    double value,
00171                                    bool sum_into)=0;
00172 
00174 
00175 
00183     virtual void setVectorValues(double scalar, bool soln_vector)=0;
00184 
00209     virtual int insertVectorValues(int ID,
00210                                    int numDof,
00211                                    const double* values,
00212                                    bool sum_into,
00213                                    bool soln_vector,
00214                                    int vectorIndex=0)=0;
00215 
00219     virtual int copyOutVectorValues(int ID,
00220                                     int numDof,
00221                                     double* values,
00222                                     bool soln_vector,
00223                                     int vectorIndex=0) = 0;
00224 
00230     virtual double* getLocalVectorValuesPtr(bool soln_vector,
00231                                             int vectorIndex=0) = 0;
00233 
00234 
00240     virtual int globalAssemble() = 0;
00242 
00243 
00253     virtual int solve(const fei::ParameterSet& parameters) = 0;
00254 
00256   };//class BlockLinearProblemManager
00257 
00258 }//namespace fei
00259 
00260 #endif // _fei_BlockLinearProblemManager_hpp_
00261 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends