feat: Transmissibility output

inputFiles/compositionalMultiphaseFlow/deadoil_3ph_staircase_3d_transmi_output.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0" ?>
+
+<Problem>
+  <!-- this exemple adds a transmissibility output to "deadoilStaircase.xml".
+
+    The "cellToCellDataCollection" gather the transmissibility data at the first timestep (triggered by
+    the SoloEvents). The transmissibility could be gathered at multiple timestep to see the influence
+    of the permeability variations.
+    All fields need to be individualy packed by the PackCollection, the TimeHistory outputs them in an hdf5.
+  -->
+
+  <Included>
+    <File name="./deadoil_3ph_staircase_3d.xml"/>
+  </Included>
+
+  <Events>
+
+    <SoloEvent
+      name="cellToCellDataCollectionEvent"
+      beginTime="1e5"
+      target="/Tasks/cellToCellDataCollection" />
+    <SoloEvent
+      name="cellAGlobalIdPackCollectionEvent"
+      beginTime="1e5"
+      target="/Tasks/cellAGlobalIdPackCollection" />
+    <SoloEvent
+      name="cellBGlobalIdPackCollectionEvent"
+      beginTime="1e5"
+      target="/Tasks/cellBGlobalIdPackCollection" />
+    <SoloEvent
+      name="transmissibilityABPackCollectionEvent"
+      beginTime="1e5"
+      target="/Tasks/transmissibilityABPackCollection" />
+    <SoloEvent
+      name="transmissibilityBAPackCollectionEvent"
+      beginTime="1e5"
+      target="/Tasks/transmissibilityBAPackCollection" />
+    <SoloEvent
+      name="cellToCellDataHistoryEvent"
+      beginTime="1e5"
+      target="/Outputs/cellToCellDataHistory" />
+
+  </Events>
+
+  <Tasks>
+    <CellToCellDataCollection
+      name="cellToCellDataCollection"
+      flowSolverName="compflow"
+      meshBody="mesh"
+      logLevel="1" />
+    <PackCollection
+      name="cellAGlobalIdPackCollection"
+      objectPath="/Tasks/cellToCellDataCollection"
+      fieldName="cellAGlobalId" />
+    <PackCollection
+      name="cellBGlobalIdPackCollection"
+      objectPath="/Tasks/cellToCellDataCollection"
+      fieldName="cellBGlobalId" />
+    <PackCollection
+      name="transmissibilityABPackCollection"
+      objectPath="/Tasks/cellToCellDataCollection"
+      fieldName="transmissibilityAB" />
+    <PackCollection
+      name="transmissibilityBAPackCollection"
+      objectPath="/Tasks/cellToCellDataCollection"
+      fieldName="transmissibilityBA" />
+  </Tasks>
+
+  <Outputs>
+    <TimeHistory
+      name="cellToCellDataHistory"
+      sources="{ 
+        /Tasks/cellAGlobalIdPackCollection,
+        /Tasks/cellBGlobalIdPackCollection,
+        /Tasks/transmissibilityABPackCollection,
+        /Tasks/transmissibilityBAPackCollection
+      }"
+      filename="deadoil_3ph_staircase_3d_cellToCellData" />
+  </Outputs>
+
+</Problem>

src/coreComponents/common/Logger.hpp

@@ -517,6 +517,23 @@
   SimulationError( std::exception const & subException, std::string const & msgToInsert );
 };
 
+/**
+ * @brief Exception class used to report errors from type conversion
+ * @todo (ErrorManager EPIC #2940) Consider adding a way to precise custom exception parameters, to add
+ * expected & encountered typeid for this one (in order to manage the exception output more precisely).
+ * We could also manage this by having:    BadTypeErrorABC <|--- BadTypeError< T >      /!\ compilation time
+ */
+struct BadTypeError : public std::runtime_error
+{
+  /**
+   * @brief Constructor
+   * @param what the error message
+   */
+  BadTypeError( std::string const & what ):
+    std::runtime_error( what )
+  {}
+};
+
 /**
  * @brief Exception class used for special control flow.
  */

src/coreComponents/common/Units.hpp

