Merge remote-tracking branch 'origin/feature_species' into feature_species

Author: TobiKattmann

Common/include/option_structure.inl

@@ -966,58 +966,6 @@ public:
 
 };
 
-// Class where the option is represented by (String, su2double, string, su2double, ...)
-class COptionStringDoubleList : public COptionBase {
-  string name; // identifier for the option
-  unsigned short & size; // how many strings are there (same as number of su2doubles)
-
-  string * & s_f; // Reference to the string fields
-  su2double* & d_f; // reference to the su2double fields
-
-public:
-  COptionStringDoubleList(string option_field_name, unsigned short & list_size, string * & string_field, su2double* & double_field) : size(list_size), s_f(string_field), d_f(double_field) {
-    this->name = option_field_name;
-  }
-
-  ~COptionStringDoubleList() override {};
-  string SetValue(vector<string> option_value) override {
-    COptionBase::SetValue(option_value);
-    // There must be an even number of entries (same number of strings and doubles
-    unsigned short totalVals = option_value.size();
-    if ((totalVals % 2) != 0) {
-      if ((totalVals == 1) && (option_value[0].compare("NONE") == 0)) {
-        // It's okay to say its NONE
-        this->size = 0;
-        return "";
-      }
-      string newstring;
-      newstring.append(this->name);
-      newstring.append(": must have an even number of entries");
-      return newstring;
-    }
-    unsigned short nVals = totalVals / 2;
-    this->size = nVals;
-    this->s_f = new string[nVals];
-    this->d_f = new su2double[nVals];
-
-    for (unsigned long i = 0; i < nVals; i++) {
-      this->s_f[i].assign(option_value[2*i]); // 2 because have su2double and string
-      istringstream is(option_value[2*i + 1]);
-      su2double val;
-      if (!(is >> val)) {
-        return badValue(option_value, "string su2double", this->name);
-      }
-      this->d_f[i] = val;
-    }
-    // Need to return something...
-    return "";
-  }
-
-  void SetDefault() override {
-    this->size = 0; // There is no default value for list
-  }
-};
-
 class COptionInlet : public COptionBase {
   string name; // identifier for the option
   unsigned short & size;
@@ -1102,94 +1050,101 @@ public:
   }
 };
 
