Feature/sunadjoint #559
Open
Feature/sunadjoint #559
+17,768
−385
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Steven Roberts <roberts115@llnl.gov>
drreynolds
reviewed
Nov 13, 2024
| :param cs: The :c:type:`SUNAdjointCheckpointScheme` object | ||
| :param step_num: the step number of the checkpoint | ||
| :param stage_num: the stage number of the checkpoint | ||
| :param t: the time of the checkpoint |
There was a problem hiding this comment.
t is not an argument to this function
Suggested change
| :param t: the time of the checkpoint |
(or if it is, then the signature above needs to be fixed)
| :param keep: Keep data stored even after it is not needed anymore. | ||
| :param sunctx: The :c:type:`SUNContext` for the simulation. | ||
| :param check_scheme_ptr: Pointer to the newly constructed object. | ||
| :return: A :c:type:`SUNErrCode` indicating success or failure. |
There was a problem hiding this comment.
Does this need a preceding blank line (like the other .. c:function:: blocks above)?
Suggested change
| :return: A :c:type:`SUNErrCode` indicating success or failure. | |
| :return: A :c:type:`SUNErrCode` indicating success or failure. |
|
|
||
| .. c:member:: SUNMatrix Jac | ||
|
|
||
| Matrix data for the Jacobian :math:`df/dy`. |
There was a problem hiding this comment.
I apologize in advance, but the math professor in me needs these Jacobians to be denoted correctly (since
Suggested change
| Matrix data for the Jacobian :math:`df/dy`. | |
| Matrix data for the Jacobian :math:`\partial f/\partial y`. |
There was a problem hiding this comment.
Good catch. It was not in :math: originally, it was plain text so\partial was not used. When I just did a find/replace to add the :math: I overlooked this.
|
|
||
| .. c:member:: SUNMatrix JacP | ||
|
|
||
| Matrix data for the Jacobian :math:`df/dp`. |
There was a problem hiding this comment.
Suggested change
| Matrix data for the Jacobian :math:`df/dp`. | |
| Matrix data for the Jacobian :math:`\partial f/\partial p`. |
|
|
||
| .. c:member:: SUNRhsJacFn JacFn | ||
|
|
||
| Jacobian function pointer to evaluate :math:`df/dy`. |
There was a problem hiding this comment.
Suggested change
| Jacobian function pointer to evaluate :math:`df/dy`. | |
| Jacobian function pointer to evaluate :math:`\partial f/\partial y`. |
Comment on lines
+215
to
+219
| Sets the function pointers to evaluate :math:`(df/dy)^T v` and :math:`(df/dp)^T v` | ||
|
|
||
| :param adj_stepper: The SUNAdjointStepper object. | ||
| :param Jvp: function that evaluates :math:`(df/dy)^T v`. | ||
| :param JPvp: function that evaluates :math:`(df/dp)^T v`. |
There was a problem hiding this comment.
Suggested change
| Sets the function pointers to evaluate :math:`(df/dy)^T v` and :math:`(df/dp)^T v` | |
| :param adj_stepper: The SUNAdjointStepper object. | |
| :param Jvp: function that evaluates :math:`(df/dy)^T v`. | |
| :param JPvp: function that evaluates :math:`(df/dp)^T v`. | |
| Sets the function pointers to evaluate :math:`(\partial f/\partial y)^T v` and :math:`(\partial f/\partial p)^T v` | |
| :param adj_stepper: The SUNAdjointStepper object. | |
| :param Jvp: function that evaluates :math:`(\partial f/\partial y)^T v`. | |
| :param JPvp: function that evaluates :math:`(\partial f/\partial p)^T v`. |
Comment on lines
+227
to
+231
| Sets the function pointers to evaluate :math:`v^T (df/dy)` and :math:`v^T (df/dp)` | ||
|
|
||
| :param adj_stepper: The SUNAdjointStepper object. | ||
| :param Jvp: function that evaluates :math:`v^T (df/dy)`. | ||
| :param JPvp: function that evaluates :math:`v^T (df/dp)`. |
There was a problem hiding this comment.
Suggested change
| Sets the function pointers to evaluate :math:`v^T (df/dy)` and :math:`v^T (df/dp)` | |
| :param adj_stepper: The SUNAdjointStepper object. | |
| :param Jvp: function that evaluates :math:`v^T (df/dy)`. | |
| :param JPvp: function that evaluates :math:`v^T (df/dp)`. | |
| Sets the function pointers to evaluate :math:`v^T (\partial f/\partial y)` and :math:`v^T (\partial f/\partial p)` | |
| :param adj_stepper: The SUNAdjointStepper object. | |
| :param Jvp: function that evaluates :math:`v^T (\partial f/\partial y)`. | |
| :param JPvp: function that evaluates :math:`v^T (\partial f/\partial p)`. |
Comment on lines
+177
to
+180
| Performs the matrix-vector product *y \gets A^Tx*. It should | ||
| only be called with vectors *x* and *y* that are compatible with | ||
| the matrix *A^T* -- both in storage type and dimensions. The return | ||
| value denotes the success/failure of the operation: |
There was a problem hiding this comment.
Should these use :math: mode?
Suggested change
| Performs the matrix-vector product *y \gets A^Tx*. It should | |
| only be called with vectors *x* and *y* that are compatible with | |
| the matrix *A^T* -- both in storage type and dimensions. The return | |
| value denotes the success/failure of the operation: | |
| Performs the matrix-vector product :math:`y \gets A^Tx`. It should | |
| only be called with vectors :math:`x` and :math:`y` that are compatible with | |
| the matrix :math:`A^T` -- both in storage type and dimensions. The return | |
| value denotes the success/failure of the operation: |
Comment on lines
+51
to
+56
| # "ark_test_erkadjoint.cpp\;--check-freq 1 --no-stages\;" | ||
| # "ark_test_erkadjoint.cpp\;--check-freq 2 --no-stages\;" | ||
| # "ark_test_erkadjoint.cpp\;--check-freq 5 --no-stages\;" | ||
| # "ark_test_erkadjoint.cpp\;--check-freq 1 --dont-keep --no-stages\;" | ||
| # "ark_test_erkadjoint.cpp\;--check-freq 2 --dont-keep --no-stages\;" | ||
| # "ark_test_erkadjoint.cpp\;--check-freq 5 --dont-keep --no-stages\;" |
There was a problem hiding this comment.
Should these just be deleted from the file instead of commented out?
Suggested change
| # "ark_test_erkadjoint.cpp\;--check-freq 1 --no-stages\;" | |
| # "ark_test_erkadjoint.cpp\;--check-freq 2 --no-stages\;" | |
| # "ark_test_erkadjoint.cpp\;--check-freq 5 --no-stages\;" | |
| # "ark_test_erkadjoint.cpp\;--check-freq 1 --dont-keep --no-stages\;" | |
| # "ark_test_erkadjoint.cpp\;--check-freq 2 --dont-keep --no-stages\;" | |
| # "ark_test_erkadjoint.cpp\;--check-freq 5 --dont-keep --no-stages\;" |
Comment on lines
+514
to
+521
| // TODO(CJB): figure out why ForwardDiff, CVODES, and ERK adjoint all differ | ||
| // if (check_sensitivities_backward(sf)) | ||
| // { | ||
| // fprintf(stderr, | ||
| // ">>> FAILURE: adjoint solution does not match correct answer\n"); | ||
| // return -1; | ||
| // }; | ||
| // printf(">>> PASS\n"); |
There was a problem hiding this comment.
Is this "TODO(CJB)" still relevant, or should the comment and associated code be deleted?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.