Merge branch 'barry/2024-01-19/typedef-snes-functions' into 'main'

add typedef for functions passed to SNESSetFunction() etc to match approach in TS

See merge request petsc/petsc!7206

Change the use of the _Fn suffix to indicate a typedef of a function to just Fn

As determined on a vote on GitLab

Convert TS typedef functions to new style ending with _Fn

Commit-type: housekeeping, maintainability

add typedef for functions passed to SNESSetFunction() etc to match approach in TS

I never liked Jed's use of typedef for function prototypes for a couple of reasons

1) you don't see immediately tha

add typedef for functions passed to SNESSetFunction() etc to match approach in TS

I never liked Jed's use of typedef for function prototypes for a couple of reasons

1) you don't see immediately that the argument to the function is a function pointer instead of standard variable when looking at source
2) you don't see at the exact location in the code the prototype of the function being passed in

but there is something to say for using these typedefs so

I've prototyped the change for SNES but slightly differently than what Jed did for TS

1) I append the typedef with _Ftn to mark that it is a function (helping to relieve the problem 1 above)
2) I made the typedef to be for a function, not a function pointer so it can also be used directly for things like

PETSC_EXTERN SNESJacobian_Ftn SNESComputeJacobianDefault;

I think the TS usage could be switched to this style without user code breakage, and deprecate the current TS typedef

Thoughts?

Just do SNES the same way as TS and live with less clarity?

show more ...

Merge remote-tracking branch 'origin/release'

Merge branch 'stefanozampini/fix-docs' into 'release'

fix docs

See merge request petsc/petsc!7181

TS: fix docs

Merge remote-tracking branch 'origin/release'

Merge branch 'barry/2024-01-04/fix-includes-man-pages/release' into 'release'

Barry/2024 01 04/fix includes man pages/release

See merge request petsc/petsc!7165

Fix manual page formating in include directory

Merge branch 'ilya-fursov/ts-fixevent2' into 'main'

TSEvent: refactor and fix bugs, add TSSetPostEventStep()

See merge request petsc/petsc!6752

Implement setting two distinct post-event steps

The two post-event steps are managed by:
TSSetPostEventStep(), -ts_event_post_event_step,
TSSetPostEventSecondStep(), -ts_event_post_event_second_step

Implement setting two distinct post-event steps

The two post-event steps are managed by:
TSSetPostEventStep(), -ts_event_post_event_step,
TSSetPostEventSecondStep(), -ts_event_post_event_second_step.

(The latter function and option are replacement for the original PETSc
TSSetPostEventIntervalStep(), -ts_event_post_eventinterval_step,
with some change of overall behaviour of 1st + 2nd steps).

Also, reduce the number of tests ~ 4 times.

show more ...

TSEvent: refactor and fix bugs, add TSSetPostEventStep()

Refactor the core algorithm for resolution of events: TSEventHandler()
and the helper functions, fixing the existing bugs.

Chang

TSEvent: refactor and fix bugs, add TSSetPostEventStep()

Refactor the core algorithm for resolution of events: TSEventHandler()
and the helper functions, fixing the existing bugs.

Change event indicator functions from PetscScalar to PetscReal.
Change the API of TSSetEventHandler(): in the user `indicator()` callback,
the 'fvalue' argument type changed from PetscScalar[] to PetscReal[].

Add TSSetPostEventStep(), deprecate TSSetPostEventIntervalStep().
Deprecate option -ts_event_post_eventinterval_step.

Fix bugs in interaction of TSEvent with tspan.
Add six new test examples.

Below are the examples of bugs fixed by this patch.
The source codes (ex3.c, ex3span.c, ex4.c, ex5.c) can be found
in src/ts/event/tests. To run them with the older Petsc versions,
one would need to comment out "#define NEW_VERSION".
Behaviour for three library versions is reported below:
* ORIG: current Petsc version, before the proposed patch.
* 6688: independently of the proposed patch, Merge Request 6688 was
developed, which fixed some bugs with zero-crossing directions.
* NEW : the proposed patch.

./ex3 -ts_monitor -ts_event_monitor -ts_view -ts_type beuler \
-ts_adapt_type basic -flg -V 1e9 -ts_adapt_dt_min 1e-6 -change5 1 -dir 1
* ORIG: fails to resolve 5 out of 6 events, and resolves 23 incorrect events.
* 6688: fails to exit the TSEvent iteration via the step size (bracket size)
criterion.
* NEW : ok, resolves all 6 events.

./ex4 -ts_adapt_type basic -ts_type rk -ts_dt 0.25 -ts_event_tol 1e-8 \
-dir 0 -ts_adapt_dt_min 1e-10 -ts_view -ts_monitor -ts_event_monitor
* ORIG: only reaches t = 0.0300236 after 10000 TS steps.
* 6688: only reaches t = 0.0300236 after 10000 TS steps.
* NEW : ok, reaches the final time t = 4.0 after 96 TS steps, resolving
all 16 events.

./ex5 -ts_monitor -ts_event_monitor -ts_type rk -ts_adapt_type basic \
-ts_view -ts_dt 0.25 -flg -dir 0
* ORIG: only reaches t = 4.0 after 10000 TS steps, erroneously reports
event at t = 4.0 around 5000 times.
* 6688: only reaches t = 4.0 after 10000 TS steps.
* NEW : ok, reaches the final time t = 10.0 after 99 TS steps, resolving
all 34 events.

./ex5 -ts_monitor -ts_event_monitor -ts_type rk -ts_adapt_type basic \
-ts_view -ts_dt 0.25 -flg -dir 1
* ORIG: fails, starts taking negative time steps, no events are correctly
resolved.
* 6688: ok, but slower: 90 TS steps to resolve all 17 events.
* NEW : ok, and faster: 48 TS steps to resolve all 17 events.

./ex5 -ts_monitor -ts_event_monitor -ts_type rk -ts_adapt_type basic \
-ts_view -ts_dt 0.25 -flg -dir -1
* ORIG: fails, starts taking 'nan' time steps.
* 6688: mostly fails, only reaches t = 4.99993 after 10000 TS steps.
* NEW : ok, reaches the final time t = 10.0 after 74 TS steps, resolving
all 17 events.

The same run in parallel:
mpirun -n 2 ./ex5 -ts_monitor -ts_event_monitor -ts_type rk \
-ts_adapt_type basic -ts_view -ts_dt 0.25 -flg -dir -1
* ORIG: fails, starts taking negative time steps, exits with runtime error.
* 6688: mostly fails, only reaches t = 3, besides, the parallel run is not
consistent with the serial run (see above).
* NEW : ok, reaches the final time t = 10.0 after 74 TS steps, resolving
all 17 events.

./ex3span -ts_monitor -ts_event_monitor
* ORIG: (confused by events) misses tspan points: 4.02, 4.21, 4.98, 5.01,
5.21, 5.98, 6, 6.01, 6.02, 6.21, 6.99, 7.21, 8.01, 8.21, 9.01.
* 6688: (confused by events) misses tspan points: 4.02, 4.21, 4.98, 5.01,
5.21, 5.98, 6, 6.01, 6.02, 6.21, 6.99, 7.21, 8.01, 8.21, 9.01.
* NEW : ok.

./ex3span -ts_monitor -ts_event_monitor -ts_event_post_event_step 0.5
* ORIG: misses the majority of tspan points (except 0.01 and 0.21),
and also resolves the last event location at wrong time t = 9.21.
* 6688: misses the majority of tspan points (except 0.01 and 0.21),
and also resolves the last event location at wrong time t = 9.21.
* NEW : ok.

show more ...

Merge remote-tracking branch 'origin/release'

Merge branch 'barry/2023-11-20/docs-manpage-minor-work/release' into 'release'

Minor work on manual pages (in include directory)

See merge request petsc/petsc!7042

Minor work on manual pages (in include directory)

Merge branch 'jolivet/fix-seealso' into 'main'

Ensure no leading white spaces in front of .seealso:

See merge request petsc/petsc!7027

Ensure no leading white spaces in front of .seealso:

Merge branch 'david-kamensky/alpha2-predictor-callback' into 'main'

Add function to set predictor callback for 2nd-order generalized-alpha

See merge request petsc/petsc!6787

Adding option for custom predictor in 2nd-order generalized-alpha time integrator.

Merge branch 'jacobf/2023-08-17/header-guard-check' into 'main'

Check header guards

See merge request petsc/petsc!6822

Convert all header guards to pragma once

Merge branch 'jacobf/2023-08-09/linter-detect-static-function-candidates' into 'main'

Linter detect possible static functions

See merge request petsc/petsc!6796

Merge branch 'stefanozampini/ts-dirk' into 'main'

Diagonally Implicit Runge Kutta

See merge request petsc/petsc!6774

TSDIRK: add docs and python bindings

use TR-BDF2 as default
update documentation