Skip to content

Commit

Permalink
Merge pull request #305 in SUNDIALS/sunrepo from feature/anderson-bet…
Browse files Browse the repository at this point in the history 
…a to develop

Squashed commit of the following:

commit 8e392b4b4ce73077402a8a93526d723ce68f5a89
Author: David J. Gardner <[email protected]>
Date:   Tue Jan 7 11:06:37 2020 -0800

    doc fixes

commit 1c63c05bc7a02655c50c3fbcc4672cb4e61654de
Merge: 3bb8e407a 520a88c
Author: David J. Gardner <[email protected]>
Date:   Mon Jan 6 09:58:55 2020 -0800

    Merge branch 'develop' into feature/anderson-beta

    Conflicts:
      src/kinsol/kinsol.c

commit 3bb8e407a72769fba3c7d4a3c305490848112a0c
Author: David J. Gardner <[email protected]>
Date:   Thu Dec 19 10:52:02 2019 -0800

    ignore emacs temporary files

commit 14e3e70eb345245cc7065ffbd4ee7e79b11b9a32
Author: David J. Gardner <[email protected]>
Date:   Thu Dec 19 10:51:45 2019 -0800

    remove temporary file

commit da0d2a30c4ce82415fb4986ea83d93aa4a6c4a68
Author: David J. Gardner <[email protected]>
Date:   Thu Dec 19 10:44:45 2019 -0800

    not legal beta values in docs

commit 988a54e8eb2da1e1176f9b59acded1f2c373788d
Author: David J. Gardner <[email protected]>
Date:   Thu Dec 19 10:36:52 2019 -0800

    return error is beta is zero

commit 4c4baa7c24376e81469c40eb29a12d991b6162fe
Author: David J. Gardner <[email protected]>
Date:   Mon Dec 16 14:00:34 2019 -0800

    increase max iters (needed with extended precision)

commit 87fdd32b49d19273c685f5b44c7543bd8aa50e05
Merge: 716789b6e e2a47c0
Author: David J. Gardner <[email protected]>
Date:   Mon Dec 16 10:38:24 2019 -0800

    Merge branch 'develop' into feature/anderson-beta

    Conflicts:
      doc/arkode/ARKode.tex

commit 716789b6ec89b01e57b991277538157057bd25fb
Author: Balos, Cody Joe <[email protected]>
Date:   Mon Dec 16 10:05:24 2019 -0800

    regen f2003 interfaces

commit 9c43eb2c25611c062b6bfb30f6a3ab3ae9a2758b
Author: David J. Gardner <[email protected]>
Date:   Mon Dec 16 09:25:12 2019 -0800

    update recent changes

commit 2382b132be8e51d444a947e0b2989df8e2542210
Author: David J. Gardner <[email protected]>
Date:   Mon Dec 16 09:21:13 2019 -0800

    update xsdk script

commit 7d01dc9b6929377391fccd7758899d03e270d0f1
Author: David J. Gardner <[email protected]>
Date:   Mon Dec 16 09:11:08 2019 -0800

    update tarscript

commit 5f89b038e1f4eb3185425d5e4dc651474cc579a7
Author: David J. Gardner <[email protected]>
Date:   Mon Dec 16 09:08:58 2019 -0800

    remove unused macros

commit b28a8b1d13a570781a104418e1129344fc3c11e2
Author: David J. Gardner <[email protected]>
Date:   Mon Dec 16 09:08:38 2019 -0800

    minor doc fixes

commit 7d0a7047515443a88c518a7a816fa3a66335a25d
Author: David J. Gardner <[email protected]>
Date:   Sun Dec 15 19:12:42 2019 -0800

    fix output formatting

commit 959b70fc7959548484b19a565dbd88e3bd8b885f
Author: David J. Gardner <[email protected]>
Date:   Sun Dec 15 19:09:12 2019 -0800

    fix maa, maxiters types

commit b2404989702dc731bbdcf3ae4d297dd8fd99f12f
Author: David J. Gardner <[email protected]>
Date:   Sun Dec 15 13:39:55 2019 -0800

    update docs