@@ -95,6 +95,9 @@
 
   /// Mole rate in mol/s
   MoleRate,
+
+  /// Transmissibility in m2/s
+  Transmissibility,
 };
 
 
@@ -106,21 +109,22 @@
 {
   switch( unit )
   {
-    default:              return "unknown [?]";
-    case Dimensionless:   return "dimensionless [1]";
-    case Pressure:        return "pressure [Pa]";
-    case Temperature:     return "temperature [K]";
-    case TemperatureInC:  return "temperature [C]";
-    case Distance:        return "distance [m]";
-    case Time:            return "time [s]";
-    case Viscosity:       return "viscosity [Pa*s]";
-    case Enthalpy:        return "enthalpy [J/kg]";
-    case Density:         return "density [kg/m3]";
-    case Solubility:      return "solubility [g/L]";
-    case Mass:            return "mass [kg]";
-    case Mole:            return "mole [mol]";
-    case MassRate:        return "mass rate [kg/s]";
-    case MoleRate:        return "mole rate [mol/s]";
+    default:                return "unknown [?]";
+    case Dimensionless:     return "dimensionless [1]";
+    case Pressure:          return "pressure [Pa]";
+    case Temperature:       return "temperature [K]";
+    case TemperatureInC:    return "temperature [C]";
+    case Distance:          return "distance [m]";
+    case Time:              return "time [s]";
+    case Viscosity:         return "viscosity [Pa*s]";
+    case Enthalpy:          return "enthalpy [J/kg]";
+    case Density:           return "density [kg/m3]";
+    case Solubility:        return "solubility [g/L]";
+    case Mass:              return "mass [kg]";
+    case Mole:              return "mole [mol]";
+    case MassRate:          return "mass rate [kg/s]";
+    case MoleRate:          return "mole rate [mol/s]";
+    case Transmissibility:  return "transmissibility [(Pa*s*rm3/s)/Pa]";
   }
 }
 
@@ -132,21 +136,22 @@
 {
   switch( unit )
   {
-    default:              return "?";
-    case Dimensionless:   return "1";
-    case Pressure:        return "Pa";
-    case Temperature:     return "K";
-    case TemperatureInC:  return "C";
-    case Distance:        return "m";
-    case Time:            return "s";
-    case Viscosity:       return "Pa*s";
-    case Enthalpy:        return "J/kg";
-    case Density:         return "kg/m3";
-    case Solubility:      return "g/L";
-    case Mass:            return "kg";
-    case Mole:            return "mol";
-    case MassRate:        return "kg/s";
-    case MoleRate:        return "mol/s";
+    default:                return "?";
+    case Dimensionless:     return "1";
+    case Pressure:          return "Pa";
+    case Temperature:       return "K";
+    case TemperatureInC:    return "C";
+    case Distance:          return "m";
+    case Time:              return "s";
+    case Viscosity:         return "Pa*s";
+    case Enthalpy:          return "J/kg";
+    case Density:           return "kg/m3";
+    case Solubility:        return "g/L";
+    case Mass:              return "kg";
+    case Mole:              return "mol";
+    case MassRate:          return "kg/s";
+    case MoleRate:          return "mol/s";
+    case Transmissibility:  return "(Pa*s*rm3/s)/Pa";
   }
 }
 
