Commits

Lisandro Dalcin committed eb43ef7

Update docs about callback signatures

Comments (0)

Files changed (2)

                                                  PetscReal t0,Vec U0,
                                                  Vec F);
 PETSC_EXTERN PetscErrorCode IGAComputeIEJacobian(IGA iga,PetscReal dt,
-                                                 PetscReal a,Vec V,
-                                                 PetscReal t,Vec U,
+                                                 PetscReal a, Vec V,
+                                                 PetscReal t, Vec U,
                                                  PetscReal t0,Vec U0,
                                                  Mat J);
 
 
    Details of IFunction:
 $  PetscErrorCode IFunction(IGAPoint p,PetscReal dt,
-                            PetscReal shift,const PetscScalar *V,
+                            PetscReal a,const PetscScalar *V,
                             PetscReal t,const PetscScalar *U,
                             PetscScalar *R,void *ctx);
 
 +  p - point at which to compute the residual
 .  dt - time step size
-.  shift - positive parameter which depends on the time integration method (XXX Should this be here?)
+.  a - positive parameter which depends on the time integration method (XXX Should this be here?)
 .  V - time derivative of the state vector
 .  t - time at step/stage being solved
 .  U - state vector
 #define __FUNCT__ "IGASetFormIJacobian"
 /*@
    IGASetFormIJacobian - Set the function to compute the Jacobian matrix
-   J = shift*dF/dU_t + dF/dU where F(t,U_t,U) is the residual function
+   J = a*dF/dU_t + dF/dU where F(t,U_t,U) is the residual function
    you provided with IGASetFormIFunction().
 
    Logically Collective on IGA
 
    Details of IJacobian:
 $  PetscErrorCode IJacobian(IGAPoint p,PetscReal dt,
-                            PetscReal shift,const PetscScalar *V,
+                            PetscReal a,const PetscScalar *V,
                             PetscReal t,const PetscScalar *U,
                             PetscScalar *J,void *ctx);
 
 +  p - point at which to compute the Jacobian
 .  dt - time step size
-.  shift - positive parameter which depends on the time integration method
+.  a - positive parameter which depends on the time integration method
 .  V - time derivative of the state vector
 .  t - time at step/stage being solved
 .  U - state vector
 
    Details of IEFunction:
 $  PetscErrorCode IEFunction(IGAPoint p,PetscReal dt,
-                             PetscReal shift,const PetscScalar *V0,
-                             PetscReal t1,const PetscScalar *U1,
+                             PetscReal a, const PetscScalar *V,
+                             PetscReal t, const PetscScalar *U,
                              PetscReal t0,const PetscScalar *U0,
                              PetscScalar *R,void *ctx);
 
 +  p - point at which to compute the residual
 .  dt - time step size
-.  shift - positive parameter which depends on the time integration method (XXX Should this be here?)
-.  V0 - time derivative of the state vector at t0
-.  t1 - time at step/stage being solved
-.  U1 - state vector at t1
+.  a - positive parameter which depends on the time integration method (XXX Should this be here?)
+.  V - time derivative of the state vector at t0
+.  t - time at step/stage being solved
+.  U - state vector at t
 .  t0 - time at current step
 .  U0 - state vector at t0
 .  R - function vector
 #define __FUNCT__ "IGASetFormIEJacobian"
 /*@
    IGASetFormIEJacobian - Set the function to compute the Jacobian matrix
-   J = shift*dF/dU_t + dF/dU where F(t,U_t,U,U0) is the function you provided with
+   J = a*dF/dU_t + dF/dU where F(t,U_t,U,U0) is the function you provided with
    IGASetFormIEFunction(). For use with implicit+explicit TS methods.
 
    Logically Collective on IGA
 
    Details of IEJacobian:
 $  PetscErrorCode IEJacobian(IGAPoint p,PetscReal dt,
-                             PetscReal shift,const PetscScalar *V0,
-                             PetscReal t1,const PetscScalar *U1,
+                             PetscReal a, const PetscScalar *V,
+                             PetscReal t, const PetscScalar *U,
                              PetscReal t0,const PetscScalar *U0,
                              PetscScalar *J,void *ctx);
 
 +  p - point at which to compute the Jacobian
 .  dt - time step size
-.  shift - positive parameter which depends on the time integration method
-.  V0 - time derivative of the state vector at t0
-.  t1 - time at step/stage being solved
-.  U1 - state vector at t1
+.  a - positive parameter which depends on the time integration method
+.  V - time derivative of the state vector at t0
+.  t - time at step/stage being solved
+.  U - state vector at t
 .  t0 - time at current step
 .  U0 - state vector at t0
 .  J - Jacobian matrix
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.