commit 7ef46dd295c56e2e5c0d352ea3ec6e85859446ab
Author: David J. Gardner <[email protected]>
Date:   Sat Dec 14 21:12:22 2019 -0800

    make maa input, add more test cases

commit b5735d45880838d1e59f8bb047d2f6520ec14594
Author: David J. Gardner <[email protected]>
Date:   Sat Dec 14 20:41:32 2019 -0800

    update sun nls module test

commit f29548293a1dff55cc2b97c7aa1b9c802107eee9
Author: David J. Gardner <[email protected]>
Date:   Sat Dec 14 20:40:40 2019 -0800

    update fused op workspace

commit a7cf94222a1d1e85575cef69762394e910de4aab
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 17:29:46 2019 -0800

    add comments

commit 0016a261b2564282d1fafbe703d893a5366b3c52
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 17:27:23 2019 -0800

    remove unnecessary else

commit 43b56fd1fdd13ffe0c45cab90f2e6a2ab90421c5
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 17:23:11 2019 -0800

    return immediately after first iteration update

commit 77caa3c651661f3149861a4376424462dbaf4835
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 17:17:08 2019 -0800

    add damping option to sunnls module

commit cee1694d7534c4ca1e8750a81549301c181f7a3d
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 17:16:16 2019 -0800

    change usebeta_aa to damping_aa

commit 4b1fc3d604b4a5908799e5900a2ca5b45e7a9895
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 15:11:38 2019 -0800

    add option to set beta in test

commit a41eae7db906f37ad91151258c7fb54ab9c59d0c
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 15:10:41 2019 -0800

    rename var for clarity

commit f846bf6198adbb573aa3886408bd49c7396f13b5
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 15:10:04 2019 -0800

    change default beta

commit 7a965966c4dc3b8cf2ca101810e5a74c0460e4b8
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 14:55:37 2019 -0800

    fix allocation of fused op workspace

commit f53ab0d3b182df93211c484239b4a9a035414144
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 14:38:57 2019 -0800

    fix set beta

commit d4982e71db8c9d1736e84c5459b40d97aa990d3e
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 13:05:18 2019 -0800

    fix comment

commit 251229fc9f311393cb27628caca6b361e55f7a27
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 12:11:31 2019 -0800

    remove accidentally added file

commit c4e596312abf2f8d311f08ede5f6df002d6ee008
Merge: 84ffae22e cce11cd
Author: David J. Gardner <[email protected]>
Date:   Fri Dec 13 12:09:24 2019 -0800

    Merge branch 'develop' into feature/anderson-beta

    Conflicts:
      test/suntest.sh

commit 84ffae22e9cb641d3452312f55296bade10fc40c
Author: David J. Gardner <[email protected]>
Date:   Fri Nov 22 11:47:55 2019 -0800

    enable beta in example

commit 10de8adc7e8125561b8f33eff4891cec6cb15879
Author: David J. Gardner <[email protected]>
Date:   Fri Nov 22 11:47:32 2019 -0800

    increase fused op workspace for beta damping

commit da9d852f767ff1ff82a553b2059251112068aa31
Author: David J. Gardner <[email protected]>
Date:   Fri Nov 22 11:38:28 2019 -0800

    add optional testing vars to testing script

commit e6281ca67dee66745f96e59f528950984c099172
Author: David J. Gardner <[email protected]>
Date:   Fri Nov 22 11:37:30 2019 -0800

    require python for devtests, error if testrunner not found, status message for non-default precision

commit 0af65ed756eed951f1a6a750fd0ef8e655453fa5
Author: David J. Gardner <[email protected]>
Date:   Fri Nov 22 11:04:03 2019 -0800

    add status message if using non-default output or answer dir

commit 0771efb895b7a9d9eb7ac2c52830e7badd824130
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 17:24:51 2019 -0800

    add set function for beta_aa

commit ce8072a55483516f50152d3ec890f9d65f7625fe
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 17:10:06 2019 -0800

    clean up kinfp

commit 001769d57babd2815feeef0d34f0169c745b73d3
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 16:32:25 2019 -0800

    wrap some long lines

commit 9e786c6f93fd17bb31dc2ae3e6c9090011bf2c0e
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 15:55:53 2019 -0800

    remove readability constants

