Debian Codegraph @

packages/nox/test/epetra/1Dfem/1DfemStratimikosPrec.C

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 // 1D Finite Element Test Problem
11 /* Solves the nonlinear equation:
12 *
13 * d2u
14 * --- - k * u**2 = 0
15 * dx2
16 *
17 * subject to @ x=0, u=1
18 */
19
20 // NOX Objects
21 #include "NOX.H"
22 #include "NOX_Epetra.H"
23
24 // Trilinos Objects
25 #ifdef HAVE_MPI
26 #include "Epetra_MpiComm.h"
27 #else
28 #include "Epetra_SerialComm.h"
29 #endif
30 #include "Epetra_Map.h"
31 #include "Epetra_Vector.h"
32 #include "Epetra_RowMatrix.h"
33 #include "Epetra_CrsMatrix.h"
34 #include "Epetra_Map.h"
35 #include "Epetra_LinearProblem.h"
36 //#include "AztecOO.h"
37
38 #include "NOX_Epetra_LinearSystem_Stratimikos.H"
39
40 // User's application specific files
41 #include "1DfemInterface.H"
42
43 #include "Teuchos_ParameterList.hpp"
44 #include "Teuchos_GlobalMPISession.hpp"
45 #include "Teuchos_StandardCatchMacros.hpp"
46
47 using namespace std;
48
49 int main(int argc, char *argv[])
50 {
51 // Initialize MPI
52 Teuchos::GlobalMPISession mpiSession(&argc,&argv);
53
54 bool success = false;
55 bool verbose = false;
56 try {
57 // Create a communicator for Epetra objects
58 #ifdef HAVE_MPI
59 Epetra_MpiComm Comm( MPI_COMM_WORLD );
60 #else
61 Epetra_SerialComm Comm;
62 #endif
63
64 // Get the process ID and the total number of processors
65 int MyPID = Comm.MyPID();
66 int NumProc = Comm.NumProc();
67
68 // Check verbosity level
69 if (argc > 1)
70 if (argv[1][0]=='-' && argv[1][1]=='v')
71 verbose = true;
72
73 // Get the number of elements from the command line
74 int NumGlobalElements = 0;
75 if ((argc > 2) && (verbose))
76 NumGlobalElements = atoi(argv[2]) + 1;
77 else if ((argc > 1) && (!verbose))
78 NumGlobalElements = atoi(argv[1]) + 1;
79 else
80 NumGlobalElements = 101;
81
82 // The number of unknowns must be at least equal to the
83 // number of processors.
84 if (NumGlobalElements < NumProc) {
85 std::cout << "numGlobalBlocks = " << NumGlobalElements
86 << " cannot be < number of processors = " << NumProc << std::endl;
87 std::cout << "Test failed!" << std::endl;
88 throw std::runtime_error("NOX Error");
89 }
90
91 // Create the interface between NOX and the application
92 // This object is derived from NOX::Epetra::Interface
93 Teuchos::RCP<Interface> interface =
94 Teuchos::rcp(new Interface(NumGlobalElements, Comm));
95
96 // Get the vector from the Problem
97 Teuchos::RCP<Epetra_Vector> soln = interface->getSolution();
98 Teuchos::RCP<NOX::Epetra::Vector> noxSoln =
99 Teuchos::rcp(new NOX::Epetra::Vector(soln,
100 NOX::Epetra::Vector::CreateView));
101
102 // Set the PDE factor (for nonlinear forcing term). This could be specified
103 // via user input.
104 interface->setPDEfactor(1000.0);
105
106 // Set the initial guess
107 soln->PutScalar(1.0);
108
109 // Begin Nonlinear Solver ************************************
110
111 // Create the top level parameter list
112 Teuchos::RCP<Teuchos::ParameterList> nlParamsPtr =
113 Teuchos::rcp(new Teuchos::ParameterList);
114 Teuchos::ParameterList& nlParams = *(nlParamsPtr.get());
115
116 // Set the nonlinear solver method
117 nlParams.set("Nonlinear Solver", "Line Search Based");
118
119 // Set the printing parameters in the "Printing" sublist
120 Teuchos::ParameterList& printParams = nlParams.sublist("Printing");
121 printParams.set("MyPID", MyPID);
122 printParams.set("Output Precision", 3);
123 printParams.set("Output Processor", 0);
124 if (verbose)
125 printParams.set("Output Information",
126 NOX::Utils::OuterIteration +
127 NOX::Utils::OuterIterationStatusTest +
128 NOX::Utils::InnerIteration +
129 NOX::Utils::LinearSolverDetails +
130 NOX::Utils::Parameters +
131 NOX::Utils::Details +
132 NOX::Utils::Warning +
133 NOX::Utils::Debug +
134 NOX::Utils::TestDetails +
135 NOX::Utils::Error);
136 else
137 printParams.set("Output Information", NOX::Utils::Error +
138 NOX::Utils::TestDetails);
139
140 // Create a print class for controlling output below
141 NOX::Utils printing(printParams);
142
143 // Sublist for line search
144 Teuchos::ParameterList& searchParams = nlParams.sublist("Line Search");
145 searchParams.set("Method", "Full Step");
146
147 // Sublist for direction
148 Teuchos::ParameterList& dirParams = nlParams.sublist("Direction");
149 dirParams.set("Method", "Newton");
150 Teuchos::ParameterList& newtonParams = dirParams.sublist("Newton");
151 newtonParams.set("Forcing Term Method", "Constant");
152
153 // Alternative linear solver list for Stratimikos
154 Teuchos::ParameterList& stratLinSolParams = newtonParams.sublist("Stratimikos Linear Solver");
155 Teuchos::ParameterList& noxStratParams = stratLinSolParams.sublist("NOX Stratimikos Options");
156 Teuchos::ParameterList& stratParams = stratLinSolParams.sublist("Stratimikos");
157
158 noxStratParams.set("Preconditioner Reuse Policy","Rebuild");
159
160 stratParams.set("Linear Solver Type", "AztecOO");
161 stratParams.set("Preconditioner Type", "ML");
162 if (verbose) stratParams.sublist("Linear Solver Types")
163 .sublist("AztecOO").sublist("Forward Solve")
164 .sublist("AztecOO Settings").set("Output Frequency", 1);
165
166 // Let's force all status tests to do a full check
167 nlParams.sublist("Solver Options").set("Status Test Check Type", "Complete");
168
169 // Create all possible Epetra_Operators.
170 // 1. User supplied (Epetra_RowMatrix)
171 Teuchos::RCP<Epetra_RowMatrix> Analytic = interface->getJacobian();
172 // 2. Matrix-Free (Epetra_Operator)
173 Teuchos::RCP<NOX::Epetra::MatrixFree> MF =
174 Teuchos::rcp(new NOX::Epetra::MatrixFree(printParams, interface,
175 *noxSoln));
176 // 3. Finite Difference (Epetra_RowMatrix)
177 Teuchos::RCP<NOX::Epetra::FiniteDifference> FD =
178 Teuchos::rcp(new NOX::Epetra::FiniteDifference(printParams, interface,
179 *soln));
180
181 // Create the linear system
182 Teuchos::RCP<NOX::Epetra::Interface::Required> iReq = interface;
183 Teuchos::RCP<NOX::Epetra::Interface::Jacobian> iJac = interface;
184 Teuchos::RCP<NOX::Epetra::Interface::Preconditioner> iPrec = FD;
185 Teuchos::RCP<NOX::Epetra::LinearSystem> linSys =
186 Teuchos::rcp(new NOX::Epetra::LinearSystemStratimikos(printParams, stratLinSolParams,
187 iJac, Analytic,
188 iPrec, FD,
189 *soln, false));
190
191 // Create the Group
192 NOX::Epetra::Vector initialGuess(soln, NOX::Epetra::Vector::CreateView);
193 Teuchos::RCP<NOX::Epetra::Group> grpPtr =
194 Teuchos::rcp(new NOX::Epetra::Group(printParams,
195 iReq,
196 initialGuess,
197 linSys));
198 NOX::Epetra::Group& grp = *grpPtr;
199
200 // uncomment the following for loca supergroups
201 //MF->setGroupForComputeF(*grpPtr);
202 //FD->setGroupForComputeF(*grpPtr);
203
204 // Create the convergence tests
205 Teuchos::RCP<NOX::StatusTest::NormF> absresid =
206 Teuchos::rcp(new NOX::StatusTest::NormF(1.0e-8));
207 Teuchos::RCP<NOX::StatusTest::NormF> relresid =
208 Teuchos::rcp(new NOX::StatusTest::NormF(grp, 1.0e-2));
209 Teuchos::RCP<NOX::StatusTest::NormUpdate> update =
210 Teuchos::rcp(new NOX::StatusTest::NormUpdate(1.0e-5));
211 Teuchos::RCP<NOX::StatusTest::NormWRMS> wrms =
212 Teuchos::rcp(new NOX::StatusTest::NormWRMS(1.0e-2, 1.0e-8));
213 Teuchos::RCP<NOX::StatusTest::Combo> converged =
214 Teuchos::rcp(new NOX::StatusTest::Combo(NOX::StatusTest::Combo::AND));
215 converged->addStatusTest(absresid);
216 converged->addStatusTest(relresid);
217 converged->addStatusTest(wrms);
218 converged->addStatusTest(update);
219 Teuchos::RCP<NOX::StatusTest::MaxIters> maxiters =
220 Teuchos::rcp(new NOX::StatusTest::MaxIters(20));
221 Teuchos::RCP<NOX::StatusTest::FiniteValue> fv =
222 Teuchos::rcp(new NOX::StatusTest::FiniteValue);
223 Teuchos::RCP<NOX::StatusTest::Combo> combo =
224 Teuchos::rcp(new NOX::StatusTest::Combo(NOX::StatusTest::Combo::OR));
225 combo->addStatusTest(fv);
226 combo->addStatusTest(converged);
227 combo->addStatusTest(maxiters);
228
229 // Create the solver
230 Teuchos::RCP<NOX::Solver::Generic> solver =
231 NOX::Solver::buildSolver(grpPtr, combo, nlParamsPtr);
232 NOX::StatusTest::StatusType solvStatus = solver->solve();
233
234 // End Nonlinear Solver **************************************
235
236 // Get the Epetra_Vector with the final solution from the solver
237 const NOX::Epetra::Group& finalGroup =
238 dynamic_cast<const NOX::Epetra::Group&>(solver->getSolutionGroup());
239 const Epetra_Vector& finalSolution =
240 (dynamic_cast<const NOX::Epetra::Vector&>(finalGroup.getX())).
241 getEpetraVector();
242
243 // Output the parameter list
244 if (verbose) {
245 if (printing.isPrintType(NOX::Utils::Parameters)) {
246 printing.out() << std::endl << "Final Parameters" << std::endl
247 << "****************" << std::endl;
248 solver->getList().print(printing.out());
249 printing.out() << std::endl;
250 }
251 }
252
253 // Print solution
254 char file_name[25];
255 FILE *ifp;
256 int NumMyElements = soln->Map().NumMyElements();
257 (void) sprintf(file_name, "output.%d",MyPID);
258 ifp = fopen(file_name, "w");
259 for (int i=0; i<NumMyElements; i++)
260 fprintf(ifp, "%d %E\n", soln->Map().MinMyGID()+i, finalSolution[i]);
261 fclose(ifp);
262
263
264 // Tests
265 int status = 0; // Converged
266
267 // 1. Convergence
268 if (solvStatus != NOX::StatusTest::Converged) {
269 status = 1;
270 if (printing.isPrintType(NOX::Utils::Error))
271 printing.out() << "Nonlinear solver failed to converge!" << std::endl;
272 }
273
274 // 3. Nonlinear solve iterations (10)
275 if (const_cast<Teuchos::ParameterList&>(solver->getList()).sublist("Output").get("Nonlinear Iterations", 0) != 10)
276 status = 3;
277
278 success = status==0;
279
280 // Summarize test results
281 if (success)
282 printing.out() << "Test passed!" << std::endl;
283 else
284 printing.out() << "Test failed!" << std::endl;
285
286 printing.out() << "Status = " << status << std::endl;
287 }
288 TEUCHOS_STANDARD_CATCH_STATEMENTS(verbose, std::cerr, success);
289
290 return ( success ? EXIT_SUCCESS : EXIT_FAILURE );
291 }