FEI Version of the Day
snl_fei_Factory.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 _snl_fei_Factory_hpp_
00045 #define _snl_fei_Factory_hpp_
00046 
00047 #include <fei_macros.hpp>
00048 #include <fei_Factory.hpp>
00049 #include <fei_VectorSpace.hpp>
00050 #include <snl_fei_Broker_FEData.hpp>
00051 #include <snl_fei_Broker_LinSysCore.hpp>
00052 #include <fei_Solver.hpp>
00053 #include <fei_LinearSystemCore.hpp>
00054 #include <fei_LibraryWrapper.hpp>
00055 #include <fei_utils.hpp>
00056 #include <fei_Reducer.hpp>
00057 #include <fei_MatrixReducer.hpp>
00058 #include <fei_VectorReducer.hpp>
00059 #include <fei_ParameterSet.hpp>
00060 #include <fei_MatrixGraph_Impl2.hpp>
00061 
00062 #undef fei_file
00063 #define fei_file "snl_fei_Factory.hpp"
00064 #include <fei_ErrMacros.hpp>
00065 
00066 namespace snl_fei {
00067 
00070   class Factory : public virtual fei::Factory {
00071   public:
00073     Factory(MPI_Comm comm, fei::SharedPtr<LibraryWrapper> wrapper);
00074 
00076     Factory(MPI_Comm comm, fei::SharedPtr<LinearSystemCore> lsc);
00077 
00079     Factory(MPI_Comm comm,
00080             fei::SharedPtr<FiniteElementData> feData, int nodeIDType);
00081 
00083     virtual ~Factory();
00084 
00085 
00087     fei::SharedPtr<fei::Factory> clone() const;
00088 
00090     virtual void parameters(const fei::ParameterSet& parameterset);
00091 
00094     virtual fei::SharedPtr<fei::MatrixGraph>
00095       createMatrixGraph(fei::SharedPtr<fei::VectorSpace> rowSpace,
00096                         fei::SharedPtr<fei::VectorSpace> columnSpace,
00097                         const char* name);
00098 
00100     virtual fei::SharedPtr<fei::Vector>
00101       createVector(fei::SharedPtr<fei::VectorSpace> vecSpace,
00102        int numVectors=1);
00103 
00105     virtual fei::SharedPtr<fei::Vector> createVector(fei::SharedPtr<fei::VectorSpace> vecSpace,
00106                  bool isSolutionVector,
00107                  int numVectors=1);
00108 
00110     virtual fei::SharedPtr<fei::Vector>
00111       createVector(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
00112                    int numVectors=1);
00113 
00115     virtual fei::SharedPtr<fei::Vector>
00116       createVector(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
00117          bool isSolutionVector,
00118          int numVectors=1);
00119 
00121     virtual fei::SharedPtr<fei::Matrix> createMatrix(fei::SharedPtr<fei::MatrixGraph> matrixGraph);
00122 
00125     virtual fei::SharedPtr<fei::LinearSystem>
00126       createLinearSystem(fei::SharedPtr<fei::MatrixGraph>& matrixGraph);
00127 
00129     virtual fei::SharedPtr<fei::Solver> createSolver(const char* name=0);
00130 
00132     fei::SharedPtr<LibraryWrapper> get_LibraryWrapper() const;
00133 
00134     int getOutputLevel() const;
00135 
00136   private:
00137     int createBroker(fei::SharedPtr<fei::MatrixGraph> matrixGraph);
00138 
00139     int createBroker_LinSysCore(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
00140         fei::SharedPtr<LinearSystemCore> lsc);
00141 
00142     int createBroker_FEData(fei::SharedPtr<fei::MatrixGraph> matrixGraph,
00143           fei::SharedPtr<FiniteElementData> feData);
00144 
00145     MPI_Comm comm_;
00146     fei::SharedPtr<snl_fei::Broker> broker_;
00147     fei::SharedPtr<fei::MatrixGraph> matrixGraph_;
00148     fei::SharedPtr<fei::Reducer> reducer_;
00149 
00150     int nodeIDType_;
00151 
00152     fei::SharedPtr<LinearSystemCore> lsc_;
00153     fei::SharedPtr<FiniteElementData> feData_;
00154     fei::SharedPtr<LibraryWrapper> wrapper_;
00155     int outputLevel_;
00156     bool blockMatrix_;
00157   };//class Factory
00158 }//namespace snl_fei
00159 
00160 #endif // _snl_fei_Factory_hpp_
00161 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends