SUNStepper basics based on MRIStepInnerStepper #463

balos1 · 2024-04-29T22:37:04Z

I am opening this PR as a draft to gather feedback. This renames/moves MRIStepInnerStepper to SUNStepper so that @Steven-Roberts and I can extend it for other purposes.

src/arkode/arkode.c

src/arkode/arkode_arkstep.c

src/sundials/sundials_stepper.c

src/sundials/sundials_stepper_impl.h

balos1 · 2024-05-06T18:40:38Z

@drreynolds @gardner48 I have made the changes we discussed on Tuesday. Let me know what you think.

drreynolds

I like how clean this is now. I noticed a few items for comment (see below).

src/arkode/arkode_arkstep.c

src/arkode/xbraid/arkode_xbraid.c

src/sundials/sundials_stepper.c

include/sundials/sundials_stepper.h

src/arkode/arkode_arkstep.c

src/sundials/sundials_stepper.c

src/arkode/arkode_arkstep.c

include/sundials/sundials_stepper.h

src/arkode/arkode_arkstep.c

src/sundials/sundials_stepper.c

Steven-Roberts

Initial pass at latest changes

src/sundials/sundials_stepper.c

src/sundials/sundials_stepper_impl.h

include/sundials/sundials_stepper.h

src/sundials/sundials_stepper.c

include/sundials/sundials_stepper.h

Steven-Roberts · 2024-08-21T00:29:51Z

After some more thought and discussion with David on IDA and passing around yp, the primary issue I see is keeping it consistent with y. With operator splitting, for example, y jumps around between calls to evolve, and I don't see how to keep yp consistent. With MRI, the change in the forcing between stages can cause a similar issue. This is not something the outer methods can do and needs to be done in the inner SunStepper integrator.

I'd like to propose the following to make SunStepper self starting (all you need is y to reset then evolve):

Remove yp as arguments
To support an IDA SunStepper, have a constructor like

int IDACreateSUNStepper(void* inner_ida_mem, ConsistentYPrimeFn f, SUNStepper* stepper)

where there's a function which can be specified by users (we could have a default that uses IDACalcIC) to get yp given y.

gardner48 · 2024-10-23T03:05:19Z

doc/arkode/guide/source/Usage/ERKStep/User_callable.rst

@@ -33,6 +33,10 @@ ERKStep supports the following categories:
 * temporal adaptivity
 * relaxation Runge--Kutta methods

+ERKStep does not have forcing function support when converted to a


When #564 is merged (adds forcing support to ERKStep) this can be updated

gardner48 · 2024-10-23T03:07:21Z

doc/arkode/guide/source/Usage/MRIStep/User_callable.rst

@@ -33,6 +33,10 @@ MRIStep supports the following categories:

 * implicit nonlinear and/or linear solvers

+MRIStep does not have forcing function support when converted to a


When #564 is merged (adds forcing support to MRIStep) this can be updated

gardner48 · 2024-10-23T03:28:23Z

doc/arkode/guide/source/Usage/User_callable.rst

+   :retval ARK_SUNSTEPPER_ERR: the :c:type:`SUNStepper` initialization failed.
+
+   .. warning::
+      Currently, ``stepper`` will be equipped with an implementation for the


When #564 is merged this can be updated

doc/shared/sunstepper/SUNStepper_Description.rst

include/sundials/sundials_stepper.h

src/arkode/arkode_impl.h

src/arkode/arkode_mristep.c

src/sundials/sundials_stepper.c

Co-authored-by: David Gardner <[email protected]>

balos1 · 2024-10-30T18:46:43Z

I actually need the OneStep function in the adjoint work, so I have added it back into here.

balos1 assigned Steven-Roberts Apr 29, 2024

drreynolds reviewed Apr 30, 2024

View reviewed changes

src/arkode/arkode.c Outdated Show resolved Hide resolved

src/arkode/arkode_arkstep.c Outdated Show resolved Hide resolved

src/sundials/sundials_stepper.c Outdated Show resolved Hide resolved

src/sundials/sundials_stepper_impl.h Outdated Show resolved Hide resolved

balos1 changed the title ~~move MRIStepInnerStepper to SUNStepper~~ SUNStepper basics based on MRIStepInnerStepper May 6, 2024

drreynolds reviewed May 6, 2024

View reviewed changes

src/arkode/arkode_arkstep.c Outdated Show resolved Hide resolved

src/arkode/xbraid/arkode_xbraid.c Outdated Show resolved Hide resolved

src/sundials/sundials_stepper.c Outdated Show resolved Hide resolved

gardner48 reviewed May 12, 2024

View reviewed changes

Steven-Roberts reviewed May 13, 2024

