xref: /petsc/src/ts/tutorials/ex49.c (revision ebead697dbf761eb322f829370bbe90b3bd93fa3)
1 
2 static char help[] = "Solves the van der Pol equation.\n\
3 Input parameters include:\n";
4 
5 /* ------------------------------------------------------------------------
6 
7    This program solves the van der Pol DAE ODE equivalent
8        y' = z                 (1)
9        z' = mu[(1-y^2)z-y]
10    on the domain 0 <= x <= 1, with the boundary conditions
11        y(0) = 2, y'(0) = -6.6e-01,
12    and
13        mu = 10^6.
14    This is a nonlinear equation.
15 
16    This is a copy and modification of ex20.c to exactly match a test
17    problem that comes with the Radau5 integrator package.
18 
19   ------------------------------------------------------------------------- */
20 
21 #include <petscts.h>
22 
23 typedef struct _n_User *User;
24 struct _n_User {
25   PetscReal mu;
26   PetscReal next_output;
27 };
28 
29 static PetscErrorCode IFunction(TS ts,PetscReal t,Vec X,Vec Xdot,Vec F,void *ctx)
30 {
31   User              user = (User)ctx;
32   const PetscScalar *x,*xdot;
33   PetscScalar       *f;
34 
35   PetscFunctionBeginUser;
36   PetscCall(VecGetArrayRead(X,&x));
37   PetscCall(VecGetArrayRead(Xdot,&xdot));
38   PetscCall(VecGetArray(F,&f));
39   f[0] = xdot[0] - x[1];
40   f[1] = xdot[1] - user->mu*((1.0-x[0]*x[0])*x[1] - x[0]);
41   PetscCall(VecRestoreArrayRead(X,&x));
42   PetscCall(VecRestoreArrayRead(Xdot,&xdot));
43   PetscCall(VecRestoreArray(F,&f));
44   PetscFunctionReturn(0);
45 }
46 
47 static PetscErrorCode IJacobian(TS ts,PetscReal t,Vec X,Vec Xdot,PetscReal a,Mat A,Mat B,void *ctx)
48 {
49   User              user     = (User)ctx;
50   PetscInt          rowcol[] = {0,1};
51   const PetscScalar *x;
52   PetscScalar       J[2][2];
53 
54   PetscFunctionBeginUser;
55   PetscCall(VecGetArrayRead(X,&x));
56   J[0][0] = a;     J[0][1] = -1.0;
57   J[1][0] = user->mu*(1.0 + 2.0*x[0]*x[1]);   J[1][1] = a - user->mu*(1.0-x[0]*x[0]);
58   PetscCall(MatSetValues(B,2,rowcol,2,rowcol,&J[0][0],INSERT_VALUES));
59   PetscCall(VecRestoreArrayRead(X,&x));
60 
61   PetscCall(MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY));
62   PetscCall(MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY));
63   if (A != B) {
64     PetscCall(MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY));
65     PetscCall(MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY));
66   }
67   PetscFunctionReturn(0);
68 }
69 
70 int main(int argc,char **argv)
71 {
72   TS             ts;            /* nonlinear solver */
73   Vec            x;             /* solution, residual vectors */
74   Mat            A;             /* Jacobian matrix */
75   PetscInt       steps;
76   PetscReal      ftime   = 2;
77   PetscScalar    *x_ptr;
78   PetscMPIInt    size;
79   struct _n_User user;
80 
81   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
82      Initialize program
83      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
84   PetscFunctionBeginUser;
85   PetscCall(PetscInitialize(&argc,&argv,NULL,help));
86   PetscCallMPI(MPI_Comm_size(PETSC_COMM_WORLD,&size));
87   PetscCheck(size == 1,PETSC_COMM_WORLD,PETSC_ERR_WRONG_MPI_SIZE,"This is a uniprocessor example only!");
88 
89   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
90     Set runtime options
91     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
92   user.next_output = 0.0;
93   user.mu          = 1.0e6;
94   PetscOptionsBegin(PETSC_COMM_WORLD,NULL,"Physical parameters",NULL);
95   PetscCall(PetscOptionsReal("-mu","Stiffness parameter","<1.0e6>",user.mu,&user.mu,NULL));
96   PetscOptionsEnd();
97 
98   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
99     Create necessary matrix and vectors, solve same ODE on every process
100     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
101   PetscCall(MatCreate(PETSC_COMM_WORLD,&A));
102   PetscCall(MatSetSizes(A,PETSC_DECIDE,PETSC_DECIDE,2,2));
103   PetscCall(MatSetFromOptions(A));
104   PetscCall(MatSetUp(A));
105 
106   PetscCall(MatCreateVecs(A,&x,NULL));
107 
108   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
109      Create timestepping solver context
110      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
111   PetscCall(TSCreate(PETSC_COMM_WORLD,&ts));
112   PetscCall(TSSetType(ts,TSBEULER));
113   PetscCall(TSSetIFunction(ts,NULL,IFunction,&user));
114   PetscCall(TSSetIJacobian(ts,A,A,IJacobian,&user));
115 
116   PetscCall(TSSetMaxTime(ts,ftime));
117   PetscCall(TSSetExactFinalTime(ts,TS_EXACTFINALTIME_STEPOVER));
118   PetscCall(TSSetTolerances(ts,1.e-4,NULL,1.e-4,NULL));
119   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
120      Set initial conditions
121    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
122   PetscCall(VecGetArray(x,&x_ptr));
123   x_ptr[0] = 2.0;   x_ptr[1] = -6.6e-01;
124   PetscCall(VecRestoreArray(x,&x_ptr));
125   PetscCall(TSSetTimeStep(ts,.000001));
126 
127   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
128      Set runtime options
129    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
130   PetscCall(TSSetFromOptions(ts));
131 
132   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
133      Solve nonlinear system
134      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
135   PetscCall(TSSolve(ts,x));
136   PetscCall(TSGetSolveTime(ts,&ftime));
137   PetscCall(TSGetStepNumber(ts,&steps));
138   PetscCall(PetscPrintf(PETSC_COMM_WORLD,"steps %" PetscInt_FMT ", ftime %g\n",steps,(double)ftime));
139   PetscCall(VecView(x,PETSC_VIEWER_STDOUT_WORLD));
140 
141   /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
142      Free work space.  All PETSc objects should be destroyed when they
143      are no longer needed.
144    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
145   PetscCall(MatDestroy(&A));
146   PetscCall(VecDestroy(&x));
147   PetscCall(TSDestroy(&ts));
148 
149   PetscCall(PetscFinalize());
150   return(0);
151 }
152 
153 /*TEST
154 
155     build:
156       requires: double !complex !defined(PETSC_USE_64BIT_INDICES) radau5
157 
158     test:
159       args: -ts_monitor_solution -ts_type radau5
160 
161 TEST*/
162