AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_BasisSystemFactoryStd.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
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 Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef SPARSE_SOLVER_PACK_BASIS_SYSTEM_FACTORY_H
43 #define SPARSE_SOLVER_PACK_BASIS_SYSTEM_FACTORY_H
44 
45 #include "AbstractLinAlgPack_Types.hpp"
46 #include "AbstractLinAlgPack_BasisSystemFactory.hpp"
47 #include "Teuchos_AbstractFactory.hpp"
48 
49 namespace AbstractLinAlgPack {
50 
70 {
71 public:
72 
74  BasisSystemFactoryStd(); // ToDo: Add arguments!
75 
78 
80  void set_options( const options_ptr_t& options );
82  const options_ptr_t& get_options() const;
83 
85 
88 
90  obj_ptr_t create() const;
91 
93 
94 private:
95 
96  // ////////////////////////
97  // Private types
98 
99  enum EDirectLinearSolverType { LA_DENSE, LA_MA28, LA_MA48, LA_SUPERLU };
100 
101  // ////////////////////////
102  // Private data members
103 
104  mutable EDirectLinearSolverType direct_linear_solver_type_;
105  options_ptr_t options_;
106 
107  // ////////////////////////
108  // Private member functions
109 
110  void read_options() const;
111 
112 }; // end class BasisSystemFactoryStd
113 
114 } // end namespace AbstractLinAlgPack
115 
116 #endif // SPARSE_SOLVER_PACK_BASIS_SYSTEM_FACTORY_H
Default implementation for BasisSystemPermDirectSparse obejcts using DirectSparseSolver object...
Interface for a factory object that will create BasisSystem objects.