Debian Codegraph @

packages/nox/test/epetra/DS6.5.1/Problem_Interface.H

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
10 //-----------------------------------------------------------------------------
11 #ifndef Problem_Interface_H
12 #define Problem_Interface_H
13
14 // Interface to the NLS_PetraGroup to provide for
15 // residual and matrix fill routines.
16
17 // ---------- Standard Includes ----------
18 #include <iostream>
19 #include "Epetra_Vector.h"
20 #include "Epetra_Operator.h"
21 #include "Epetra_RowMatrix.h"
22 #include "NOX_Epetra_Interface_Required.H" // base class
23 #include "NOX_Epetra_Interface_Jacobian.H" // base class
24
25 // ---------- Forward Declarations ----------
26 class DennisSchnabel;
27
28 class Problem_Interface : public NOX::Epetra::Interface::Required,
29 public NOX::Epetra::Interface::Jacobian
30 {
31 public:
32 Problem_Interface(DennisSchnabel& Problem);
33 ~Problem_Interface();
34
35 //! Compute and return F. Returns true if computation was successful.
36 bool computeF(const Epetra_Vector& x, Epetra_Vector& FVec,
37 NOX::Epetra::Interface::Required::FillType fillType);
38
39 //! Compute an explicit Jacobian. Returns true if computation was successful.
40 bool computeJacobian(const Epetra_Vector& x, Epetra_Operator& Jac);
41
42 //! Application Operator: Object that points to the user's evaluation routines.
43 /*! This is used to point to the actual routines and to store
44 * auxiliary data required by the user's application for function/Jacobian
45 * evaluations that NOX does not need to know about. This is a type of
46 * passdown class design by the application code.
47 */
48 DennisSchnabel& problem;
49 };
50
51 #endif
52