FEI Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fei_Factory_Aztec.hpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ************************************************************************
4 // FEI: Finite Element Interface to Linear Solvers
5 // Copyright (2005) Sandia Corporation.
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the
8 // U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Alan Williams (william@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 */
42 
43 
44 #ifndef _fei_Factory_Aztec_hpp_
45 #define _fei_Factory_Aztec_hpp_
46 
47 #include "fei_trilinos_macros.hpp"
48 
49 #include <fei_mpi.h>
50 
51 #include <fei_Aztec_LSVector.hpp>
52 #include <fei_AztecDMSR_Matrix.hpp>
53 
54 #include <fei_Factory.hpp>
55 #include <fei_ParameterSet.hpp>
56 #include <fei_Reducer.hpp>
57 #include <fei_Vector_Impl.hpp>
58 #include <fei_Matrix_Impl.hpp>
60 #include <fei_SparseRowGraph.hpp>
61 #include <fei_utils.hpp>
62 
63 #undef fei_file
64 #define fei_file "fei_Factory_Aztec.hpp"
65 #include <fei_ErrMacros.hpp>
66 
67 /*** Implementation of an fei::Factory which creates instances that use fei-Aztec
68  objects as the underlying matrix and vector objects.
69 */
70 class Factory_Aztec : public fei::Factory {
71  public:
72  Factory_Aztec(MPI_Comm comm);
73 
74  virtual ~Factory_Aztec();
75 
78  {
80  return(factory);
81  }
82 
84  int parameters(int numParams, const char* const* paramStrings);
85 
87  void parameters(const fei::ParameterSet& parameterset);
88 
92  const char* name = NULL);
93 
96  createVector(fei::SharedPtr<fei::VectorSpace> vecSpace, int numVectors=1);
97 
101  bool isSolutionVector,
102  int numVectors=1);
103 
107  int numVectors=1);
108 
112  bool isSolutionVector,
113  int numVectors=1);
114 
117 
118  fei::SharedPtr<fei::Solver> createSolver(const char* name=0);
119 
120  int getOutputLevel() const { return(outputLevel_); }
121 
122  private:
124 
127 
129 };
130 
131 #endif // _Factory_Aztec_hpp_
132 
fei::SharedPtr< fei::Vector > createVector(fei::SharedPtr< fei::VectorSpace > vecSpace, int numVectors=1)
fei::SharedPtr< fei::MatrixGraph > createMatrixGraph(fei::SharedPtr< fei::VectorSpace > rowSpace, fei::SharedPtr< fei::VectorSpace > colSpace, const char *name=NULL)
fei::SharedPtr< fei::Factory > clone() const
fei::SharedPtr< fei::Reducer > reducer_
virtual ~Factory_Aztec()
int getOutputLevel() const
Factory_Aztec(MPI_Comm comm)
#define MPI_Comm
Definition: fei_mpi.h:56
fei::SharedPtr< fei::Solver > createSolver(const char *name=0)
int parameters(int numParams, const char *const *paramStrings)
fei::SharedPtr< fei::Matrix > createMatrix(fei::SharedPtr< fei::MatrixGraph > matrixGraph)