-class COptionInletSpecies final : public COptionBase {
-  const string name; // identifier for the option
-  unsigned short & size; // number of inlets for that options
-  string * & marker; // contains marker names
-  su2double ** & inletspeciesval; // contains all values specified for each inlet
-  unsigned short & nSpecies; // contains how many species are defined per inlet
+// Base helper for when T is not an array, does dummy allocation and de-allocation.
+template <class T>
+struct CStringValuesListHelper {
+  static T resize(unsigned short) { return T(); }
+  static T& access(T& val, unsigned short) { return val; }
+};
+
+// Specialization for pointer types (multiple values per string).
+template <class T>
+struct CStringValuesListHelper<T*> {
+  static T* resize(unsigned short n) { return new T[n]; }
+  static T& access(T* ptr, unsigned short i) { return ptr[i]; }
+};
+
+// Class where the option is represented by (string, N * "some type", string, N * "some type", ...)
+template <class Type>
+class COptionStringValuesList final : public COptionBase {
+  const string name;     // identifier for the option
+  unsigned short& size;  // number of string-value pairs
+  string*& strings;      // the strings in the option
+  Type*& values;         // the values per string
+  unsigned short& num_vals; // how many values per string
+  unsigned short optional_num_vals = 0; // num_vals points to this when it is not provided in the ctor.
 
 public:
-  COptionInletSpecies(string option_field_name, unsigned short & nMarker_Inlet_Species, string* & Marker_Inlet_Species,
-                      su2double** & option_field, unsigned short & nSpecies_per_Inlet) :
-    name(option_field_name),
-    size(nMarker_Inlet_Species),
-    marker(Marker_Inlet_Species),
-    inletspeciesval(option_field),
-    nSpecies(nSpecies_per_Inlet) {
+  COptionStringValuesList(string name_, unsigned short& size_, string*& strings_,
+                          Type*& values_, unsigned short& num_vals_) :
+    name(name_), size(size_), strings(strings_), values(values_), num_vals(num_vals_) {
   }
 
-  ~COptionInletSpecies() override {
-    delete[] marker;
-
-    if (inletspeciesval != nullptr) {
-      for (unsigned short i = 0; i < size; i++) {
-        delete[] inletspeciesval[i];
-      }
-    }
-    delete[] inletspeciesval;
-  };
+  COptionStringValuesList(string name_, unsigned short& size_, string*& strings_, Type*& values_) :
+    name(name_), size(size_), strings(strings_), values(values_), num_vals(optional_num_vals) {
+  }
 
   string SetValue(vector<string> option_value) override {
     COptionBase::SetValue(option_value);
     unsigned short option_size = option_value.size();
     if ((option_size == 1) && (option_value[0].compare("NONE") == 0)) {
       size = 0;
-      marker = nullptr;
-      inletspeciesval = nullptr;
-      nSpecies = 0;
+      num_vals = 0;
       return "";
     }
 
-    /*--- Determine the number of inlets: A new inlet is found if the first char in the string is a letter.
-     * This will fail in if a marker starts with a number!
-     * Additionally, determine the number of values that are prescribed per inlet. ---*/
-    vector<unsigned short> nSpecies_per_Inlet;
-    /*--- Loop through the fields of the marker. ---*/
-    for (unsigned long i = 0; i < option_size; i++) {
-      /*--- If the string starts with a letter, a new marker tag is found. ---*/
-      if (isalpha(option_value[i][0])) {
-        nSpecies_per_Inlet.push_back(0);
+    /*--- Determine the number of strings: A new string is found if the first char in the option is a letter.
+     * This will fail in if a string starts with a number! Additionally, determine the number of values that
+     * are prescribed per string. ---*/
+    vector<unsigned short> num_vals_per_string;
+    /*--- Loop through the fields of the option. ---*/
+    for (const auto& val : option_value) {
+      if (isalpha(val[0])) {
+        num_vals_per_string.push_back(0);
       } else {
-        /*-- Else, a species fractions values is found and the respective counter is incremented. ---*/
-        nSpecies_per_Inlet.back()++;
+        num_vals_per_string.back()++;
       }
     }
 
-    /*--- Check that the same amount of values are defined per marker. ---*/
-    for (auto elem : nSpecies_per_Inlet)
-      if (nSpecies_per_Inlet[0] != elem)
-        SU2_MPI::Error("Unequal number of species defined for MARKER_INLET_SPECIES.", CURRENT_FUNCTION);
-
-    nSpecies = nSpecies_per_Inlet[0];
-    size = nSpecies_per_Inlet.size();
+    /*--- Check that the same amount of values are defined per string. ---*/
+    for (auto n : num_vals_per_string) {
+      if (num_vals_per_string[0] != n)
+        SU2_MPI::Error(string("Unequal number of values defined for ") + name, CURRENT_FUNCTION);
+    }
+    num_vals = num_vals_per_string[0];
+    size = num_vals_per_string.size();
 
-    marker = new string[size];
-    inletspeciesval = new su2double*[size];
-    for (unsigned short i = 0; i < size; i++) {
-      inletspeciesval[i] = new su2double[nSpecies];
+    /*--- If num_vals was taken as optional, it can only be one. ---*/
+    if (optional_num_vals > 1)
+      SU2_MPI::Error(string("More than one value provided for \"string-value\" pair, in ") + name, CURRENT_FUNCTION);
 
-      marker[i].assign(option_value[(1+nSpecies)*i]);
+    strings = new string[size];
+    values = new Type[size];
 
-      for (unsigned short j = 0; j < nSpecies; j++){
-        istringstream ss_nd(option_value[(1+nSpecies)*i + 1+j]);
-        if (!(ss_nd >> inletspeciesval[i][j])) {
-          return badValue(option_value, "inlet", name);
+    auto option_it = option_value.begin();
+    for (unsigned short i = 0; i < size; i++) {
+      strings[i].assign(*option_it);
+      ++option_it;
+
+      values[i] = CStringValuesListHelper<Type>::resize(num_vals);
+      for (unsigned short j = 0; j < num_vals; j++) {
+        istringstream ss_nd(*option_it);
+        ++option_it;
+        if (!(ss_nd >> CStringValuesListHelper<Type>::access(values[i], j))) {
+          return badValue(option_value, "\"string + values\"", name);
         }
       }
     }
-
     return "";
   }
 
   void SetDefault() override {
-    marker = nullptr;
-    inletspeciesval = nullptr;
-    size = 0; // There is no default value for list
-    nSpecies = 0;
+    size = 0; // There is no default value for lists
+    num_vals = 0;
   }
 };
 
+
 template <class Tenum>
 class COptionRiemann : public COptionBase {
 

Common/src/CConfig.cpp

@@ -461,10 +461,10 @@ void CConfig::addFFDDegreeOption(const string name, unsigned short & nFFD_field,
 }
 
 void CConfig::addStringDoubleListOption(const string name, unsigned short & list_size, string * & string_field,
-                               su2double* & double_field) {
+                                        su2double* & double_field) {
   assert(option_map.find(name) == option_map.end());
   all_options.insert(pair<string, bool>(name, true));
-  COptionBase* val = new COptionStringDoubleList(name, list_size, string_field, double_field);
+  COptionBase* val = new COptionStringValuesList<su2double>(name, list_size, string_field, double_field);
   option_map.insert(pair<string, COptionBase *>(name, val));
 }
 
@@ -476,11 +476,13 @@ void CConfig::addInletOption(const string name, unsigned short & nMarker_Inlet,
   option_map.insert(pair<string, COptionBase *>(name, val));
 }
 
-void CConfig::addInletSpeciesOption(const string name, unsigned short & nMarker_Inlet_Species, string * & Marker_Inlet_Species,
-                                    su2double** & inlet_species_val, unsigned short & nSpecies_per_Inlet) {
+void CConfig::addInletSpeciesOption(const string name, unsigned short & nMarker_Inlet_Species,
+                                    string * & Marker_Inlet_Species, su2double** & inlet_species_val,
+                                    unsigned short & nSpecies_per_Inlet) {
   assert(option_map.find(name) == option_map.end());
   all_options.insert(pair<string, bool>(name, true));
-  COptionBase* val = new COptionInletSpecies(name, nMarker_Inlet_Species, Marker_Inlet_Species, inlet_species_val, nSpecies_per_Inlet);
+  COptionBase* val = new COptionStringValuesList<su2double*>(name, nMarker_Inlet_Species, Marker_Inlet_Species,
+                                                             inlet_species_val, nSpecies_per_Inlet);
   option_map.insert(pair<string, COptionBase *>(name, val));
 }
 
@@ -856,7 +858,7 @@ void CConfig::SetPointersNull(void) {
   Inlet_Ttotal    = nullptr;    Inlet_Ptotal      = nullptr;
   Inlet_FlowDir   = nullptr;    Inlet_Temperature = nullptr;    Inlet_Pressure = nullptr;
   Inlet_Velocity  = nullptr;    Inlet_MassFrac    = nullptr;
-  Outlet_Pressure = nullptr;
+  Outlet_Pressure = nullptr;    Inlet_SpeciesVal  = nullptr;
 
   /*--- Engine Boundary Condition settings ---*/
 
@@ -2834,25 +2836,25 @@ void CConfig::SetConfig_Options() {
 
   /* DESCRIPTION: Size of the edge groups colored for thread parallel edge loops (0 forces the reducer strategy). */
   addUnsignedLongOption("EDGE_COLORING_GROUP_SIZE", edgeColorGroupSize, 512);
-  
+
   /*--- options that are used for libROM ---*/
   /*!\par CONFIG_CATEGORY:libROM options \ingroup Config*/
-  
+
   /*!\brief SAVE_LIBROM \n DESCRIPTION: Flag for saving data with libROM. */
   addBoolOption("SAVE_LIBROM", libROM, false);
-  
+
   /*!\brief LIBROM_BASE_FILENAME \n DESCRIPTION: Output base file name for libROM   \ingroup Config*/
   addStringOption("LIBROM_BASE_FILENAME", libROMbase_FileName, string("su2"));
-  
+
   /*!\brief BASIS_GENERATION \n DESCRIPTION: Flag for saving data with libROM. */
   addEnumOption("BASIS_GENERATION", POD_Basis_Gen, POD_Map, POD_KIND::STATIC);
-  
+
   /*!\brief MAX_BASIS_DIM \n DESCRIPTION: Maximum number of basis vectors.*/
   addUnsignedShortOption("MAX_BASIS_DIM", maxBasisDim, 100);
-  
+
   /*!\brief ROM_SAVE_FREQ \n DESCRIPTION: How often to save snapshots for unsteady problems.*/
   addUnsignedShortOption("ROM_SAVE_FREQ", rom_save_freq, 1);
-  
+
   /* END_CONFIG_OPTIONS */
 
 }
@@ -7928,6 +7930,13 @@ CConfig::~CConfig(void) {
      delete[] FlowLoad_Value;
      delete[] Roughness_Height;
      delete[] Wall_Emissivity;
+
+  if (Inlet_SpeciesVal != nullptr) {
+    for (auto i = 0u; i < nMarker_Inlet_Species; ++i)
+      delete[] Inlet_SpeciesVal[i];
+  }
+  delete[] Inlet_SpeciesVal;
+
   /*--- related to periodic boundary conditions ---*/
 
   for (iMarker = 0; iMarker < nMarker_PerBound; iMarker++) {
@@ -7984,6 +7993,7 @@ CConfig::~CConfig(void) {
              delete[] Marker_Internal;
                 delete[] Marker_HeatFlux;
           delete[] Marker_Emissivity;
+  delete[] Marker_Inlet_Species;
 
   delete [] Int_Coeffs;