commit b47ad73e37ab061beda2b00cae29ce957a27c835
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 15:43:56 2019 -0800

    add analtytic FP example

commit 0abc5b7f182fe9bc4a6a3d7e5f36a601391e5213
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 15:41:16 2019 -0800

    minor updates to sunnls fp test

commit 50733db5b8e9bf97a74ccc48b682582126fa21a2
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 15:24:02 2019 -0800

    only add -std=c90 for double precision

commit 566a5fea5643ed228a03eb03b6664702a8463c87
Author: David J. Gardner <[email protected]>
Date:   Thu Nov 21 11:48:12 2019 -0800

    add precision dependent macros to example

commit 96d0c72424a4e659e92e63b35c30050276e6258a
Author: David J. Gardner <[email protected]>
Date:   Tue Nov 19 17:29:29 2019 -0800

    initial code for aa beta damping
  • Loading branch information
@gardner48
gardner48 committed Jan 7, 2020
1 parent 520a88c commit 91b0738
Show file tree
Hide file tree
Showing 35 changed files with 1,472 additions and 451 deletions.
2 changes: 1 addition & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
*.nvvp
*.ptp-sync*
*~
\#*

# OS X
.DS_Store
Expand Down Expand Up @@ -68,4 +69,3 @@

# editor files
.vscode

33 changes: 25 additions & 8 deletions config/SundialsTesting.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,42 +18,59 @@
include(CTest)


# If development tests are enabled, Python is needed to use the test runner
# Check if development tests are enabled
if(SUNDIALS_TEST_DEVTESTS)

find_package(PythonInterp)
message("SUNDIALS Development testing")

# Python is needed to use the test runner
find_package(PythonInterp REQUIRED)
if(${PYTHON_VERSION_MAJOR} LESS 3)
if(${PYTHON_VERSION_MINOR} LESS 7)
print_warning("Python version must be 2.7.x or greater to run development tests"
"Examples will build but 'make test' will fail.")
"Examples will build but 'make test' may fail.")
endif()
endif()

# Default test output directory
# look for the testRunner script in the test directory
find_program(TESTRUNNER testRunner PATHS test NO_DEFAULT_PATH)
if(NOT TESTRUNNER)
print_error("Could not locate testRunner. Set SUNDIALS_TEST_DEVTESTS=OFF to continue.")
endif()
message(STATUS "Found testRunner: ${TESTRUNNER}")
hide_variable(TESTRUNNER)

# Create the default test output directory
set(TEST_OUTPUT_DIR ${PROJECT_BINARY_DIR}/Testing/output)

# Create test output directory
if(NOT EXISTS ${TEST_OUTPUT_DIR})
file(MAKE_DIRECTORY ${TEST_OUTPUT_DIR})
endif()

# If a non-default output directory was provided make sure it exists
if(SUNDIALS_TEST_OUTPUT_DIR)
message(STATUS "Using non-default test output directory: ${SUNDIALS_TEST_OUTPUT_DIR}")
if(NOT EXISTS ${SUNDIALS_TEST_OUTPUT_DIR})
file(MAKE_DIRECTORY ${SUNDIALS_TEST_OUTPUT_DIR})
endif()
endif()

# If a non-default answer directory was provided make sure it exists
if(SUNDIALS_TEST_ANSWER_DIR)
message(STATUS "Using non-default test answer directory: ${SUNDIALS_TEST_ANSWER_DIR}")
if(NOT EXISTS ${SUNDIALS_TEST_ANSWER_DIR})
print_error("SUNDIALS_TEST_ANSWER_DIR does not exist!")
endif()
endif()

# look for the testRunner script in the test directory
find_program(TESTRUNNER testRunner PATHS test)
hide_variable(TESTRUNNER)
# Check if using non-default comparison precisions when testing
if(SUNDIALS_TEST_FLOAT_PRECISION)
message(STATUS "Using non-default float precision: ${SUNDIALS_TEST_FLOAT_PRECISION}")
endif()

if(SUNDIALS_TEST_INTEGER_PRECISION)
message(STATUS "Using non-default integer precision: ${SUNDIALS_TEST_INTEGER_PRECISION}")
endif()

