From 492e7d86cf0954c908b1ea8a88afc948319e8434 Mon Sep 17 00:00:00 2001 From: "Daniel R. Reynolds" Date: Mon, 20 May 2024 18:45:14 -0500 Subject: [PATCH] Updated folder layout for ARKODE stepper usage in docs (#490) This is a tiny PR to updated the file folder layout for ARKODE's time-stepping module "usage" documents. Now that we do not separately document the C and Fortran interfaces in different folders, there is no need for our folder names to be, e.g., `Usage/ARKStep_c_interface/`. --- .../Usage/{ARKStep_c_interface => ARKStep}/Relaxation.rst | 0 .../{ARKStep_c_interface => ARKStep}/User_callable.rst | 0 .../Usage/{ARKStep_c_interface => ARKStep}/XBraid.rst | 0 .../Usage/{ARKStep_c_interface => ARKStep}/index.rst | 0 .../Usage/{ERKStep_c_interface => ERKStep}/Relaxation.rst | 0 .../{ERKStep_c_interface => ERKStep}/User_callable.rst | 0 .../Usage/{ERKStep_c_interface => ERKStep}/index.rst | 0 .../Custom_Inner_Stepper/Description.rst | 0 .../Custom_Inner_Stepper/Implementing.rst | 0 .../Custom_Inner_Stepper/index.rst | 0 .../{MRIStep_c_interface => MRIStep}/MRIStepCoupling.rst | 0 .../Usage/{MRIStep_c_interface => MRIStep}/Skeleton.rst | 0 .../{MRIStep_c_interface => MRIStep}/User_callable.rst | 0 .../Usage/{MRIStep_c_interface => MRIStep}/index.rst | 0 .../{SPRKStep_c_interface => SPRKStep}/User_callable.rst | 0 .../Usage/{SPRKStep_c_interface => SPRKStep}/index.rst | 0 doc/arkode/guide/source/Usage/index.rst | 8 ++++---- 17 files changed, 4 insertions(+), 4 deletions(-) rename doc/arkode/guide/source/Usage/{ARKStep_c_interface => ARKStep}/Relaxation.rst (100%) rename doc/arkode/guide/source/Usage/{ARKStep_c_interface => ARKStep}/User_callable.rst (100%) rename doc/arkode/guide/source/Usage/{ARKStep_c_interface => ARKStep}/XBraid.rst (100%) rename doc/arkode/guide/source/Usage/{ARKStep_c_interface => ARKStep}/index.rst (100%) rename doc/arkode/guide/source/Usage/{ERKStep_c_interface => ERKStep}/Relaxation.rst (100%) rename doc/arkode/guide/source/Usage/{ERKStep_c_interface => ERKStep}/User_callable.rst (100%) rename doc/arkode/guide/source/Usage/{ERKStep_c_interface => ERKStep}/index.rst (100%) rename doc/arkode/guide/source/Usage/{MRIStep_c_interface => MRIStep}/Custom_Inner_Stepper/Description.rst (100%) rename doc/arkode/guide/source/Usage/{MRIStep_c_interface => MRIStep}/Custom_Inner_Stepper/Implementing.rst (100%) rename doc/arkode/guide/source/Usage/{MRIStep_c_interface => MRIStep}/Custom_Inner_Stepper/index.rst (100%) rename doc/arkode/guide/source/Usage/{MRIStep_c_interface => MRIStep}/MRIStepCoupling.rst (100%) rename doc/arkode/guide/source/Usage/{MRIStep_c_interface => MRIStep}/Skeleton.rst (100%) rename doc/arkode/guide/source/Usage/{MRIStep_c_interface => MRIStep}/User_callable.rst (100%) rename doc/arkode/guide/source/Usage/{MRIStep_c_interface => MRIStep}/index.rst (100%) rename doc/arkode/guide/source/Usage/{SPRKStep_c_interface => SPRKStep}/User_callable.rst (100%) rename doc/arkode/guide/source/Usage/{SPRKStep_c_interface => SPRKStep}/index.rst (100%) diff --git a/doc/arkode/guide/source/Usage/ARKStep_c_interface/Relaxation.rst b/doc/arkode/guide/source/Usage/ARKStep/Relaxation.rst similarity index 100% rename from doc/arkode/guide/source/Usage/ARKStep_c_interface/Relaxation.rst rename to doc/arkode/guide/source/Usage/ARKStep/Relaxation.rst diff --git a/doc/arkode/guide/source/Usage/ARKStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/ARKStep/User_callable.rst similarity index 100% rename from doc/arkode/guide/source/Usage/ARKStep_c_interface/User_callable.rst rename to doc/arkode/guide/source/Usage/ARKStep/User_callable.rst diff --git a/doc/arkode/guide/source/Usage/ARKStep_c_interface/XBraid.rst b/doc/arkode/guide/source/Usage/ARKStep/XBraid.rst similarity index 100% rename from doc/arkode/guide/source/Usage/ARKStep_c_interface/XBraid.rst rename to doc/arkode/guide/source/Usage/ARKStep/XBraid.rst diff --git a/doc/arkode/guide/source/Usage/ARKStep_c_interface/index.rst b/doc/arkode/guide/source/Usage/ARKStep/index.rst similarity index 100% rename from doc/arkode/guide/source/Usage/ARKStep_c_interface/index.rst rename to doc/arkode/guide/source/Usage/ARKStep/index.rst diff --git a/doc/arkode/guide/source/Usage/ERKStep_c_interface/Relaxation.rst b/doc/arkode/guide/source/Usage/ERKStep/Relaxation.rst similarity index 100% rename from doc/arkode/guide/source/Usage/ERKStep_c_interface/Relaxation.rst rename to doc/arkode/guide/source/Usage/ERKStep/Relaxation.rst diff --git a/doc/arkode/guide/source/Usage/ERKStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/ERKStep/User_callable.rst similarity index 100% rename from doc/arkode/guide/source/Usage/ERKStep_c_interface/User_callable.rst rename to doc/arkode/guide/source/Usage/ERKStep/User_callable.rst diff --git a/doc/arkode/guide/source/Usage/ERKStep_c_interface/index.rst b/doc/arkode/guide/source/Usage/ERKStep/index.rst similarity index 100% rename from doc/arkode/guide/source/Usage/ERKStep_c_interface/index.rst rename to doc/arkode/guide/source/Usage/ERKStep/index.rst diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/Custom_Inner_Stepper/Description.rst b/doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Description.rst similarity index 100% rename from doc/arkode/guide/source/Usage/MRIStep_c_interface/Custom_Inner_Stepper/Description.rst rename to doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Description.rst diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/Custom_Inner_Stepper/Implementing.rst b/doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Implementing.rst similarity index 100% rename from doc/arkode/guide/source/Usage/MRIStep_c_interface/Custom_Inner_Stepper/Implementing.rst rename to doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/Implementing.rst diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/Custom_Inner_Stepper/index.rst b/doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/index.rst similarity index 100% rename from doc/arkode/guide/source/Usage/MRIStep_c_interface/Custom_Inner_Stepper/index.rst rename to doc/arkode/guide/source/Usage/MRIStep/Custom_Inner_Stepper/index.rst diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/MRIStepCoupling.rst b/doc/arkode/guide/source/Usage/MRIStep/MRIStepCoupling.rst similarity index 100% rename from doc/arkode/guide/source/Usage/MRIStep_c_interface/MRIStepCoupling.rst rename to doc/arkode/guide/source/Usage/MRIStep/MRIStepCoupling.rst diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/Skeleton.rst b/doc/arkode/guide/source/Usage/MRIStep/Skeleton.rst similarity index 100% rename from doc/arkode/guide/source/Usage/MRIStep_c_interface/Skeleton.rst rename to doc/arkode/guide/source/Usage/MRIStep/Skeleton.rst diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/MRIStep/User_callable.rst similarity index 100% rename from doc/arkode/guide/source/Usage/MRIStep_c_interface/User_callable.rst rename to doc/arkode/guide/source/Usage/MRIStep/User_callable.rst diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/index.rst b/doc/arkode/guide/source/Usage/MRIStep/index.rst similarity index 100% rename from doc/arkode/guide/source/Usage/MRIStep_c_interface/index.rst rename to doc/arkode/guide/source/Usage/MRIStep/index.rst diff --git a/doc/arkode/guide/source/Usage/SPRKStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/SPRKStep/User_callable.rst similarity index 100% rename from doc/arkode/guide/source/Usage/SPRKStep_c_interface/User_callable.rst rename to doc/arkode/guide/source/Usage/SPRKStep/User_callable.rst diff --git a/doc/arkode/guide/source/Usage/SPRKStep_c_interface/index.rst b/doc/arkode/guide/source/Usage/SPRKStep/index.rst similarity index 100% rename from doc/arkode/guide/source/Usage/SPRKStep_c_interface/index.rst rename to doc/arkode/guide/source/Usage/SPRKStep/index.rst diff --git a/doc/arkode/guide/source/Usage/index.rst b/doc/arkode/guide/source/Usage/index.rst index 2ecc9a671c..93b63d84b8 100644 --- a/doc/arkode/guide/source/Usage/index.rst +++ b/doc/arkode/guide/source/Usage/index.rst @@ -75,7 +75,7 @@ ARKBBDPRE can only be used with NVECTOR_PARALLEL. User_supplied Relaxation Preconditioners - ARKStep_c_interface/index.rst - ERKStep_c_interface/index.rst - SPRKStep_c_interface/index.rst - MRIStep_c_interface/index.rst + ARKStep/index.rst + ERKStep/index.rst + SPRKStep/index.rst + MRIStep/index.rst