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_BasisSystemFactory.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 ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_FACTORY_H
43 #define ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_FACTORY_H
44 
45 #include "AbstractLinAlgPack_Types.hpp"
46 #include "Teuchos_AbstractFactory.hpp"
47 #include "Teuchos_RCP.hpp"
48 
49 namespace OptionsFromStreamPack {
50  class OptionsFromStream;
51 }
52 
53 namespace AbstractLinAlgPack {
54 
59 class BasisSystemFactory : public Teuchos::AbstractFactory<BasisSystem>
60 {
61 public:
62 
65 
67  typedef Teuchos::RCP<
69 
71 
73  virtual ~BasisSystemFactory() {}
74 
82  virtual void set_options( const options_ptr_t& options ) = 0;
83 
86  virtual const options_ptr_t& get_options() const = 0;
87 
88 }; // end class BasisSystemFactory
89 
90 } // end namespace AbstractLinAlgPack
91 
92 #endif // ABSTRACT_LIN_ALG_PACK_BASIS_SYSTEM_FACTORY_H
virtual void set_options(const options_ptr_t &options)=0
Set the options that will be used to determine what basis system will be returned from this->create()...
Teuchos::RCP< const OptionsFromStreamPack::OptionsFromStream > options_ptr_t
Interface for a factory object that will create BasisSystem objects.
virtual const options_ptr_t & get_options() const =0
Get the OptionsFromStream object being used to extract the options from.