endif()

Expand Down
108 changes: 74 additions & 34 deletions doc/arkode/ARKode.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,10 @@ \subsection{Changes in x.x.x}
not set the pointer for both the inner and outer integrators. The MRIStep
examples have been updated to reflect this change.

Added support for constant damping to the \code{SUNNonlinearSolver\_FixedPoint} module
when using Anderson acceleration. See {\hyperref[sunnonlinsol/SUNNonlinSol_FixedPoint:sunnonlinsolfixedpoint-math]{\emph{\DUspan{}{SUNNonlinearSolver\_FixedPoint description}}}}
and the {\hyperref[sunnonlinsol/SUNNonlinSol_FixedPoint:c.SUNNonlinSolSetDamping_FixedPoint]{\emph{\code{SUNNonlinSolSetDamping\_FixedPoint()}}}} for more details.


\subsection{Changes in v4.0.0}
\label{Introduction:changes-in-v4-0-0}
Expand Down Expand Up @@ -40662,7 +40666,7 @@ \subsection{SUNNonlinearSolver\_FixedPoint description}
size \(m\), the series of approximate solutions can be formulated
as the linear combination
\phantomsection\label{sunnonlinsol/SUNNonlinSol_FixedPoint:equation-e:accelerated_fixed_point_iteration}\begin{gather}
\begin{split}y^{(n+1)} = \sum_{i=0}^{m_n} \alpha_i^{(n)} G(y^{(n-m_n+i)})\end{split}\label{sunnonlinsol/SUNNonlinSol_FixedPoint-e:accelerated_fixed_point_iteration}
\begin{split}y^{(n+1)} = \beta \sum_{i=0}^{m_n} \alpha_i^{(n)} G(y^{(n-m_n+i)}) + (1 - \beta) \sum_{i=0}^{m_n} \alpha_i^{(n)} y_{n-m_n+i}\end{split}\label{sunnonlinsol/SUNNonlinSol_FixedPoint-e:accelerated_fixed_point_iteration}
\end{gather}
where \(m_n = \min{\{m,n\}}\) and the factors
\begin{gather}
Expand All @@ -40682,7 +40686,7 @@ \subsection{SUNNonlinearSolver\_FixedPoint description}
SUNNonlinSol\_FixedPoint implementation computes the series of
approximate solutions as
\phantomsection\label{sunnonlinsol/SUNNonlinSol_FixedPoint:equation-e:accelerated_fixed_point_iteration_impl}\begin{gather}
\begin{split}y^{(n+1)} = G(y^{(n)})-\sum_{i=0}^{m_n-1} \gamma_i^{(n)} \Delta g_{n-m_n+i}\end{split}\label{sunnonlinsol/SUNNonlinSol_FixedPoint-e:accelerated_fixed_point_iteration_impl}
\begin{split}y^{(n+1)} = G(y^{(n)})-\sum_{i=0}^{m_n-1} \gamma_i^{(n)} \Delta g_{n-m_n+i} - (1 - \beta) (f(y^{(n)}) - \sum_{i=0}^{m_n-1} \gamma_i^{(n)} \Delta f_{n-m_n+i})\end{split}\label{sunnonlinsol/SUNNonlinSol_FixedPoint-e:accelerated_fixed_point_iteration_impl}
\end{gather}
with \(\Delta g_i = G(y^{(i+1)}) - G(y^{(i)})\) and where the
factors
Expand Down Expand Up @@ -40754,7 +40758,7 @@ \subsection{SUNNonlinearSolver\_FixedPoint functions}
SUNNonlinSol\_FixedPoint-specific implementations.

The SUNNonlinSol\_FixedPoint module also defines the following additional
user-callable function.
user-callable functions.
\index{SUNNonlinSolGetSysFn\_FixedPoint (C function)}

\begin{fulllineitems}
Expand All @@ -40764,7 +40768,7 @@ \subsection{SUNNonlinearSolver\_FixedPoint functions}
\begin{description}
\item[{\textbf{Arguments:}}] \leavevmode\begin{itemize}
\item {}
\emph{NLS} -- a SUNNonlinSol object
\emph{NLS} -- a SUNNonlinSol object.

