refactor: Add instance generators for constitutive drivers (#3687)

* Add kernelSpec.json
* Add relative permeability template
* Add hysteresis check
* Correct embedded documentation typos in kernelSpecs.json (#4086)
* Fix typos in kernelSpecs embedded docs

Author: dkachuma

src/cmake/GeosxMacros.cmake

@@ -221,18 +221,22 @@ endmacro()
 ##                  KEY <key to use when looking up the kernel specification in the JSON object>
 ##                  RESULT <name of the variable to store the list of generated files in>
 ##                  SPLIT <delimiter used to split the instantiation strings into lists>
-##                  JSON <name of the JSON object variable> )
+##                  JSON <name of the JSON object variable>
+##                  LIST_TEMPLATE <path to the dispatch type list template> )
 ##
 ## This function generates kernel files from a template.
 ## The kernel specification is looked up in a JSON object using the provided key.
 ## The list of generated files is stored in the provided variable in the parent scope.
 ## The delimiter is used to split the instantiation strings into lists of symbol values.
 ## The JSON object is expected to be defined in the calling scope.
+## The dispatch type list template will be used to generate a list of types for dispatch of the
+## kernel. If this is not specified KernelDispatchTypeList.hpp.template in the parent directory
+## will be used.
 ##
 ##------------------------------------------------------------------------------
 function(generateKernels)
   set(options)
-  set(oneValueArgs TEMPLATE KEY HEADERS SOURCES SPLIT JSON)
+  set(oneValueArgs TEMPLATE KEY HEADERS SOURCES SPLIT JSON LIST_TEMPLATE)
   set(multiValueArgs)
 
   cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
@@ -309,7 +313,11 @@ function(generateKernels)
   set(generatedFileName "${CMAKE_BINARY_DIR}/include/${relativeSourceDir}/${localRelDir}/${KERNEL_GROUP_NAME}DispatchTypeList.hpp")
   string(REPLACE "coreComponents/" "" generatedFileName "${generatedFileName}")
   message(STATUS "Generating file: ${generatedFileName}")
-  configure_file(../KernelDispatchTypeList.hpp.template "${generatedFileName}" @ONLY)
+  set(LIST_TEMPLATE "${ARG_LIST_TEMPLATE}")
+  if ("${LIST_TEMPLATE}" STREQUAL "")
+    set(LIST_TEMPLATE "../KernelDispatchTypeList.hpp.template")
+  endif()
+  configure_file(${LIST_TEMPLATE} "${generatedFileName}" @ONLY)
   list(APPEND generatedHeadersList ${generatedFileName})
 
   # The list of generated files is returned by setting the variable in the parent scope

src/coreComponents/constitutiveDrivers/CMakeLists.txt

@@ -36,26 +36,7 @@ set( constitutiveDrivers_headers
 set( constitutiveDrivers_sources
      ConstitutiveDriver.cpp
      fluid/multiFluid/PVTDriver.cpp
-     fluid/multiFluid/constant/PVTDriverRunTestInvariantImmiscibleFluid.cpp
-     fluid/multiFluid/blackOil/PVTDriverRunTestDeadOilFluid.cpp
-     fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrinePhillipsFluid.cpp
-     fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrinePhillipsThermalFluid.cpp
-     fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrineEzrokhiFluid.cpp
-     fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrineEzrokhiThermalFluid.cpp
-     fluid/multiFluid/compositional/PVTDriverRunTestCompositionalKValueLohrenzBrayClarkViscosity.cpp
-     fluid/multiFluid/compositional/PVTDriverRunTestCompositionalKValuePhillipsBrine.cpp
-     fluid/multiFluid/compositional/PVTDriverRunTestCompositionalThreePhaseLohrenzBrayClarkViscosity.cpp
-     fluid/multiFluid/compositional/PVTDriverRunTestCompositionalTwoPhaseConstantViscosity.cpp
-     fluid/multiFluid/compositional/PVTDriverRunTestCompositionalTwoPhasePhillipsBrine.cpp
-     fluid/multiFluid/compositional/PVTDriverRunTestCompositionalTwoPhaseLohrenzBrayClarkViscosity.cpp
      relativePermeability/RelpermDriver.cpp
-     relativePermeability/RelpermDriverBrooksCoreyBakerRunTest.cpp
-     relativePermeability/RelpermDriverBrooksCoreyStone2RunTest.cpp
-     relativePermeability/RelpermDriverBrooksCoreyRunTest.cpp
-     relativePermeability/RelpermDriverVanGenuchtenBakerRunTest.cpp
-     relativePermeability/RelpermDriverVanGenuchtenStone2RunTest.cpp
-     relativePermeability/RelpermDriverTableRelativeRunTest.cpp
-     relativePermeability/RelpermDriverTableRelativeHysteresisRunTest.cpp
      solid/TriaxialDriver.cpp
    )
 
@@ -64,6 +45,24 @@ set( dependencyList ${parallelDeps} constitutive events )
 geos_decorate_link_dependencies( LIST decoratedDependencies
                                  DEPENDENCIES ${dependencyList} )
 
+file( READ "${CMAKE_CURRENT_LIST_DIR}/kernelSpecs.json" kernelSpecs )
+set( kernelTemplateFileList
+     fluid/multiFluid/PVTDriverRunTestFluid.cpp.template
+     relativePermeability/RelpermDriverRunTestRelPerm.cpp.template)
+
+foreach( kernelTemplateFile ${kernelTemplateFileList} )
+  get_filename_component( jsonKey ${kernelTemplateFile} NAME_WE )
+  generateKernels( TEMPLATE ${kernelTemplateFile}
+                   JSON kernelSpecs
+                   KEY ${jsonKey}
+                   HEADERS headerFiles
+                   SOURCES sourceFiles
+                   LIST_TEMPLATE ${CMAKE_CURRENT_LIST_DIR}/DriverDispatchTypeList.hpp.template )
+                   
+  list(APPEND constitutiveDrivers_headers ${headerFiles})
+  list(APPEND constitutiveDrivers_sources ${sourceFiles})
+endforeach()
+
 blt_add_library( NAME       constitutiveDrivers
                  SOURCES    ${constitutiveDrivers_sources}
                  HEADERS    ${constitutiveDrivers_headers}

src/coreComponents/constitutiveDrivers/DriverDispatchTypeList.hpp.template

@@ -0,0 +1,35 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2018-2019 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2019 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2018-2019 Total, S.A
+ * Copyright (c) 2019-     GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * @file @KERNEL_GROUP_NAME@DispatchTypeList.hpp
+ */
+
+#ifndef GEOS_@KERNEL_GROUP_NAME@_DISPATCHTYPELIST_HPP
+#define GEOS_@KERNEL_GROUP_NAME@_DISPATCHTYPELIST_HPP
+
+#include "common/TypeDispatch.hpp"
+
+namespace geos
+{
+
+using namespace constitutive;
+
+using @KERNEL_GROUP_NAME@DispatchTypeList = types::TypeList<
+  @typeCombinationList@
+>;
+
+} // namespace geos
+
+#endif //GEOS_@KERNEL_GROUP_NAME@_DISPATCHTYPELIST_HPP

src/coreComponents/constitutiveDrivers/fluid/multiFluid/CO2Brine/PVTDriverRunTestCO2BrineEzrokhiThermalFluid.cpp

@@ -13,10 +13,15 @@
  * ------------------------------------------------------------------------------------------------------------
  */
 
+/*
+ * PVTDriverRunTestFluid_@FLUID@.cpp
+ */
+
 #include "constitutiveDrivers/fluid/multiFluid/PVTDriverRunTest.hpp"
-#include "constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.hpp"
+#include "constitutive/fluid/multifluid/MultiFluidSelector.hpp"
 
 namespace geos
 {
-template void PVTDriver::runTest< constitutive::CO2BrineEzrokhiFluid >( constitutive::CO2BrineEzrokhiFluid &, arrayView2d< real64 > const & );
+  using namespace constitutive;
+  template void PVTDriver::runTest< @FLUID@ >( @FLUID@ &, arrayView2d< real64 > const & );
 }