Debian Codegraph @

packages/nox/src-loca/src-epetra/continuation-manager/ProblemLOCAPrototype.H

raw
1 // @HEADER
2 // *****************************************************************************
3 // LOCA: Library of Continuation Algorithms Package
4 //
5 // Copyright 2001-2005 NTESS and the LOCA contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9
10 #ifndef PROBLEM_LOCA_PROTOTYPE_H
11 #define PROBLEM_LOCA_PROTOTYPE_H
12
13 #include "ProblemNOXPrototype.H"
14 #include "Teuchos_RCP.hpp"
15 #include "Teuchos_ParameterList.hpp"
16 #include "LOCA_Parameter_Vector.H"
17 #include "NOX_Abstract_MultiVector.H"
18
19 class ProblemLOCAPrototype :
20 public ProblemNOXPrototype {
21
22 public:
23
24 // Constructor
25 ProblemLOCAPrototype();
26
27 // Destructor
28 virtual ~ProblemLOCAPrototype();
29
30 // Pointer to the continuation parameter list
31 virtual LOCA::ParameterVector GetContinuableParams() const =0 ;
32
33 // Setting one continuation parameter
34 virtual bool SetContinuableParameter(std::string label,double value)=0;
35
36 // Printing the solution at each step
37 virtual bool PrintSolutionFile(const std::string & fileName, const Epetra_Vector & x,
38 const Teuchos::ParameterList & xParams);
39
40 // Setting the solution file parameters
41 virtual bool SetSolutionFileParameters(const Epetra_Vector & x);
42
43 // Getting the solution file parameters
44 virtual Teuchos::RCP <Teuchos::ParameterList> GetSolutionFileParameters();
45
46 // Updates the continuation file
47 virtual bool UpdateContinuationFile( const std::string & fileName,
48 const int & idStep,
49 const Teuchos::ParameterList & continuationFileParams);
50
51 // Setting the continuation file parameters
52 virtual bool SetContinuationFileParameters(const Epetra_Vector & x);
53
54 // Getting the continuation file parameters
55 virtual Teuchos::RCP <Teuchos::ParameterList>
56 GetContinuationFileParameters();
57
58 // Compute derivative with respect to periodic direction
59 virtual bool ComputePeriodicDirectionDerivative(const Epetra_Vector & x,
60 Epetra_Vector & dx);
61
62 // // Printing eigenvalues at each step
63 // virtual bool PrintEigenValues(
64 // const Teuchos::RCP < std::vector<double> > & evals_r,
65 // const Teuchos::RCP < std::vector<double> > & evals_i,
66 // const Teuchos::RCP < NOX::Abstract::MultiVector > & evecs_r,
67 // const Teuchos::RCP < NOX::Abstract::MultiVector > & evecs_i
68 // const int & stepId );
69 //
70 // // Compute derivative with respect to time
71 // virtual bool ComputeTimeDerivative(const Epetra_Vector & x,
72 // Epetra_Vector & dxdt);
73 //
74 // // Compute derivative with respect to space
75 // virtual bool ComputeSpaceDerivative(const Epetra_Vector & x,
76 // Epetra_Vector & dxdt);
77 //
78 // // Compute a shifted version of the Jacobian, namely A = alpha*J + beta*M
79 // // necessary for linear stability
80 // virtual bool ComputeShiftedJacobian (double alpha, double beta) = 0;
81 //
82 // // Return a pointer to the shifted jacobian
83 // virtual Teuchos::RCP< Epetra_CrsMatrix > GetShiftedJacF() const = 0;
84 //
85 };
86 #endif