feat: add PermeabilitySpecification as an high-level FieldSpecification

inputFiles/immiscibleMultiphaseFlow/immiscibleTwoPhase_SPE10_layer84/immiscibleTwoPhase_SPE10_layer84_base_iterative.xml

@@ -91,33 +91,13 @@
   </Constitutive>
 
   <FieldSpecifications>
-    <FieldSpecification
-      name="permx"
-      component="0"
-      initialCondition="1"
+    <PermeabilitySpecification
+      name="perm"
       setNames="{ all }"
-      objectPath="ElementRegions/reservoir/block"
-      fieldName="rockPerm_permeability"
-      functionName="permxFunc"
-      scale="9.869233e-16"/>
-    <FieldSpecification
-      name="permy"
-      component="1"
-      initialCondition="1"
-      setNames="{ all }"
-      objectPath="ElementRegions/reservoir/block"
-      fieldName="rockPerm_permeability"
-      functionName="permyFunc"
-      scale="9.869233e-16"/>
-    <FieldSpecification
-      name="permz"
-      component="2"
-      initialCondition="1"
-      setNames="{ all }"
-      objectPath="ElementRegions/reservoir/block"
-      fieldName="rockPerm_permeability"
-      functionName="permzFunc"
-      scale="9.869233e-16"/>
+      regionNames="reservoir/block"
+      permeabilityModelName="rockPerm"
+      functionName="{ permxFunc, permyFunc, permzFunc }"
+      scale="{ 9.869233e-16, 9.869233e-16, 9.869233e-16 }"/>
 
     <FieldSpecification
       name="referencePorosity"

src/coreComponents/dataRepository/Group.cpp

@@ -140,6 +140,11 @@ string Group::getPath() const
   return noProblem.empty() ? "/" : noProblem;
 }
 