View reviewed changes

gardner48 force-pushed the develop branch from 37f4a07 to 23581e8 Compare June 20, 2024 03:39

balos1 added 9 commits June 20, 2024 16:58

move MRIStepInnerStepper to SUNStepper

1267d97

add advance, onestep, trystep functions

19f921c

revert arkode changes

ca7768e

implement Advance, OneStep, and TryStep

bf3d836

cleanup

b96f1ee

wrap SUNStepper as MRIStepInnerStepper

e87e70f

update sunstepper evolve functions to pass tret and return reason

86db0fe

minor fixes

02fcf40

rebase fix

c04f24a

balos1 force-pushed the feature/sunstepper branch from a030d57 to c04f24a Compare June 21, 2024 00:04

balos1 added 8 commits July 1, 2024 15:08

Merge remote-tracking branch 'origin/develop' into feature/sunstepper

f9ff00c

Merge remote-tracking branch 'origin/develop' into feature/sunstepper

49e902c

Merge remote-tracking branch 'origin/develop' into feature/sunstepper

4be592c

bring up to date

1a92308

move trystep flahs

3c3a406

cleanup

cbfbd79

add yp arg

e6815d6

add setstoptime

c7d3f39

Steven-Roberts reviewed Aug 20, 2024

View reviewed changes

balos1 added 2 commits August 22, 2024 09:44

minor fixes

b7d7e08

add missing SetForcing declaration

491765f

Steven-Roberts added 2 commits October 14, 2024 11:24

Apply formatter

9641457

Merge branch 'develop' into feature/sunstepper

9a8d422

gardner48 requested changes Oct 23, 2024

View reviewed changes

Steven-Roberts and others added 23 commits October 23, 2024 06:38

Apply suggestions from code review

0549afd

Co-authored-by: David Gardner <[email protected]>

Add missing header

5c3cbf6

Remove step_supports_forcing

06e6875

Revert formatting change

d29b95e

Add public SUNStepper_FullRhs function

cb456e2

Apply suggestions from code review for evolve and one step functions

65eafd4

Co-authored-by: David Gardner <[email protected]>

Use backticks for arguments

dcc74c8

Remove unused SUNStepper_OneStep

e3a9a42

Remove t0 arg from SUNStepper_Evolve

127ff2d

Formatter and swig

9f483e0

Moved duplicated SUNStepper overview to shared folder

51406bc

Allow users to specify custom destroy function

f6b7866

Add missing SUNStepper_SetDestroyFn definition

10869c6

NULL destroy operation on creation

ae18e60

Make argument names consistent in docs and header

4893e19

Fix anonymous type linking error

4d238f0

Fix copy paste error

42b1f59

Add arkProcessError calls to ARKodeCreateSUNStepper

91900f5

Rename SUNStepper Jacobian typedefs

3a26598

Add mode argument back to SUNStepper full RHS

ad41aa0

Update docs for full RHS mode

76e4537

Swig and format

2e7859e

add onestep function back

15b0b7c

balos1 added 3 commits October 30, 2024 11:53

apply swig and format

c84f8d1

Merge branch 'develop' into feature/sunstepper

068fbd7

Merge branch 'develop' into feature/sunstepper

a8ab522

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SUNStepper basics based on MRIStepInnerStepper #463

SUNStepper basics based on MRIStepInnerStepper #463

balos1 commented Apr 29, 2024

balos1 commented May 6, 2024

drreynolds left a comment

Steven-Roberts left a comment

Steven-Roberts commented Aug 21, 2024 •

edited

Loading

gardner48 Oct 23, 2024

gardner48 Oct 23, 2024

gardner48 Oct 23, 2024

balos1 commented Oct 30, 2024

		@@ -33,6 +33,10 @@ MRIStep supports the following categories:

		* implicit nonlinear and/or linear solvers

		MRIStep does not have forcing function support when converted to a

SUNStepper basics based on MRIStepInnerStepper #463

Are you sure you want to change the base?

SUNStepper basics based on MRIStepInnerStepper #463

Conversation

balos1 commented Apr 29, 2024

balos1 commented May 6, 2024

drreynolds left a comment

Choose a reason for hiding this comment

Steven-Roberts left a comment

Choose a reason for hiding this comment

Steven-Roberts commented Aug 21, 2024 • edited Loading

gardner48 Oct 23, 2024

Choose a reason for hiding this comment

gardner48 Oct 23, 2024

Choose a reason for hiding this comment

gardner48 Oct 23, 2024

Choose a reason for hiding this comment

balos1 commented Oct 30, 2024

Steven-Roberts commented Aug 21, 2024 •

edited

Loading