feat: add PermeabilitySpecification as an high-level FieldSpecification

src/coreComponents/fieldSpecification/AquiferBoundaryCondition.cpp

@@ -304,7 +304,7 @@ AquiferBoundaryCondition::KernelWrapper AquiferBoundaryCondition::createKernelWr
                                                   pressureInfluenceFunction.createKernelWrapper() );
 }
 
-REGISTER_CATALOG_ENTRY( FieldSpecification, AquiferBoundaryCondition, string const &, Group * const )
+REGISTER_CATALOG_ENTRY( FieldSpecificationABC, AquiferBoundaryCondition, string const &, Group * const )
 
 
 } /* namespace geos */

src/coreComponents/fieldSpecification/CMakeLists.txt

@@ -26,12 +26,15 @@ set( fieldSpecification_headers
      DirichletBoundaryCondition.hpp
      EquilibriumInitialCondition.hpp
      FieldSpecification.hpp
+     FieldSpecificationABC.hpp
+     FieldSpecificationFactory.hpp
      FieldSpecificationManager.hpp
      FieldSpecificationImpl.hpp
      SourceFluxBoundaryCondition.hpp
      TractionBoundaryCondition.hpp
      AquiferBoundaryCondition.hpp
      PerfectlyMatchedLayer.hpp
+     PermeabilitySpecification.hpp
    )
 
 #
@@ -41,11 +44,14 @@ set( fieldSpecification_sources
      DirichletBoundaryCondition.cpp
      EquilibriumInitialCondition.cpp
      FieldSpecification.cpp
+     FieldSpecificationABC.cpp
+     FieldSpecificationFactory.cpp
      FieldSpecificationManager.cpp
      SourceFluxBoundaryCondition.cpp
      TractionBoundaryCondition.cpp
      AquiferBoundaryCondition.cpp
      PerfectlyMatchedLayer.cpp
+     PermeabilitySpecification.cpp
    )
 
 set( dependencyList ${parallelDeps} mesh )

src/coreComponents/fieldSpecification/DirichletBoundaryCondition.cpp

@@ -37,6 +37,6 @@ DirichletBoundaryCondition::~DirichletBoundaryCondition()
 
 
 
-REGISTER_CATALOG_ENTRY( FieldSpecification, DirichletBoundaryCondition, string const &, Group * const )
+REGISTER_CATALOG_ENTRY( FieldSpecificationABC, DirichletBoundaryCondition, string const &, Group * const )
 
 } /* namespace geos */

src/coreComponents/fieldSpecification/EquilibriumInitialCondition.cpp

@@ -245,7 +245,7 @@ void EquilibriumInitialCondition::initializePreSubGroups()
   }
 }
 
-REGISTER_CATALOG_ENTRY( FieldSpecification, EquilibriumInitialCondition, string const &, Group * const )
+REGISTER_CATALOG_ENTRY( FieldSpecificationABC, EquilibriumInitialCondition, string const &, Group * const )
 
 
 } /* namespace geos */

src/coreComponents/fieldSpecification/FieldSpecification.cpp

@@ -20,7 +20,7 @@ namespace geos
 using namespace dataRepository;
 
 FieldSpecification::FieldSpecification( string const & name, Group * parent ):
-  Group( name, parent )
+  FieldSpecificationABC( name, parent )
 {
   setInputFlags( InputFlags::OPTIONAL_NONUNIQUE );
 
@@ -184,6 +184,6 @@ void FieldSpecification::setMeshObjectPath( Group const & meshBodies )
 
 
 
-REGISTER_CATALOG_ENTRY( FieldSpecification, FieldSpecification, string const &, Group * const )
+REGISTER_CATALOG_ENTRY( FieldSpecificationABC, FieldSpecification, string const &, Group * const )
 
 }

src/coreComponents/fieldSpecification/FieldSpecification.hpp

@@ -24,6 +24,7 @@
 #include "common/DataTypes.hpp"
 #include "common/format/EnumStrings.hpp"
 #include "dataRepository/Group.hpp"
