Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/arkode vector requirements #387

Merged
merged 4 commits into from
Dec 15, 2023
Merged

Bugfix/arkode vector requirements #387

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a60ef58
Updated N_Vector requirements from ARKODE
drreynolds Dec 6, 2023
9d7f9b3
Updated table of N_Vector requirements in ARKODE
drreynolds Dec 6, 2023
211a94b
Merge branch 'develop' into bugfix/arkode-vector-requirements
balos1 Dec 15, 2023
4bf86d0
Merge branch 'develop' into bugfix/arkode-vector-requirements
balos1 Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 56 additions & 33 deletions doc/arkode/guide/source/nvectors/ARKODE_requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ NVECTOR functions required by ARKODE
In :numref:`NVectors.ARKODE.Table` below, we list the vector functions in
the ``N_Vector`` module that are called within the ARKODE package. The
table also shows, for each function, which ARKODE module uses the function.
The ARKSTEP and ERKSTEP columns show function usage within the main
time-stepping modules and the shared ARKODE infrastructure, while the
remaining columns show function usage within the ARKLS linear solver
interface, the ARKBANDPRE and ARKBBDPRE preconditioner modules.
The ARKStep, ERKStep, MRIStep, and SPRKStep columns show function usage
within the main time-stepping modules and the shared ARKODE infrastructure,
while the remaining columns show function usage within the ARKLS linear solver
interface, within constraint-handling (i.e., when :c:func:`ARKStepSetConstraints`
and :c:func:`ERKStepSetConstraints` are used), relaxation (i.e., when
:c:func:`ARKStepSetRelaxFn`, :c:func:`ERKStepSetRelaxFn` and related are used),
the ARKBANDPRE and ARKBBDPRE preconditioner modules.

Note that for ARKLS we only list the ``N_Vector`` routines used
directly by ARKLS, each ``SUNLinearSolver`` module may have additional
Expand All @@ -48,31 +51,55 @@ modules).
.. _NVectors.ARKODE.Table:
.. table:: List of vector functions usage by ARKODE code modules

======================================== ======= ======= ======= ===== ========== =========
Routine ARKSTEP ERKSTEP MRISTEP ARKLS ARKBANDPRE ARKBBDPRE
======================================== ======= ======= ======= ===== ========== =========
:c:func:`N_VGetLength` 4
:c:func:`N_VAbs` X X
:c:func:`N_VAddConst` X X
:c:func:`N_VClone` X X X X
:c:func:`N_VCloneEmpty`
:c:func:`N_VConst` X X X X
:c:func:`N_VDestroy` X X X X
:c:func:`N_VDiv` X X
:c:func:`N_VGetArrayPointer` 1 X X
:c:func:`N_VInv` X X
:c:func:`N_VLinearSum` X X X X
:c:func:`N_VMaxNorm` X X
:c:func:`N_VMin` X X
:c:func:`N_VScale` X X X X X X
:c:func:`N_VSetArrayPointer` 1
:c:func:`N_VSpace`\ :sup:`2` X X X X X X
:c:func:`N_VWrmsNorm` X X X X X X
:c:func:`N_VLinearCombination`\ :sup:`3` X X X
:c:func:`N_VMinQuotient`\ :sup:`5` X X
:c:func:`N_VConstrMask`\ :sup:`5` X X
:c:func:`N_VCompare`\ :sup:`5` X X
======================================== ======= ======= ======= ===== ========== =========
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| | | | | | | | | BBDPRE, |
| Routine | ARKStep | ERKStep | MRIStep | SPRKStep | ARKLS | Constraints | Relaxation | BANDPRE |
+==========================================+=========+=========+=========+==========+=======+=============+============+=========+
| :c:func:`N_VAbs` | X | X | X | X | | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VAddConst` | X | X | X | X | | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VClone` | X | X | X | X | X | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VCloneEmpty` | | | | | 1 | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VConst` | X | X | X | X | X | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VConstrMask` | | | | | | X | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VDestroy` | X | X | X | X | X | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VDiv` | X | X | | | | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VDotProd` | | | | | | | X | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VGetArrayPointer` | | | | | 1 | | | X |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VGetLength` | | | | | 4 | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VInv` | X | X | X | X | | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VLinearCombination`\ :sup:`3` | X | X | X | X | | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VLinearSum` | X | X | X | X | X | | X | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VMaxNorm` | X | X | | | | X | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VMin` | X | X | X | X | | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VMinQuotient` | | | | | | X | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VProd` | | | | | | X | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VScale` | X | X | X | X | X | X | X | X |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VSetArrayPointer` | | | | | 1 | | | |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VSpace`\ :sup:`2` | X | X | X | X | X | | | X |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+
| :c:func:`N_VWrmsNorm` | X | X | X | X | X | | | X |
+------------------------------------------+---------+---------+---------+----------+-------+-------------+------------+---------+


Special cases (numbers match markings in table):

Expand All @@ -88,7 +115,3 @@ Special cases (numbers match markings in table):

4. The :c:func:`N_VGetLength()` function is only required when an iterative or
matrix iterative ``SUNLinearSolver`` module is used.

5. The functions :c:func:`N_VMinQuotient`, :c:func:`N_VConstrMask`, and
:c:func:`N_VCompare` are only used when inequality constraints are enabled
and may be omitted if this feature is not used.