Debian Codegraph @

packages/nox/test/epetra/Thyra/ModelEvaluator2DSim.hpp

raw
1 // @HEADER
2 // *****************************************************************************
3 // NOX: An Object-Oriented Nonlinear Solver Package
4 //
5 // Copyright 2002 NTESS and the NOX contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 #ifndef NOX_THYRA_MODEL_EVALUATOR_2DSIM_DECL_HPP
10 #define NOX_THYRA_MODEL_EVALUATOR_2DSIM_DECL_HPP
11
12 #include "Thyra_StateFuncModelEvaluatorBase.hpp"
13
14 template<class Scalar> class ModelEvaluator2DSim;
15
16 /** \brief Nonmember constuctor.
17 *
18 * \relates ModelEvaluator2DSim
19 */
20 template<class Scalar>
21 Teuchos::RCP<ModelEvaluator2DSim<Scalar> >
22 modelEvaluator2DSim(const Teuchos::RCP<const Epetra_Comm>& comm,
23 const Scalar d = 10.0,
24 const Scalar p0 = 2.0,
25 const Scalar p1 = 0.0,
26 const Scalar x0 = 0.0,
27 const Scalar x1 = 1.0);
28
29
30 /** \brief Simple 2d simulation only ModelEvaluator for f(x) = 0.
31 *
32 * The equations modeled are:
33
34 \verbatim
35
36 f[0] = x[0] + x[1]*x[1] - p[0];
37 f[1] = d * ( x[0]*x[0] - x[1] - p[1] );
38
39 \endverbatim
40
41 * The Matrix <tt>W = d(f)/d(x)</tt> is implemented as a
42 * <tt>Thyra::MultiVectorBase</tt> object and the class
43 * <tt>Thyra::DefaultSerialDenseLinearOpWithSolveFactory</tt> is used to
44 * create the linear solver.
45 *
46 * This is really more of a mock test driver model for Thyra than an example
47 * of implementing a real simulation-constrained ModelEvaluator subclass.
48 */
49 template<class Scalar>
50 class ModelEvaluator2DSim
51 : public ::Thyra::StateFuncModelEvaluatorBase<Scalar>
52 {
53 public:
54
55 ModelEvaluator2DSim(const Teuchos::RCP<const Epetra_Comm>& comm,
56 const Scalar d = 10.0,
57 const Scalar p0 = 2.0,
58 const Scalar p1 = 0.0,
59 const Scalar x0 = 0.0,
60 const Scalar x1 = 1.0);
61
62 /** \name Initializers/Accessors */
63 //@{
64
65 /** \brief . */
66 void set_d(const Scalar &d);
67
68 /** \brief . */
69 void set_p(const Teuchos::ArrayView<const Scalar> &p);
70
71 /** \brief . */
72 void set_x0(const Teuchos::ArrayView<const Scalar> &x0);
73
74 /** \brief . */
75 void setShowGetInvalidArgs(bool showGetInvalidArg);
76
77 void set_W_factory(const Teuchos::RCP<const ::Thyra::LinearOpWithSolveFactoryBase<Scalar> >& W_factory);
78
79 //@}
80
81 /** \name Public functions overridden from ModelEvaulator. */
82 //@{
83
84 /** \brief . */
85 Teuchos::RCP<const ::Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
86 /** \brief . */
87 Teuchos::RCP<const ::Thyra::VectorSpaceBase<Scalar> > get_f_space() const;
88 /** \brief . */
89 ::Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
90 /** \brief . */
91 Teuchos::RCP< ::Thyra::LinearOpBase<Scalar> > create_W_op() const;
92 /** \brief . */
93 Teuchos::RCP<const ::Thyra::LinearOpWithSolveFactoryBase<Scalar> > get_W_factory() const;
94 /** \brief . */
95 ::Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
96 /** \brief . */
97 Teuchos::RCP< ::Thyra::PreconditionerBase< Scalar > > create_W_prec() const;
98 //@}
99
100 private:
101
102 /** \name Private functions overridden from ModelEvaulatorDefaultBase. */
103 //@{
104
105 /** \brief . */
106 ::Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
107 /** \brief . */
108 void evalModelImpl(
109 const ::Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs,
110 const ::Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs
111 ) const;
112
113 //@}
114
115 private: // data members
116
117 Teuchos::RCP<const Epetra_Comm> epetra_comm_;
118
119 Teuchos::RCP<const ::Thyra::VectorSpaceBase<Scalar> > x_space_;
120 Teuchos::RCP<const Epetra_Map> x_epetra_map_;
121
122 Teuchos::RCP<const ::Thyra::VectorSpaceBase<Scalar> > f_space_;
123 Teuchos::RCP<const Epetra_Map> f_epetra_map_;
124
125 Teuchos::RCP<Epetra_CrsGraph> W_graph_;
126
127 Teuchos::RCP<const ::Thyra::LinearOpWithSolveFactoryBase<Scalar> > W_factory_;
128
129 ::Thyra::ModelEvaluatorBase::InArgs<Scalar> nominalValues_;
130 Scalar d_;
131 Teuchos::RCP< ::Thyra::VectorBase<Scalar> > x0_;
132 Teuchos::Array<Scalar> p_;
133 bool showGetInvalidArg_;
134 ::Thyra::ModelEvaluatorBase::InArgs<Scalar> prototypeInArgs_;
135 ::Thyra::ModelEvaluatorBase::OutArgs<Scalar> prototypeOutArgs_;
136
137 };
138
139 #include "ModelEvaluator2DSim_def.hpp"
140
141 #endif // NOX_THYRA_MODEL_EVALUATOR_2DSIM_DECL_HPP