Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_SGModelEvaluatorBase.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_SGMODELEVALUATORBASE_HPP
43#define STOKHOS_SGMODELEVALUATORBASE_HPP
44
45#include "EpetraExt_ModelEvaluator.h"
46#include "EpetraExt_BlockVector.h"
47
48#include "Teuchos_RCP.hpp"
49#include "Teuchos_Array.hpp"
51
52namespace Stokhos {
53
55 class SGModelEvaluatorBase : public virtual EpetraExt::ModelEvaluator {
56 public:
57
58 // Constructor
60
63
65 virtual void set_x_sg_init(const Stokhos::EpetraVectorOrthogPoly& x_sg_in) = 0;
66
68 virtual Teuchos::RCP<const Stokhos::EpetraVectorOrthogPoly> get_x_sg_init() const = 0;
69
71 virtual void set_p_sg_init(int i, const Stokhos::EpetraVectorOrthogPoly& p_sg_in) = 0;
72
74 virtual Teuchos::RCP<const Stokhos::EpetraVectorOrthogPoly> get_p_sg_init(int l) const = 0;
75
77
80 virtual Teuchos::Array<int> get_p_sg_map_indices() const = 0;
81
83
86 virtual Teuchos::Array<int> get_g_sg_map_indices() const = 0;
87
89 virtual Teuchos::Array< Teuchos::RCP<const Epetra_Map> > get_g_sg_base_maps() const = 0;
90
92 virtual Teuchos::RCP<const Epetra_BlockMap> get_overlap_stochastic_map() const = 0;
93
95 virtual Teuchos::RCP<const Epetra_BlockMap> get_x_sg_overlap_map() const = 0;
96
98 virtual Teuchos::RCP<const Epetra_Import> get_x_sg_importer() const = 0;
99
101 virtual Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
103 const Epetra_Vector* v = NULL) const = 0;
104
106 virtual Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
108 const Epetra_Vector* v = NULL) const = 0;
109
111 virtual Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
112 create_x_mv_sg(int num_vecs,
113 Epetra_DataAccess CV = Copy,
114 const Epetra_MultiVector* v = NULL) const = 0;
115
117 virtual Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
119 Epetra_DataAccess CV = Copy,
120 const Epetra_MultiVector* v = NULL) const = 0;
121
123 virtual Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
125 const Epetra_Vector* v = NULL) const = 0;
126
128 virtual Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
130 const Epetra_Vector* v = NULL) const = 0;
131
133 virtual Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
135 const Epetra_Vector* v = NULL) const = 0;
136
138 virtual Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
139 create_f_mv_sg(int num_vecs, Epetra_DataAccess CV = Copy,
140 const Epetra_MultiVector* v = NULL) const = 0;
141
143 virtual Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
145 const Epetra_MultiVector* v = NULL) const = 0;
146
148 virtual Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
150 const Epetra_Vector* v = NULL) const = 0;
151
153 virtual Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
154 create_g_mv_sg(int l, int num_vecs, Epetra_DataAccess CV = Copy,
155 const Epetra_MultiVector* v = NULL) const = 0;
156
157 };
158
159}
160
161#endif // STOKHOS_SGMODELEVALUATORBASE_HPP
Epetra_DataAccess
A container class storing an orthogonal polynomial whose coefficients are vectors,...
Base class for stochastic Galerkin model evaluators.
virtual Teuchos::RCP< const Epetra_Import > get_x_sg_importer() const =0
Return x sg importer.
virtual Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > create_g_mv_sg(int l, int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const =0
Create multi-vector orthog poly using g map.
virtual void set_x_sg_init(const Stokhos::EpetraVectorOrthogPoly &x_sg_in)=0
Set initial solution polynomial.
virtual Teuchos::RCP< const Stokhos::EpetraVectorOrthogPoly > get_p_sg_init(int l) const =0
Return initial SG parameters.
virtual Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > create_g_sg(int l, Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const =0
Create vector orthog poly using g map.
virtual Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > create_x_mv_sg_overlap(int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const =0
Create vector orthog poly using x map and overlap sg map.
virtual Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > create_p_sg(int l, Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const =0
Create vector orthog poly using p map.
virtual void set_p_sg_init(int i, const Stokhos::EpetraVectorOrthogPoly &p_sg_in)=0
Set initial parameter polynomial.
virtual Teuchos::Array< Teuchos::RCP< const Epetra_Map > > get_g_sg_base_maps() const =0
Get base maps of SG responses.
virtual Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > create_f_sg(Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const =0
Create vector orthog poly using f map and owned sg map.
virtual Teuchos::RCP< const Stokhos::EpetraVectorOrthogPoly > get_x_sg_init() const =0
Return initial SG x.
virtual Teuchos::Array< int > get_p_sg_map_indices() const =0
Get indices of SG parameters.
virtual Teuchos::RCP< const Epetra_BlockMap > get_x_sg_overlap_map() const =0
Return x sg overlap map.
virtual Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > create_f_sg_overlap(Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const =0
Create vector orthog poly using f map and overlap sg map.
virtual Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > create_f_mv_sg(int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const =0
Create multi-vector orthog poly using f map and owned sg map.
virtual Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > create_x_sg(Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const =0
Create vector orthog poly using x map and owned sg map.
virtual Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > create_x_sg_overlap(Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const =0
Create vector orthog poly using x map and overlap sg map.
virtual Teuchos::Array< int > get_g_sg_map_indices() const =0
Get indices of SG responses.
virtual Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > create_x_mv_sg(int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const =0
Create vector orthog poly using x map and owned sg map.
virtual Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > create_f_mv_sg_overlap(int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const =0
Create multi-vector orthog poly using f map and overlap sg map.
virtual Teuchos::RCP< const Epetra_BlockMap > get_overlap_stochastic_map() const =0
Return overlap stochastic map.
Top-level namespace for Stokhos classes and functions.