// @HEADER // ***************************************************************************** // NOX: An Object-Oriented Nonlinear Solver Package // // Copyright 2002 NTESS and the NOX contributors. // SPDX-License-Identifier: BSD-3-Clause // ***************************************************************************** // @HEADER #ifndef NOX_THYRA_MODEL_EVALUATOR_2DSIM_DECL_HPP #define NOX_THYRA_MODEL_EVALUATOR_2DSIM_DECL_HPP #include "Thyra_StateFuncModelEvaluatorBase.hpp" template class ModelEvaluator2DSim; /** \brief Nonmember constuctor. * * \relates ModelEvaluator2DSim */ template Teuchos::RCP > modelEvaluator2DSim(const Teuchos::RCP& comm, const Scalar d = 10.0, const Scalar p0 = 2.0, const Scalar p1 = 0.0, const Scalar x0 = 0.0, const Scalar x1 = 1.0); /** \brief Simple 2d simulation only ModelEvaluator for f(x) = 0. * * The equations modeled are: \verbatim f[0] = x[0] + x[1]*x[1] - p[0]; f[1] = d * ( x[0]*x[0] - x[1] - p[1] ); \endverbatim * The Matrix W = d(f)/d(x) is implemented as a * Thyra::MultiVectorBase object and the class * Thyra::DefaultSerialDenseLinearOpWithSolveFactory is used to * create the linear solver. * * This is really more of a mock test driver model for Thyra than an example * of implementing a real simulation-constrained ModelEvaluator subclass. */ template class ModelEvaluator2DSim : public ::Thyra::StateFuncModelEvaluatorBase { public: ModelEvaluator2DSim(const Teuchos::RCP& comm, const Scalar d = 10.0, const Scalar p0 = 2.0, const Scalar p1 = 0.0, const Scalar x0 = 0.0, const Scalar x1 = 1.0); /** \name Initializers/Accessors */ //@{ /** \brief . */ void set_d(const Scalar &d); /** \brief . */ void set_p(const Teuchos::ArrayView &p); /** \brief . */ void set_x0(const Teuchos::ArrayView &x0); /** \brief . */ void setShowGetInvalidArgs(bool showGetInvalidArg); void set_W_factory(const Teuchos::RCP >& W_factory); //@} /** \name Public functions overridden from ModelEvaulator. */ //@{ /** \brief . */ Teuchos::RCP > get_x_space() const; /** \brief . */ Teuchos::RCP > get_f_space() const; /** \brief . */ ::Thyra::ModelEvaluatorBase::InArgs getNominalValues() const; /** \brief . */ Teuchos::RCP< ::Thyra::LinearOpBase > create_W_op() const; /** \brief . */ Teuchos::RCP > get_W_factory() const; /** \brief . */ ::Thyra::ModelEvaluatorBase::InArgs createInArgs() const; /** \brief . */ Teuchos::RCP< ::Thyra::PreconditionerBase< Scalar > > create_W_prec() const; //@} private: /** \name Private functions overridden from ModelEvaulatorDefaultBase. */ //@{ /** \brief . */ ::Thyra::ModelEvaluatorBase::OutArgs createOutArgsImpl() const; /** \brief . */ void evalModelImpl( const ::Thyra::ModelEvaluatorBase::InArgs &inArgs, const ::Thyra::ModelEvaluatorBase::OutArgs &outArgs ) const; //@} private: // data members Teuchos::RCP epetra_comm_; Teuchos::RCP > x_space_; Teuchos::RCP x_epetra_map_; Teuchos::RCP > f_space_; Teuchos::RCP f_epetra_map_; Teuchos::RCP W_graph_; Teuchos::RCP > W_factory_; ::Thyra::ModelEvaluatorBase::InArgs nominalValues_; Scalar d_; Teuchos::RCP< ::Thyra::VectorBase > x0_; Teuchos::Array p_; bool showGetInvalidArg_; ::Thyra::ModelEvaluatorBase::InArgs prototypeInArgs_; ::Thyra::ModelEvaluatorBase::OutArgs prototypeOutArgs_; }; #include "ModelEvaluator2DSim_def.hpp" #endif // NOX_THYRA_MODEL_EVALUATOR_2DSIM_DECL_HPP