\item {}
\emph{SysFn} -- the function defining the nonlinear system.
Expand All @@ -40773,7 +40777,7 @@ \subsection{SUNNonlinearSolver\_FixedPoint functions}

\end{description}

\textbf{Return value:} the return value should be zero for a
\textbf{Return value:} The return value is zero for a
successful call, and a negative value for a failure.

\textbf{Notes:} This function is intended for users that wish to
Expand All @@ -40784,6 +40788,34 @@ \subsection{SUNNonlinearSolver\_FixedPoint functions}

\end{fulllineitems}

\index{SUNNonlinSolSetDamping\_FixedPoint (C function)}

\begin{fulllineitems}
\phantomsection\label{sunnonlinsol/SUNNonlinSol_FixedPoint:c.SUNNonlinSolSetDamping_FixedPoint}\pysiglinewithargsret{int \bfcode{SUNNonlinSolSetDamping\_FixedPoint}}{SUNNonlinearSolver\emph{ NLS}, realtype\emph{ beta}}{}
The function {\hyperref[sunnonlinsol/SUNNonlinSol_FixedPoint:c.SUNNonlinSolSetDamping_FixedPoint]{\emph{\code{SUNNonlinSolSetDamping\_FixedPoint()}}}} sets the damping
parameter \(\beta\) to use with Anderson acceleration. By default damping
is disabled i.e., \(\beta = 1.0\).
\begin{description}
\item[{\textbf{Arguments:}}] \leavevmode\begin{itemize}
\item {}
\emph{NLS} -- a SUNNonlinSol object.

\item {}
\emph{beta} -- the damping parameter \(0 < \beta \leq 1\).

\end{itemize}

\end{description}

\textbf{Return value:} The return value is zero for a successful call,
\code{SUN\_NLS\_MEM\_NULL} if \code{NLS} is \code{NULL}, or \code{SUN\_NLS\_ILL\_INPUT} if
\code{beta} is negative.

\textbf{Notes:} A \code{beta} value should be great than zero and less than one if
damping is to be used. A value of one or more will disable damping.

\end{fulllineitems}



\subsection{SUNNonlinearSolver\_FixedPoint content}
Expand All @@ -40797,25 +40829,27 @@ \subsection{SUNNonlinearSolver\_FixedPoint content}
\PYG{n}{SUNNonlinSolSysFn} \PYG{n}{Sys}\PYG{p}{;}
\PYG{n}{SUNNonlinSolConvTestFn} \PYG{n}{CTest}\PYG{p}{;}

\PYG{k+kt}{int} \PYG{n}{m}\PYG{p}{;}
\PYG{k+kt}{int} \PYG{o}{*}\PYG{n}{imap}\PYG{p}{;}
\PYG{n}{realtype} \PYG{o}{*}\PYG{n}{R}\PYG{p}{;}
\PYG{n}{realtype} \PYG{o}{*}\PYG{n}{gamma}\PYG{p}{;}
\PYG{n}{realtype} \PYG{o}{*}\PYG{n}{cvals}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{df}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{dg}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{q}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{Xvecs}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{yprev}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{gy}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{fold}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{gold}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{delta}\PYG{p}{;}
\PYG{k+kt}{int} \PYG{n}{curiter}\PYG{p}{;}
\PYG{k+kt}{int} \PYG{n}{maxiters}\PYG{p}{;}
\PYG{k+kt}{long} \PYG{k+kt}{int} \PYG{n}{niters}\PYG{p}{;}
\PYG{k+kt}{long} \PYG{k+kt}{int} \PYG{n}{nconvfails}\PYG{p}{;}
\PYG{k+kt}{void} \PYG{o}{*}\PYG{n}{ctest\PYGZus{}data}\PYG{p}{;}
\PYG{k+kt}{int} \PYG{n}{m}\PYG{p}{;}
\PYG{k+kt}{int} \PYG{o}{*}\PYG{n}{imap}\PYG{p}{;}
\PYG{n}{realtype} \PYG{o}{*}\PYG{n}{R}\PYG{p}{;}
\PYG{n}{booleantype} \PYG{n}{damping}
\PYG{n}{realtype} \PYG{n}{beta}
\PYG{n}{realtype} \PYG{o}{*}\PYG{n}{gamma}\PYG{p}{;}
\PYG{n}{realtype} \PYG{o}{*}\PYG{n}{cvals}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{df}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{dg}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{q}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{o}{*}\PYG{n}{Xvecs}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{yprev}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{gy}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{fold}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{gold}\PYG{p}{;}
\PYG{n}{N\PYGZus{}Vector} \PYG{n}{delta}\PYG{p}{;}
\PYG{k+kt}{int} \PYG{n}{curiter}\PYG{p}{;}
\PYG{k+kt}{int} \PYG{n}{maxiters}\PYG{p}{;}
\PYG{k+kt}{long} \PYG{k+kt}{int} \PYG{n}{niters}\PYG{p}{;}
\PYG{k+kt}{long} \PYG{k+kt}{int} \PYG{n}{nconvfails}\PYG{p}{;}
\PYG{k+kt}{void} \PYG{o}{*}\PYG{n}{ctest\PYGZus{}data}\PYG{p}{;}
\PYG{p}{\PYGZcb{}}\PYG{p}{;}
\end{Verbatim}