@@ -161,21 +166,22 @@
 {
   switch( unit )
   {
-    default:              return GEOS_FMT( "value of {} [?]", value );
-    case Dimensionless:   return GEOS_FMT( "value of {} [1]", value );
-    case Pressure:        return GEOS_FMT( "pressure of {} [Pa]", value );
-    case Temperature:     return GEOS_FMT( "temperature of {} [K]", value );
-    case TemperatureInC:  return GEOS_FMT( "temperature of {} [K]", convertCToK( value ) );
-    case Distance:        return GEOS_FMT( "distance of {} [s]", value );
-    case Time:            return GEOS_FMT( "time of {} [s]", value );
-    case Viscosity:       return GEOS_FMT( "viscosity of {} [Pa*s]", value );
-    case Enthalpy:        return GEOS_FMT( "enthalpy of {} [J/kg]", value );
-    case Density:         return GEOS_FMT( "density of {} [kg/m3]", value );
-    case Solubility:      return GEOS_FMT( "solubility of {} [g/L]", value );
-    case Mass:            return GEOS_FMT( "mass of {} [kg]", value );
-    case Mole:            return GEOS_FMT( "mole of {} [mol]", value );
-    case MassRate:        return GEOS_FMT( "mass rate of {} [kg/s]", value );
-    case MoleRate:        return GEOS_FMT( "mole rate of {} [mol/s]", value );
+    default:                return GEOS_FMT( "value of {} [?]", value );
+    case Dimensionless:     return GEOS_FMT( "value of {} [1]", value );
+    case Pressure:          return GEOS_FMT( "pressure of {} [Pa]", value );
+    case Temperature:       return GEOS_FMT( "temperature of {} [K]", value );
+    case TemperatureInC:    return GEOS_FMT( "temperature of {} [K]", convertCToK( value ) );
+    case Distance:          return GEOS_FMT( "distance of {} [s]", value );
+    case Time:              return GEOS_FMT( "time of {} [s]", value );
+    case Viscosity:         return GEOS_FMT( "viscosity of {} [Pa*s]", value );
+    case Enthalpy:          return GEOS_FMT( "enthalpy of {} [J/kg]", value );
+    case Density:           return GEOS_FMT( "density of {} [kg/m3]", value );
+    case Solubility:        return GEOS_FMT( "solubility of {} [g/L]", value );
+    case Mass:              return GEOS_FMT( "mass of {} [kg]", value );
+    case Mole:              return GEOS_FMT( "mole of {} [mol]", value );
+    case MassRate:          return GEOS_FMT( "mass rate of {} [kg/s]", value );
+    case MoleRate:          return GEOS_FMT( "mole rate of {} [mol/s]", value );
+    case Transmissibility:  return GEOS_FMT( "transmissibility of {} [(Pa*s*rm3/s)/Pa]", value );
   }
 }
 

src/coreComponents/dataRepository/Group.hpp

@@ -338,8 +338,12 @@ class Group
                    "Group " << getDataContext() << " has no child named " << key << std::endl
                             << dumpSubGroupsNames(),
                    std::domain_error );
-
-    return dynamicCast< T & >( *child );
+    T * const castedChild = dynamicCast< T * >( child );
+    GEOS_THROW_IF( castedChild == nullptr,
+                   GEOS_FMT( "{} was expected to be a '{}'.",
+                             child->getDataContext(), LvArray::system::demangleType< T >() ),
+                   BadTypeError );
+    return *castedChild;
   }
 
   /**
@@ -353,8 +357,12 @@ class Group
                    "Group " << getDataContext() << " has no child named " << key << std::endl
                             << dumpSubGroupsNames(),
                    std::domain_error );
-
-    return dynamicCast< T const & >( *child );
+    T const * const castedChild = dynamicCast< T const * >( child );
+    GEOS_THROW_IF( castedChild == nullptr,
+                   GEOS_FMT( "{} was expected to be a '{}'.",
+                             child->getDataContext(), LvArray::system::demangleType< T >() ),
+                   BadTypeError );
+    return *castedChild;
   }
 
   /**

src/coreComponents/fileIO/timeHistory/PackCollection.cpp

@@ -72,6 +72,7 @@ void PackCollection::initializePostSubGroups( )
     {
       // coord meta collectors should have m_disableCoordCollection == true to avoid
       //  infinite recursive init calls here
+      //          (side note: should we create a m_isMetaCollector field to prevent any confusion?)
       metaCollector->initializePostSubGroups();
     }
     m_initialized = true;
@@ -255,7 +256,7 @@ localIndex PackCollection::numMetaDataCollectors() const
 
 void PackCollection::buildMetaDataCollectors()
 {
-  if( !m_disableCoordCollection )
+  if( !m_disableCoordCollection && m_targetIsMeshObject )
   {
     char const * coordField = nullptr;
     if( m_objectPath.find( "nodeManager" ) != string::npos )