+void Group::setDataContextReference( Group const & referencedGroup )
+{
+  m_dataContext = std::make_unique< GroupContext >( referencedGroup, getName() );
+}
+
 string Group::processInputName( xmlWrapper::xmlNode const & targetNode,
                                 xmlWrapper::xmlNodePos const & targetNodePos,
                                 string_view parentNodeName,

src/coreComponents/dataRepository/Group.hpp

@@ -1343,6 +1343,12 @@ class Group
   DataContext const & getDataContext() const
   { return *m_dataContext; }
 
+  /**
+   * @brief Allow to define a different data context for the instance, typically when we want to show another
+   *        group when an error occurs.
+   */
+  void setDataContextReference( Group const & referencedGroup );
+
   /**
    * @return DataContext object that that stores contextual information on a wrapper contained by
    * this group that can be used in output messages.

src/coreComponents/dataRepository/GroupContext.cpp

@@ -25,11 +25,11 @@ namespace dataRepository
 {
 
 
-GroupContext::GroupContext( Group & group, string_view objectName ):
+GroupContext::GroupContext( Group const & group, string_view objectName ):
   DataContext( objectName ),
   m_group( group )
 {}
-GroupContext::GroupContext( Group & group ):
+GroupContext::GroupContext( Group const & group ):
   GroupContext( group, group.getName() )
 {}
 

src/coreComponents/dataRepository/GroupContext.hpp

@@ -43,7 +43,14 @@ class GroupContext : public DataContext
    * @brief Construct a new GroupContext object
    * @param group The reference to the Group related to this GroupContext.
    */
-  GroupContext( Group & group );
+  GroupContext( Group const & group );
+
+  /**
+   * @brief Construct a new GroupContext object
+   * @param group The reference to the Group related to this GroupContext.
+   * @param objectName Target object name.
+   */
+  GroupContext( Group const & group, string_view objectName );
 
   /**
    * @return the reference to the Group related to this GroupContext.
@@ -52,15 +59,8 @@ class GroupContext : public DataContext
 
 protected:
 
-  /**
-   * @brief Construct a new GroupContext object
-   * @param group The reference to the Group related to this GroupContext.
-   * @param objectName Target object name.
-   */
-  GroupContext( Group & group, string_view objectName );
-
   /// The reference to the Group related to this GroupContext.
-  Group & m_group;
+  Group const & m_group;
 
 private:
 

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,18 +20,10 @@ namespace geos
 using namespace dataRepository;
 
 FieldSpecification::FieldSpecification( string const & name, Group * parent ):
-  Group( name, parent )
+  FieldSpecificationABC( name, parent )
 {
   setInputFlags( InputFlags::OPTIONAL_NONUNIQUE );
 
-  registerWrapper( viewKeyStruct::setNamesString(), &m_setNames ).
-    setRTTypeName( rtTypes::CustomTypes::groupNameRefArray ).
-    setInputFlag( InputFlags::REQUIRED ).
-    setSizedFromParent( 0 ).
-    setDescription( "Names of sets that the boundary condition is applied to.\n"
-                    "A set can contain heterogeneous elements in the mesh (volumes, nodes, faces, edges).\n"
-                    "A set can be be defined by a 'Geometry' component, or correspond to imported sets in case of an external mesh" );
-
   registerWrapper( viewKeyStruct::objectPathString(), &m_objectPath ).
     setRTTypeName( rtTypes::CustomTypes::groupNameRef ).
     setInputFlag( InputFlags::OPTIONAL ).
@@ -54,42 +46,6 @@ FieldSpecification::FieldSpecification( string const & name, Group * parent ):
     setInputFlag( InputFlags::OPTIONAL ).
     setDescription( "Direction to apply boundary condition to." );
 
-  registerWrapper( viewKeyStruct::functionNamesString(), &m_functionNames ).
-    setRTTypeName( rtTypes::CustomTypes::groupNameRefArray ).
-    setInputFlag( InputFlags::OPTIONAL ).
-    setDescription( "Name(s) of function(s) that specifies variation of the boundary condition." );
-
-  registerWrapper( viewKeyStruct::scalesString(), &m_scales ).
-    setApplyDefaultValue( 0.0 ).
-    setInputFlag( InputFlags::OPTIONAL ).
-    setSizedFromParent( 0 ).
-    setDescription( "Apply scaling factor(s) for the value(s) of the boundary condition." );
-
-  registerWrapper( viewKeyStruct::initialConditionString(), &m_initialCondition ).
-    setApplyDefaultValue( 0 ).
-    setInputFlag( InputFlags::OPTIONAL ).
-    setDescription( "Boundary condition is applied as an initial condition." );
-
-  registerWrapper( viewKeyStruct::beginTimeString(), &m_beginTime ).
-    setApplyDefaultValue( -1.0e99 ).
-    setInputFlag( InputFlags::OPTIONAL ).
-    setDescription( "Time at which the boundary condition will start being applied." );
-
-  registerWrapper( viewKeyStruct::endTimeString(), &m_endTime ).
-    setApplyDefaultValue( 1.0e99 ).
-    setInputFlag( InputFlags::OPTIONAL ).
-    setDescription( "Time at which the boundary condition will stop being applied." );
-
-  registerWrapper( viewKeyStruct::errorSetModeString(), &m_emptySetErrorMode ).
-    setInputFlag( InputFlags::OPTIONAL ).
-    setApplyDefaultValue( SetErrorMode::error ).
-    setDescription( GEOS_FMT( "Set the log state when a “set” does not target any region\n"
-                              "When set to \"{}\", no output.\n"
-                              "When set to \"{}\", output a warning.\n"
-                              "When set to \"{}\", output a throw.\n",
-                              EnumStrings< SetErrorMode >::toString( SetErrorMode::silent ),
-                              EnumStrings< SetErrorMode >::toString( SetErrorMode::warning ),
-                              EnumStrings< SetErrorMode >::toString( SetErrorMode::error )  ));
 }
 
 
@@ -106,25 +62,14 @@ FieldSpecification::getCatalog()
 
 void FieldSpecification::postInputInitialization()
 {
-  { // both conditions work together
-    GEOS_THROW_IF( !m_functionNames.empty() &&
-                   m_functionNames.size() != 1 &&
-                   m_functionNames.size() != static_cast< string_array::size_type >( m_scales.size() ),
-                   GEOS_FMT ( "Size mismatch: '{}' has {} entries but '{}' has {}. "
-                              "'{}' either must be empty, have a single entry, or be sized exactly like '{}'",
-                              viewKeyStruct::functionNamesString(), m_functionNames.size(),
-                              viewKeyStruct::scalesString(), m_scales.size(),
-                              viewKeyStruct::functionNamesString(), viewKeyStruct::scalesString() ),
-                   InputError,
-                   getDataContext() );
-
-    GEOS_THROW_IF( m_component != -1 && m_scales.size() > 1,
-                   GEOS_FMT ( "'{}' must not be set when '{}' has more than one value.",
-                              viewKeyStruct::componentString(),
-                              viewKeyStruct::scalesString() ),
-                   InputError,
-                   getDataContext() );
-  }
+  FieldSpecificationABC::postInputInitialization();
+
+  GEOS_THROW_IF( m_component != -1 && m_scales.size() > 1,
+                 GEOS_FMT ( "'{}' must not be set when '{}' has more than one value.",
+                            viewKeyStruct::componentString(),
+                            viewKeyStruct::scalesString() ),
+                 InputError,
+                 getDataContext() );
 }
 
 void FieldSpecification::validateNumArrayComp( localIndex numComp )
@@ -184,6 +129,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 )
 
 }