Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
uq_handbook/SimpleME.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 SIMPLE_ME_HPP
43#define SIMPLE_ME_HPP
44
45#include "Teuchos_RCP.hpp"
46#include "Teuchos_Array.hpp"
47
48#include "EpetraExt_ModelEvaluator.h"
49
50#include "Epetra_Map.h"
51#include "Epetra_LocalMap.h"
52#include "Epetra_Import.h"
53#include "Epetra_CrsGraph.h"
54#include "Epetra_CrsMatrix.h"
55
56/* Simple model evaluator demonstrating how to use the Stokhos
57 * ModelEvaluator to solve a nonlinear stochastic Galerkin problem.
58 * It represents the simple function
59 *
60 * f(x,a) = | a^2 - x_0 |
61 * | x_1^2 - x_0 |
62 *
63 * where x = [x_0 x_1]^T and a is a parameter. It has a root at x = [ a^2, a ].
64 * The parameter a may be represented by a given polynomial chaos expansion,
65 * and the corresponding expansion for x computed by Stokhos.
66 */
67class SimpleME : public EpetraExt::ModelEvaluator {
68public:
69
71 SimpleME(const Teuchos::RCP<const Epetra_Comm>& comm);
72
75
77 Teuchos::RCP<const Epetra_Map> get_x_map() const;
78
80 Teuchos::RCP<const Epetra_Map> get_f_map() const;
81
83 Teuchos::RCP<const Epetra_Map> get_p_map(int l) const;
84
86 Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int l) const;
87
89 Teuchos::RCP<const Epetra_Vector> get_x_init() const;
90
92 Teuchos::RCP<const Epetra_Vector> get_p_init(int l) const;
93
95 Teuchos::RCP<Epetra_Operator> create_W() const;
96
98 InArgs createInArgs() const;
99
101 OutArgs createOutArgs() const;
102
104 void evalModel(const InArgs& inArgs, const OutArgs& outArgs) const;
105
107
108protected:
109
111 Teuchos::RCP<Epetra_Map> x_map;
112
114 Teuchos::RCP<Epetra_Map> x_overlapped_map;
115
117 Teuchos::RCP<Epetra_Import> importer;
118
120 Teuchos::RCP<Epetra_Vector> x_init;
121
123 Teuchos::RCP<Epetra_Vector> x_overlapped;
124
126 Teuchos::RCP<Epetra_Map> p_map;
127
129 Teuchos::RCP<Epetra_Vector> p_init;
130
132 Teuchos::RCP< Teuchos::Array<std::string> > p_names;
133
135 Teuchos::RCP<Epetra_CrsGraph> graph;
136
137};
138
139#endif // SIMPLE_ME_HPP
Teuchos::RCP< Epetra_Import > importer
Importer to overlapped distribution.
OutArgs createOutArgs() const
Create OutArgs.
Teuchos::RCP< Teuchos::Array< std::string > > p_names
Parameter names.
Teuchos::RCP< const Epetra_Vector > get_p_init(int l) const
Return initial parameters.
Teuchos::RCP< Epetra_Operator > create_W() const
Create W = alpha*M + beta*J matrix.
Teuchos::RCP< Epetra_CrsGraph > graph
Jacobian graph.
void evalModel(const InArgs &inArgs, const OutArgs &outArgs) const
Evaluate model on InArgs.
InArgs createInArgs() const
Create InArgs.
Teuchos::RCP< Epetra_Map > x_map
Solution vector map.
Teuchos::RCP< Epetra_Vector > p_init
Initial parameters.
Teuchos::RCP< Epetra_Vector > x_init
Initial guess.
Teuchos::RCP< Epetra_Map > x_overlapped_map
Overlapped solution vector map.
Teuchos::RCP< Epetra_Vector > x_overlapped
Overlapped solution vector.
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int l) const
Return array of parameter names.
Teuchos::RCP< const Epetra_Vector > get_x_init() const
Return initial solution.
Teuchos::RCP< const Epetra_Map > get_f_map() const
Return residual vector map.
Teuchos::RCP< Epetra_Map > p_map
Parameter vector map.
Teuchos::RCP< const Epetra_Map > get_p_map(int l) const
Return parameter vector map.
Teuchos::RCP< const Epetra_Map > get_x_map() const
Return solution vector map.
SimpleME(const Teuchos::RCP< const Epetra_Comm > &comm)
Constructor.