+#include "fieldSpecification/FieldSpecificationABC.hpp"
 #include "mesh/MeshObjectPath.hpp"
 
 namespace geos
@@ -35,7 +36,7 @@ class Function;
  * @class FieldSpecification
  * A class to hold values for and administer a single boundary condition
  */
-class FieldSpecification : public dataRepository::Group
+class FieldSpecification : public FieldSpecificationABC
 {
 public:
 
@@ -247,6 +248,13 @@ class FieldSpecification : public dataRepository::Group
   void setFieldName( string const & fieldName )
   { m_fieldName = fieldName; }
 
+  /**
+   * Mutator
+   * @param[in] component The component axis or a special value.
+   */
+  void setComponent( int component )
+  { m_component = component; }
+
   /**
    * Mutator
    * @param[in] objectPath The path for the object
@@ -302,6 +310,20 @@ class FieldSpecification : public dataRepository::Group
    */
   void setMeshObjectPath( Group const & meshBodies );
 
+  /**
+   * Mutator
+   * @param[in] beginTime Time after which the bc is allowed to be applied
+   */
+  void setStartTime( real64 beginTime )
+  { m_beginTime = beginTime; }
+
+  /**
+   * Mutator
+   * @param[in] endTime Time after which the bc will no longer be applied.
+   */
+  void setEndTime( real64 endTime )
+  { m_endTime = endTime; }
+
   /**
    * @brief Get the Mesh Object Paths object
    *

src/coreComponents/fieldSpecification/FieldSpecificationABC.cpp

@@ -0,0 +1,36 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2024 TotalEnergies
+ * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2023-2024 Chevron
+ * Copyright (c) 2019-     GEOS/GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+#include "FieldSpecificationABC.hpp"
+
+namespace geos
+{
+using namespace dataRepository;
+
+FieldSpecificationABC::FieldSpecificationABC( string const & name, Group * parent ):
+  Group( name, parent )
+{}
+
+FieldSpecificationABC::~FieldSpecificationABC()
+{}
+
+FieldSpecificationABC::CatalogInterface::CatalogType &
+FieldSpecificationABC::getCatalog()
+{
+  static FieldSpecificationABC::CatalogInterface::CatalogType catalog;
+  return catalog;
+}
+
+}

src/coreComponents/fieldSpecification/FieldSpecificationABC.hpp

@@ -0,0 +1,107 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2024 TotalEnergies
+ * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2023-2024 Chevron
+ * Copyright (c) 2019-     GEOS/GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * @file FieldSpecificationABC.hpp
+ */
+
+#ifndef GEOS_FIELDSPECIFICATION_FIELDSPECIFICATIONABC_HPP
+#define GEOS_FIELDSPECIFICATION_FIELDSPECIFICATIONABC_HPP
+
+
+#include "common/DataTypes.hpp"
+#include "dataRepository/Group.hpp"
+#include "functions/FunctionBase.hpp"
+#include "functions/FunctionManager.hpp"
+
+namespace geos
+{
+class Function;
+
+
+/**
+ * @class FieldSpecificationABC
+ *
+ * Abstract Base Class grouping multiple types of field specifications.
+ */
+class FieldSpecificationABC : public dataRepository::Group
+{
+public:
+
+  /**
+   * @defgroup alias and functions to define statically initialized catalog
+   * @{
+   */
+
+  /**
+   * alias to define the catalog type for this abstract type
+   */
+  using CatalogInterface = dataRepository::CatalogInterface< FieldSpecificationABC,
+                                                             string const &,
+                                                             dataRepository::Group * const >;
+
+  /**
+   * @brief static function to return static catalog.
+   * @return the static catalog to create derived types through the static factory methods.
+   */
+  static CatalogInterface::CatalogType & getCatalog();
+
+  /**
+   * @brief return the catalog name
+   * @return the catalog name
+   */
+  virtual const string getCatalogName() const = 0;
+
+  /**
+   * @}
+   */
+
+
+  /**
+   * @brief constructor
+   * @param name the name of the FieldSpecificationABC in the data repository
+   * @param parent the parent group of this group.
+   */
+  FieldSpecificationABC( string const & name, dataRepository::Group * parent );
+
+  /**
+   * destructor
+   */
+  virtual ~FieldSpecificationABC() override;
+
+
+  /// Deleted copy constructor
+  FieldSpecificationABC( FieldSpecificationABC const & ) = delete;
+
+  /// Defaulted move constructor
+  FieldSpecificationABC( FieldSpecificationABC && ) = default;
+
+  /// deleted copy assignment
+  FieldSpecificationABC & operator=( FieldSpecificationABC const & ) = delete;
+
+  /// deleted move assignement
+  FieldSpecificationABC & operator=( FieldSpecificationABC && ) = delete;
+
+  /**
+   * @brief View keys
+   */
+  struct viewKeyStruct
+  {};
+
+};
+
+}
+
+#endif //GEOS_FIELDSPECIFICATION_FIELDSPECIFICATIONABC_HPP

src/coreComponents/fieldSpecification/FieldSpecificationFactory.cpp

@@ -0,0 +1,47 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2024 TotalEnergies
+ * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2023-2024 Chevron
+ * Copyright (c) 2019-     GEOS/GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * @file FieldSpecificationFactory.cpp
+ */
+
+#include "FieldSpecificationFactory.hpp"
+#include "PermeabilitySpecification.hpp"
+
+namespace geos
+{
+
+namespace
+{
+
+template< typename ... SPEC_TYPES, typename LAMBDA >
+void forExpandableSpecifications( dataRepository::Group & manager,
+                                  types::TypeList< SPEC_TYPES... >,
+                                  LAMBDA && lambda )
+{
+  manager.template forSubGroups< SPEC_TYPES... >( std::forward< LAMBDA >( lambda ) );
+}
+
+}
+
+void expandFieldSpecifications( dataRepository::Group & manager )
+{
+  forExpandableSpecifications( manager, ExpandableSpecTypes{}, [&]( auto const & spec )
+  {
+    generateFieldSpecifications( spec, manager );
+  } );
+}
+
+} // namespace geos

src/coreComponents/fieldSpecification/FieldSpecificationFactory.hpp

@@ -0,0 +1,57 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2024 TotalEnergies
+ * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2023-2024 Chevron
+ * Copyright (c) 2019-     GEOS/GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * @file FieldSpecificationFactory.hpp
+ */
+
+#ifndef GEOS_FIELDSPECIFICATION_FIELDSPECIFICATIONFACTORY_HPP
+#define GEOS_FIELDSPECIFICATION_FIELDSPECIFICATIONFACTORY_HPP
+
+
+#include "common/TypeDispatch.hpp"
+#include "dataRepository/Group.hpp"
+
+namespace geos
+{
+
+class PermeabilitySpecification;
+
+/**
+ * @brief List of high-level field specifications to expand into FieldSpecification objects.
+ */
+using ExpandableSpecTypes = types::TypeList< PermeabilitySpecification >;
+
+/**
+ * @brief Generate FieldSpecifications based on the given "higher-level" specification
+ * @tparam SPEC_TYPE The type of the high-level specification
+ * @param specification The high-level specification used as a blueprint
+ *                      to create FieldSpecification
+ * @param manager The parent to store the created FieldSpecifications
+ */
+template< typename SPEC_TYPE >
+void generateFieldSpecifications( SPEC_TYPE const & specification, dataRepository::Group & manager ) = delete;
+
+/**
+ * @brief Expand high-level field specifications
+ * @param manager The manager group
+ * Expand all field specificiation listed in ExpandableSpecTypes
+ */
+void expandFieldSpecifications( dataRepository::Group & manager );
+
+} // namespace geos
+
+
+#endif //GEOS_FIELDSPECIFICATION_FIELDSPECIFICATIONFACTORY_HPP

src/coreComponents/fieldSpecification/FieldSpecificationImpl.hpp

@@ -30,6 +30,7 @@
 #include "mesh/MeshObjectPath.hpp"
 #include "functions/FunctionManager.hpp"
 #include "common/GEOS_RAJA_Interface.hpp"
+#include "FieldSpecificationABC.hpp"
 
 namespace geos
 {