MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AbstractLinAlgPack_InnerProductThyra.hpp
Go to the documentation of this file.
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 ALAP_INNER_PRODUCT_Thyra_H
43 #define ALAP_INNER_PRODUCT_Thyra_H
44 
46 #include "Thyra_VectorSpaceBase.hpp"
47 
48 
49 namespace AbstractLinAlgPack {
50 
51 
56 public:
57 
60 
68 
71  InnerProductThyra( const RCP<const Thyra::VectorSpaceBase<value_type> > &thyra_vec_spc );
72 
85  void initialize( const RCP<const Thyra::VectorSpaceBase<value_type> > &thyra_vec_spc );
86 
95 
103 
105 
108 
110  value_type inner_prod(const Vector& v1, const Vector& v2) const;
111 
113 
114 private:
115 
116 #ifdef DOXYGEN_COMPILE
117  const Thyra::VectorSpaceBase<value_type> *thyra_vector_space;
118 #else
120 #endif
121 
122 }; // end class InnerProductThyra
123 
124 
125 // ///////////////////////////////
126 // Inline functions
127 
128 
129 inline
132 {
133  return thyra_vec_spc_;
134 }
135 
136 
137 } // end namespace AbstractLinAlgPack
138 
139 
140 #endif // ALAP_INNER_PRODUCT_Thyra_H
Abstract interface for immutable, finite dimensional, coordinate vectors {abstract}.
const RCP< const Thyra::VectorSpaceBase< value_type > > & thyra_vec_spc() const
Return a (converted) smart pointer to the internal smart pointer to the Thyra::VectorSpaceBase<value_...
value_type inner_prod(const Vector &v1, const Vector &v2) const
RCP< const Thyra::VectorSpaceBase< value_type > > set_uninitialized()
Set to uninitialized and return smart pointer to the internal Thyra::VectorSpaceBase<value_type> obj...
const Thyra::VectorSpaceBase< value_type > * thyra_vector_space
void initialize(const RCP< const Thyra::VectorSpaceBase< value_type > > &thyra_vec_spc)
Initalize given a smart pointer to a Thyra::VetorSpace object.
Abstract interface for inner products.
Implements the inner product using Thyra::VectorSpaceBase::scalarProd().