// @HEADER // ***************************************************************************** // NOX: An Object-Oriented Nonlinear Solver Package // // Copyright 2002 NTESS and the NOX contributors. // SPDX-License-Identifier: BSD-3-Clause // ***************************************************************************** // @HEADER //----------------------------------------------------------------------------- #ifndef Problem_Interface_H #define Problem_Interface_H // Interface to the NOX_Epetra_Group to provide for // residual and matrix fill routines. // ---------- Standard Includes ---------- #include #include "Epetra_Vector.h" #include "Epetra_Operator.h" #include "Epetra_RowMatrix.h" #include "NOX_Epetra_Interface_Required.H" // base class #include "NOX_Epetra_Interface_Jacobian.H" // base class #include "NOX_Epetra_Interface_Preconditioner.H" // base class // ---------- Forward Declarations ---------- class Brusselator; class Problem_Interface : public NOX::Epetra::Interface::Required, public NOX::Epetra::Interface::Jacobian, public NOX::Epetra::Interface::Preconditioner { public: Problem_Interface(Brusselator& Problem); ~Problem_Interface(); //! Compute and return F bool computeF(const Epetra_Vector& x, Epetra_Vector& FVec, NOX::Epetra::Interface::Required::FillType fillType); //! Compute an explicit Jacobian bool computeJacobian(const Epetra_Vector& x, Epetra_Operator& Jac); //! Compute the Epetra_RowMatrix M, that will be used by the Aztec preconditioner instead of the Jacobian. This is used when there is no explicit Jacobian present (i.e. Matrix-Free Newton-Krylov). This MUST BE an Epetra_RowMatrix since the Aztec preconditioners need to know the sparsity pattern of the matrix. Returns true if computation was successful. bool computePrecMatrix(const Epetra_Vector& x, Epetra_RowMatrix& M); //! Computes a user supplied preconditioner based on input vector x. Returns true if computation was successful. bool computePreconditioner(const Epetra_Vector& x, Epetra_Operator& Prec, Teuchos::ParameterList* p); //! Application Operator: Object that points to the user's evaluation routines. /*! This is used to point to the actual routines and to store * auxiliary data required by the user's application for function/Jacobian * evaluations that NOX does not need to know about. This is type of * passdown class design by the application code. */ Brusselator& problem; }; #endif