Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_ProductContainer.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stokhos Package
5// Copyright (2009) 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 Eric T. Phipps (etphipp@sandia.gov).
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef STOKHOS_PRODUCT_CONTAINER_HPP
43#define STOKHOS_PRODUCT_CONTAINER_HPP
44
45#include <iostream>
46#include "Teuchos_RCP.hpp"
47#include "Teuchos_Array.hpp"
48#include "Epetra_BlockMap.h"
49
50namespace Stokhos {
51
53 template <typename coeff_type> class ProductContainerTraits {};
54
60 template <typename coeff_type>
62 public:
63
66
68 typedef typename traits_type::value_type value_type;
69
71 typedef typename traits_type::ordinal_type ordinal_type;
72
74
79
83 ProductContainer(const Teuchos::RCP<const Epetra_BlockMap>& map);
84
90 ProductContainer(const Teuchos::RCP<const Epetra_BlockMap>& map,
91 const typename traits_type::cloner_type& cloner);
92
94
98
100 virtual ~ProductContainer();
101
103
107
109
112 void reset(const Teuchos::RCP<const Epetra_BlockMap>& map);
113
115
118 void reset(const Teuchos::RCP<const Epetra_BlockMap>& map,
119 const typename traits_type::cloner_type& cloner);
120
122
125 void resize(const Teuchos::RCP<const Epetra_BlockMap>& map);
126
128
131 void reserve(ordinal_type sz);
132
134 ordinal_type size() const;
135
137 Teuchos::RCP<const Epetra_BlockMap> map() const;
138
140 const Teuchos::Array<Teuchos::RCP<coeff_type> >&
141 getCoefficients() const;
142
144 Teuchos::Array<Teuchos::RCP<coeff_type> >&
146
148 Teuchos::RCP<coeff_type>
150
152 Teuchos::RCP<const coeff_type>
153 getCoeffPtr(ordinal_type i) const;
154
156 void setCoeffPtr(ordinal_type i, const Teuchos::RCP<coeff_type>& c);
157
159 coeff_type& operator[](ordinal_type i);
160
162 const coeff_type& operator[](ordinal_type i) const;
163
165 void init(const value_type& val);
166
168 bool myGID(int i) const;
169
171 std::ostream& print(std::ostream& os) const;
172
173 protected:
174
176 Teuchos::RCP<const Epetra_BlockMap> map_;
177
179 Teuchos::Array< Teuchos::RCP<coeff_type> > coeff_;
180
181 }; // class ProductContainer
182
183 template <typename coeff_type>
184 std::ostream& operator << (std::ostream& os,
185 const ProductContainer<coeff_type>& vec) {
186 return vec.print(os);
187 }
188
189} // end namespace Stokhos
190
191// include template definitions
193
194#endif // STOKHOS_PRODUCT_VECTOR_HPP
expr val()
Base traits definition for ProductContainer.
A product (in the mathematical sense) container class whose coefficients are vectors,...
traits_type::value_type value_type
Typename of values.
traits_type::ordinal_type ordinal_type
Typename of ordinals.
Teuchos::RCP< const Epetra_BlockMap > map() const
Return container map.
Teuchos::Array< Teuchos::RCP< coeff_type > > coeff_
Array of polynomial coefficients.
void reserve(ordinal_type sz)
Reserve space for a size sz container.
const Teuchos::Array< Teuchos::RCP< coeff_type > > & getCoefficients() const
Return array of coefficients.
void reset(const Teuchos::RCP< const Epetra_BlockMap > &map)
Resize to new map map.
std::ostream & print(std::ostream &os) const
Print polynomial.
Teuchos::RCP< coeff_type > getCoeffPtr(ordinal_type i)
Return ref-count pointer to coefficient i.
void init(const value_type &val)
Initialize coefficients.
ProductContainer & operator=(const ProductContainer &)
Assignment.
ordinal_type size() const
Return size.
void resize(const Teuchos::RCP< const Epetra_BlockMap > &map)
Resize to map map.
coeff_type & operator[](ordinal_type i)
Array access.
Stokhos::ProductContainerTraits< coeff_type > traits_type
Typename of traits.
Teuchos::RCP< const Epetra_BlockMap > map_
Container map.
void setCoeffPtr(ordinal_type i, const Teuchos::RCP< coeff_type > &c)
Set coefficient i to c.
bool myGID(int i) const
Return whether global index i resides on this processor.
Top-level namespace for Stokhos classes and functions.
std::ostream & operator<<(std::ostream &os, const ProductContainer< coeff_type > &vec)