Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_ProductEpetraMultiVector.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_EPETRA_MULTI_VECTOR_HPP
43#define STOKHOS_PRODUCT_EPETRA_MULTI_VECTOR_HPP
44
47#include "Epetra_BlockMap.h"
48#include "EpetraExt_MultiComm.h"
49#include "EpetraExt_BlockMultiVector.h"
50
51namespace Stokhos {
52
57 public virtual ProductContainer<Epetra_MultiVector> {
58 public:
59
61 typedef double value_type;
62
64 typedef int ordinal_type;
65
67
72
77 const Teuchos::RCP<const Epetra_BlockMap>& block_map);
78
85 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
86 const Teuchos::RCP<const Epetra_BlockMap>& coeff_map,
87 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm,
88 int num_vectors);
89
94 /*
95 * This version supplies the generated product map \c product_map
96 */
98 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
99 const Teuchos::RCP<const Epetra_BlockMap>& coeff_map,
100 const Teuchos::RCP<const Epetra_BlockMap>& product_map,
101 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm,
102 int num_vectors);
103
109 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
110 const Teuchos::RCP<const Epetra_BlockMap>& coeff_map,
111 const Teuchos::RCP<const Epetra_BlockMap>& product_map,
112 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm,
114 const Epetra_MultiVector& block_vector);
115
117
121
124
126
130
133
136
139
141 Teuchos::RCP<const Epetra_BlockMap> coefficientMap() const;
142
144 Teuchos::RCP<const Epetra_BlockMap> productMap() const;
145
147 Teuchos::RCP<const EpetraExt::MultiComm> productComm() const;
148
150 int numVectors() const;
151
153
156 void reset(
157 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
158 const Teuchos::RCP<const Epetra_BlockMap>& coeff_map,
159 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm,
160 int num_vectors);
161
163
166 void reset(
167 const Teuchos::RCP<const Epetra_BlockMap>& block_map,
168 const Teuchos::RCP<const Epetra_BlockMap>& coeff_map,
169 const Teuchos::RCP<const Epetra_BlockMap>& product_map,
170 const Teuchos::RCP<const EpetraExt::MultiComm>& product_comm,
171 int num_vectors);
172
175 const Epetra_MultiVector& block_vector);
176
178 Teuchos::RCP<EpetraExt::BlockMultiVector> getBlockMultiVector();
179
181 Teuchos::RCP<const EpetraExt::BlockMultiVector> getBlockMultiVector() const;
182
185 const Teuchos::RCP<EpetraExt::BlockMultiVector>& block_vec);
186
187 protected:
188
190 Teuchos::RCP<const Epetra_BlockMap> coeff_map;
191
193 Teuchos::RCP<const EpetraExt::MultiComm> product_comm;
194
196 Teuchos::RCP<const Epetra_BlockMap> product_map;
197
199 Teuchos::RCP<EpetraExt::BlockMultiVector> bv;
200
201 }; // class ProductEpetraMultiVector
202
203} // end namespace Stokhos
204
205#endif // STOKHOS_PRODUCT_EPETRA_MULTI_VECTOR_HPP
Epetra_DataAccess
A product (in the mathematical sense) container class whose coefficients are vectors,...
A container class storing products of Epetra_MultiVector's.
Teuchos::RCP< const Epetra_BlockMap > coeff_map
Product map of block vector.
Teuchos::RCP< const Epetra_BlockMap > product_map
Product map of block vector.
Teuchos::RCP< const EpetraExt::MultiComm > product_comm
Product multi-level communicator.
Teuchos::RCP< EpetraExt::BlockMultiVector > bv
Block vector storing coefficients.
void assignFromBlockMultiVector(const Epetra_MultiVector &v)
Assignment.
ProductEpetraMultiVector & operator=(const ProductEpetraMultiVector &v)
Assignment.
void resetCoefficients(Epetra_DataAccess CV, const Epetra_MultiVector &block_vector)
Reset vector cofficients.
void setBlockMultiVector(const Teuchos::RCP< EpetraExt::BlockMultiVector > &block_vec)
Set block vector.
Teuchos::RCP< const Epetra_BlockMap > productMap() const
Get product map.
Teuchos::RCP< EpetraExt::BlockMultiVector > getBlockMultiVector()
Get block vector.
void assignToBlockMultiVector(Epetra_MultiVector &v) const
Assignment.
void reset(const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_BlockMap > &coeff_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm, int num_vectors)
Reset to a new size.
Teuchos::RCP< const EpetraExt::MultiComm > productComm() const
Get product comm.
Teuchos::RCP< const Epetra_BlockMap > coefficientMap() const
Get coefficient map.
Top-level namespace for Stokhos classes and functions.