Expand Down Expand Up @@ -40864,34 +40898,40 @@ \subsection{SUNNonlinearSolver\_FixedPoint content}
allocated within the \emph{content} field:
\begin{itemize}
\item {}
\code{imap} -- index array used in acceleration algorithm (length \code{m}),
\code{imap} -- index array used in acceleration algorithm (length \code{m}),

\item {}
\code{damping} -- a flag indicating if damping is enabled,

\item {}
\code{beta} -- the damping parameter,

\item {}
\code{R} -- small matrix used in acceleration algorithm (length \code{m*m}),
\code{R} -- small matrix used in acceleration algorithm (length \code{m*m}),

\item {}
\code{gamma} -- small vector used in acceleration algorithm (length \code{m}),
\code{gamma} -- small vector used in acceleration algorithm (length \code{m}),

\item {}
\code{cvals} -- small vector used in acceleration algorithm (length \code{m+1}),
\code{cvals} -- small vector used in acceleration algorithm (length \code{m+1}),

\item {}
\code{df} -- array of \code{N\_Vectors} used in acceleration algorithm (length \code{m}),
\code{df} -- array of \code{N\_Vectors} used in acceleration algorithm (length \code{m}),

\item {}
\code{dg} -- array of \code{N\_Vectors} used in acceleration algorithm (length \code{m}),
\code{dg} -- array of \code{N\_Vectors} used in acceleration algorithm (length \code{m}),

\item {}
\code{q} -- array of \code{N\_Vectors} used in acceleration algorithm (length \code{m}),
\code{q} -- array of \code{N\_Vectors} used in acceleration algorithm (length \code{m}),

\item {}
\code{Xvecs} -- \code{N\_Vector} pointer array used in acceleration algorithm (length \code{m+1}),
\code{Xvecs} -- \code{N\_Vector} pointer array used in acceleration algorithm (length \code{m+1}),

\item {}
\code{fold} -- \code{N\_Vector} used in acceleration algorithm, and
\code{fold} -- \code{N\_Vector} used in acceleration algorithm, and

\item {}
\code{gold} -- \code{N\_Vector} used in acceleration algorithm.
\code{gold} -- \code{N\_Vector} used in acceleration algorithm.

\end{itemize}

Expand Down
4 changes: 4 additions & 0 deletions doc/arkode/SphinxDocs/guide/source/Introduction.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ pointer to the inner integrator memory as :c:func:`MRIStepSetUserData()` will
not set the pointer for both the inner and outer integrators. The MRIStep
examples have been updated to reflect this change.

Added support for constant damping to the ``SUNNonlinearSolver_FixedPoint``
module when using Anderson acceleration. See :ref:`SUNNonlinSolFixedPoint.Math`
and the :c:func:`SUNNonlinSolSetDamping_FixedPoint()` for more details.

Changes in v4.0.0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
Loading

0 comments on commit 91b0738

Please sign in to comment.