From a0685881872289b11315c6d30bf7ddd6bdc67d7c Mon Sep 17 00:00:00 2001 From: Randolph Settgast Date: Wed, 21 Aug 2024 12:32:27 -0700 Subject: [PATCH] move constitutive driver documentation out on its own --- .../constitutive/docs/FluidModels.rst | 4 +--- .../constitutive/docs/solid/SolidModels.rst | 1 - .../docs/ConstitutiveDrivers.rst | 13 +++++++++++++ .../docs/{solid => }/TriaxialDriver.rst | 0 .../docs/{solid => }/TriaxialDriver.svg | 0 src/coreComponents/functions/FunctionBase.hpp | 2 +- src/docs/sphinx/userGuide/Index.rst | 2 ++ 7 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 src/coreComponents/constitutiveDrivers/docs/ConstitutiveDrivers.rst rename src/coreComponents/constitutiveDrivers/docs/{solid => }/TriaxialDriver.rst (100%) rename src/coreComponents/constitutiveDrivers/docs/{solid => }/TriaxialDriver.svg (100%) diff --git a/src/coreComponents/constitutive/docs/FluidModels.rst b/src/coreComponents/constitutive/docs/FluidModels.rst index 3b7beb6c902..445f8a82f0b 100644 --- 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 \ No newline at end of file diff --git a/src/coreComponents/constitutive/docs/solid/SolidModels.rst b/src/coreComponents/constitutive/docs/solid/SolidModels.rst index a62f1ce024e..de494d86bf0 100644 --- 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 new file mode 100644 index 00000000000..dd1b29d36d3 --- /dev/null +++ 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/src/coreComponents/constitutiveDrivers/docs/solid/TriaxialDriver.rst b/src/coreComponents/constitutiveDrivers/docs/TriaxialDriver.rst similarity index 100% rename from src/coreComponents/constitutiveDrivers/docs/solid/TriaxialDriver.rst rename to src/coreComponents/constitutiveDrivers/docs/TriaxialDriver.rst diff --git a/src/coreComponents/constitutiveDrivers/docs/solid/TriaxialDriver.svg b/src/coreComponents/constitutiveDrivers/docs/TriaxialDriver.svg similarity index 100% rename from src/coreComponents/constitutiveDrivers/docs/solid/TriaxialDriver.svg rename to src/coreComponents/constitutiveDrivers/docs/TriaxialDriver.svg diff --git a/src/coreComponents/functions/FunctionBase.hpp b/src/coreComponents/functions/FunctionBase.hpp index b0e8bdb59d1..3b160059743 100644 --- 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 index 12ee30367f1..66a3c60cf52 100644 --- 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