move constitutive driver documentation out on its own

GEOS-DEV · Aug 21, 2024 · a068588 · a068588
1 parent 5f77ba6
commit a068588
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 5 deletions.
diff --git a/src/coreComponents/constitutive/docs/FluidModels.rst b/src/coreComponents/constitutive/docs/FluidModels.rst
@@ -15,6 +15,4 @@ single fluids and fluid mixtures.
 
    CompositionalMultiphaseFluid
 
-   CO2BrineFluid
-
-   PVTDriver
+   CO2BrineFluid
diff --git a/src/coreComponents/constitutive/docs/solid/SolidModels.rst b/src/coreComponents/constitutive/docs/solid/SolidModels.rst
@@ -12,7 +12,6 @@ known models.
    Theory
    Voight
    Plasticity
-   TriaxialDriver
    ElasticIsotropic
    ElasticIsotropicPressureDependent
    ElasticTransverseIsotropic

diff --git a/src/coreComponents/constitutiveDrivers/docs/ConstitutiveDrivers.rst b/src/coreComponents/constitutiveDrivers/docs/ConstitutiveDrivers.rst
@@ -0,0 +1,13 @@
+.. _ConstitutiveDrivers:
+
+Constitutive Drivers
+============================================
+To test and calibrate constitutive models, GEOS provides a set of drivers that can be used to run simulations with specific input parameters. 
+These drivers are designed to facilitate the exploration of various constitutive behaviors and to validate the models against known benchmarks.
+
+.. toctree::
+   :maxdepth: 1
+
+   SolidModels
+
+   PVTDriver
diff --git a/...tiveDrivers/docs/solid/TriaxialDriver.rst → ...nstitutiveDrivers/docs/TriaxialDriver.rst b/...tiveDrivers/docs/solid/TriaxialDriver.rst → ...nstitutiveDrivers/docs/TriaxialDriver.rst
diff --git a/...tiveDrivers/docs/solid/TriaxialDriver.svg → ...nstitutiveDrivers/docs/TriaxialDriver.svg b/...tiveDrivers/docs/solid/TriaxialDriver.svg → ...nstitutiveDrivers/docs/TriaxialDriver.svg
diff --git a/src/coreComponents/functions/FunctionBase.hpp b/src/coreComponents/functions/FunctionBase.hpp
@@ -132,7 +132,7 @@ class FunctionBase : public dataRepository::Group
 
   /**
    * @brief Set the output directory for function output
-   * @param dir The output directory
+   * @param outputDir The output directory
    */
   static void setOutputDirectory( string const & outputDir );
 

diff --git a/src/docs/sphinx/userGuide/Index.rst b/src/docs/sphinx/userGuide/Index.rst
@@ -17,6 +17,8 @@ Welcome to the GEOS user guide.
 
    /coreComponents/constitutive/docs/Constitutive
 
+   /coreComponents/constitutiveDrivers/docs/ConstitutiveDrivers
+
    /coreComponents/fieldSpecification/docs/FieldSpecification
 
    /coreComponents/events/docs/EventManager