[WIP] Flamelet approach for premixed flames

Common/include/CConfig.hpp

@@ -379,6 +379,16 @@ class CConfig {
   su2double *Surface_PressureDrop;           /*!< \brief Pressure drop between boundaries. */
   su2double* Surface_Species_0;              /*!< \brief Average Species_0 at the boundaries. */
   su2double* Surface_Species_Variance;       /*!< \brief Species Variance at the boundaries. */
+  su2double* Surface_Scalar_00;              /*!< \brief Average of scalar 0 at the boundaries. */
+  su2double* Surface_Scalar_01;              /*!< \brief Average of scalar 1 at the boundaries. */
+  su2double* Surface_Scalar_02;              /*!< \brief Average of scalar 2 at the boundaries. */
+  su2double* Surface_Scalar_03;              /*!< \brief Average of scalar 3 at the boundaries. */
+  su2double* Surface_Scalar_04;              /*!< \brief Average of scalar 4 at the boundaries. */
+  su2double* Surface_Scalar_05;              /*!< \brief Average of scalar 5 at the boundaries. */
+  su2double* Surface_Scalar_06;              /*!< \brief Average of scalar 6 at the boundaries. */
+  su2double* Surface_Scalar_07;              /*!< \brief Average of scalar 7 at the boundaries. */
+  su2double* Surface_Scalar_08;              /*!< \brief Average of scalar 8 at the boundaries. */
+  su2double* Surface_Scalar_09;              /*!< \brief Average of scalar 9 at the boundaries. */
   su2double *Surface_DC60;                   /*!< \brief Specified surface DC60 for nacelle boundaries. */
   su2double *Surface_IDC;                    /*!< \brief Specified IDC for nacelle boundaries. */
   su2double *Surface_IDC_Mach;               /*!< \brief Specified IDC mach for nacelle boundaries. */
@@ -714,6 +724,7 @@ class CConfig {
   *Marker_WallFunctions,              /*!< \brief Markers for which wall functions must be applied. */
   *Marker_SobolevBC;                  /*!< \brief Markers in the gradient solver */
 
+  bool initial_PyCustom;              /*!< \brief flag for using custom python boundary conditions */ 
   unsigned short nConfig_Files;       /*!< \brief Number of config files for multiphysics problems. */
   string *Config_Filenames;           /*!< \brief List of names for configuration files. */
   SST_OPTIONS *SST_Options;           /*!< \brief List of modifications/corrections/versions of SST turbulence model.*/
@@ -767,6 +778,7 @@ class CConfig {
   unsigned short ActDisk_Jump;        /*!< \brief Format of the output files. */
   unsigned long StartWindowIteration; /*!< \brief Starting Iteration for long time Windowing apporach . */
   unsigned short nCFL_AdaptParam;     /*!< \brief Number of CFL parameters provided in config. */
+  bool Initial_All_PyCustom;          /*!< \brief Python customizable initial condition */    
   bool CFL_Adapt;        /*!< \brief Use adaptive CFL number. */
   bool HB_Precondition;  /*!< \brief Flag to turn on harmonic balance source term preconditioning */
   su2double RefArea,     /*!< \brief Reference area for coefficient computation. */
@@ -1215,6 +1227,27 @@ class CConfig {
   su2double* Species_Init;         /*!< \brief Initial uniform value for scalar transport. */
   unsigned short nSpecies_Init;    /*!< \brief Number of entries of SPECIES_INIT */
 
+  /*--- flamelet subsolver ---*/
+  su2double flame_thickness;
+  su2double flame_burnt_thickness;
+  su2double flame_offset[3];
+  su2double flame_normal[3];
+
+  /*--- lookup table ---*/
+  unsigned short n_scalars;             /* number of transported scalars for the flamelet LUT approach*/
+  unsigned short n_lookups;             /* number of lookud up variables */
+  unsigned short n_table_sources;       /* the number of transported scalar source terms for the LUT */
+  unsigned short n_user_scalars;
+  unsigned short n_user_sources;
+  unsigned short n_control_vars;
+
+  vector<string> table_scalar_names;    /*!< \brief vector to store names of scalar variables.   */
+  vector<string> table_source_names;    /*!< \brief vector to store names of scalar source variables.   */
+  string* table_lookup_names;           /*!< \brief vector to store names of look up variables.   */
+  string file_name_lut;                 /*!< \brief file name of the look up table. */
+  string* user_scalar_names;
+  string* user_source_names;
+
   /*!
    * \brief Set the default values of config options not set in the config file using another config object.
    * \param config - Config object to use the default values from.
@@ -2106,22 +2139,126 @@ class CConfig {
    */
   bool GetSpecies_StrongBC() const { return Species_StrongBC; }
 
+  /*!
+   * \brief Get the flame offset for flamelet model initialization
+   * \return flame offset for flamelet model initialization
+   */
+  su2double *GetFlameOffset(void) { return flame_offset; }
+
+  /*!
+   * \brief Get the flame normal for flamelet model initialization
+   * \return flame offset for flamelet model initialization
+   */
+  su2double *GetFlameNormal(void) { return flame_normal; }
+
+  /*!
+   * \brief Get the flame thickness for flamelet model initialization
+   * \return flame thickness for flamelet model initialization
+   */
+  su2double GetFlameThickness(void) { return flame_thickness; }
+
+  /*!
+   * \brief Get the burnt region thickness for flamelet mdoel initialization
+   * \return flame thickness for flamelet model initialization
+   */
+  su2double GetFlameBurntThickness(void) { return flame_burnt_thickness; }
+
+  /*!
+   * \brief Set the number of scalars for flamelet model.
+   */
+  void SetNScalars(unsigned short n_scalars) { this->n_scalars = n_scalars; }
+
+  /*!
+   * \brief Set the number of controlling variables for flamelet model.
+   */
+  void SetNControlVars(unsigned short n_control_vars) { this->n_control_vars = n_control_vars; }
+
+  /*!
+   * \brief Get the number of control variables for flamelet model.
+   */
+  unsigned short GetNControlVars(void) const { return n_control_vars; }
+
+  /*!
+   * \brief Get the number of transported scalars for flamelet model.
+   */
+  unsigned short GetNScalars(void) const { return n_scalars; }
+
+  /*!
+   * \brief Get the number of user scalars for flamelet model.
+   */
+  unsigned short GetNUserScalars(void) const { return n_user_scalars; }
+
+  /*!
+   * \brief Get the name of the user scalar.
+   */
+  string GetUserScalarName(unsigned short i_user_scalar) const { if(n_user_scalars > 0) return user_scalar_names[i_user_scalar]; else return "NONE"; }
+
+  /*!
+   * \brief Get the name of the user scalar source term.
+   */
+  string GetUserSourceName(unsigned short i_user_source) const { if(n_user_sources > 0) return user_source_names[i_user_source]; else return "NONE"; }
+
+  /*!
+   * \brief Get the number of transported scalars for combustion
+   */
+  unsigned short GetNLookups(void) const { return n_lookups; }
+
+  void SetNLUTSources(unsigned short n_table_sources) { this->n_table_sources = n_table_sources; }
+
+  /*!
+   * \brief Get the number of transported scalars source terms for combustion
+   */
+  unsigned short GetNLUTSources(void) const { return n_table_sources; }
+
+  /*!
+   * \brief Store the names of scalar variables that are being solved
+   * \param[out] stores the names in vector table_scalar_names
+   */
+  inline void SetLUTScalarNames(vector<string> &table_scalar_names) { this->table_scalar_names = table_scalar_names; }
+
+  /*!
+   * \brief Get the name of the independent variable from the lookup table
+   */
+  string GetLUTScalarName(unsigned short i_scalar) const { return table_scalar_names[i_scalar]; }
+
+  /*!
+   * \brief Get the name of the variable that we want to retrieve from the lookup table
+   */
+  string GetLUTLookupName(unsigned short i_lookup) const { return table_lookup_names[i_lookup]; }
+
+  /*!
+   * \brief Store the names of scalar source term variables
+   * \param[out] stores the names in vector table_source_names
+   */
+  inline void SetLUTSourceNames(vector<string> &table_source_names) { this->table_source_names = table_source_names; }
+
+  /*!
+   * \brief Get the scalar source term name i_source
+   */
+  string GetLUTSourceName(unsigned short i_source) const { return table_source_names[i_source]; }
+
+  /*!
+   * \brief Get the file name of the look up table
+   * \return File name of the look up table
+   */
+  string GetFileNameLUT(void){ return file_name_lut; };
+
   /*!
    * \brief Get the Young's modulus of elasticity.
    * \return Value of the Young's modulus of elasticity.
    */
   su2double GetElasticyMod(unsigned short id_val) const { return ElasticityMod[id_val]; }
 
   /*!
-    * \brief Decide whether to apply DE effects to the model.
-    * \return <code>TRUE</code> if the DE effects are to be applied, <code>FALSE</code> otherwise.
-    */
+   * \brief Decide whether to apply DE effects to the model.
+   * \return <code>TRUE</code> if the DE effects are to be applied, <code>FALSE</code> otherwise.
+   */
   bool GetDE_Effects(void) const { return DE_Effects; }
 
   /*!
-    * \brief Decide whether to predict the DE effects for the next time step.
-    * \return <code>TRUE</code> if the DE effects are to be applied, <code>FALSE</code> otherwise.
-    */
+   * \brief Decide whether to predict the DE effects for the next time step.
+   * \return <code>TRUE</code> if the DE effects are to be applied, <code>FALSE</code> otherwise.
+   */
    bool GetDE_Predicted(void);
 
   /*!
@@ -3022,6 +3159,12 @@ class CConfig {
    */
   unsigned short GetnMarker_PyCustom(void) const { return nMarker_PyCustom; }
 
+  /*!
+   * \brief Get Python customizable initial condition.
+   * \return true if customizable initial condition 
+   */
+  bool GetInitial_PyCustom(void) const { return initial_PyCustom; }
+
   /*!
    * \brief Get the total number of moving markers.
    * \return Total number of moving markers.
@@ -3414,6 +3557,13 @@ class CConfig {
    */
   void SetMarker_All_PyCustom(unsigned short val_marker, unsigned short val_PyCustom) { Marker_All_PyCustom[val_marker] = val_PyCustom; }
 
+  /*!
+   * \brief Set if the initial condition is going to be customized in Python <i>val_PyCustom</i>
+   *        (read from the config file).
+   * \param[in] val_PyCustom - 0 or 1 depending if the the initial condition is going to be customized in Python.
+   */
+  void SetInitial_All_PyCustom(unsigned short val_PyCustom) { Initial_All_PyCustom = val_PyCustom; }
+
   /*!
    * \brief Set if a marker <i>val_marker</i> is going to be periodic <i>val_perbound</i>
    *        (read from the config file).
@@ -3564,6 +3714,12 @@ class CConfig {
    */
   unsigned short GetMarker_All_PyCustom(unsigned short val_marker) const { return Marker_All_PyCustom[val_marker];}
 
+  /*!
+   * \brief Get the Python customization for the initial condition
+   * \return 0 or 1 depending if the initial condition is going to be customized in Python.
+   */
+  unsigned short GetInitial_All_PyCustom(unsigned short val_initial) const { return Initial_All_PyCustom;}
+
   /*!
    * \brief Get the airfoil sections in the slicing process.
    * \param[in] val_section - Index of the section.
@@ -7727,6 +7883,22 @@ class CConfig {
    */
   void SetSurface_Species_Variance(unsigned short val_marker, su2double val_surface_species_variance) { Surface_Species_Variance[val_marker] = val_surface_species_variance; }
 
+  /*!
+   * \brief Set the average of scalar_0 at the surface.
+   * \param[in] val_marker - Index corresponding to boundary.
+   * \param[in] val_surface_scalar_0 - Value of avg species_0.
+   */
+  void SetSurface_Scalar_00(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_00[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_01(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_01[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_02(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_02[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_03(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_03[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_04(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_04[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_05(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_05[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_06(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_06[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_07(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_07[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_08(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_08[val_marker] = val_surface_scalar; }
+  void SetSurface_Scalar_09(unsigned short val_marker, su2double val_surface_scalar) { Surface_Scalar_09[val_marker] = val_surface_scalar; }
+
   /*!
    * \brief Get the back pressure (static) at an outlet boundary.
    * \param[in] val_index - Index corresponding to the outlet boundary.
@@ -8007,6 +8179,22 @@ class CConfig {
    */
   su2double GetSurface_Species_Variance(unsigned short val_marker) const { return Surface_Species_Variance[val_marker]; }
 
+  /*!
+   * \brief Get avg scalar_0 at a boundary.
+   * \param[in] val_index - Index corresponding to the boundary.
+   * \return The avg species_0.
+   */
+  su2double GetSurface_Scalar_00(unsigned short val_marker) const { return Surface_Scalar_00[val_marker]; }
+  su2double GetSurface_Scalar_01(unsigned short val_marker) const { return Surface_Scalar_01[val_marker]; }
+  su2double GetSurface_Scalar_02(unsigned short val_marker) const { return Surface_Scalar_02[val_marker]; }
+  su2double GetSurface_Scalar_03(unsigned short val_marker) const { return Surface_Scalar_03[val_marker]; }
+  su2double GetSurface_Scalar_04(unsigned short val_marker) const { return Surface_Scalar_04[val_marker]; }
+  su2double GetSurface_Scalar_05(unsigned short val_marker) const { return Surface_Scalar_05[val_marker]; }
+  su2double GetSurface_Scalar_06(unsigned short val_marker) const { return Surface_Scalar_06[val_marker]; }
+  su2double GetSurface_Scalar_07(unsigned short val_marker) const { return Surface_Scalar_07[val_marker]; }
+  su2double GetSurface_Scalar_08(unsigned short val_marker) const { return Surface_Scalar_08[val_marker]; }
+  su2double GetSurface_Scalar_09(unsigned short val_marker) const { return Surface_Scalar_09[val_marker]; }
+
   /*!
    * \brief Get the back pressure (static) at an outlet boundary.
    * \param[in] val_index - Index corresponding to the outlet boundary.

Common/include/containers/CTrapezoidalMap.hpp

@@ -29,9 +29,10 @@
 
 #include <string>
 #include <vector>
+#include <array>
 
-#include "../../Common/include/linear_algebra/blas_structure.hpp"
 #include "../../Common/include/toolboxes/CSquareMatrixCM.hpp"
+#include "../../Common/include/linear_algebra/blas_structure.hpp"
 
 /*!
  * \class CTrapezoidalMap

Common/include/geometry/CGeometry.hpp

@@ -1275,6 +1275,13 @@ class CGeometry {
    */
   void UpdateCustomBoundaryConditions(CGeometry **geometry_container, CConfig *config);
 
+  /*!
+   * \brief Update the multi-grid structure for the customized initial conditions
+   * \param geometry_container - Geometrical definition.
+   * \param config - Definition of the particular problem.
+   */
+  void UpdateCustomInitialConditions(CGeometry **geometry_container, CConfig *config);
+
   /*!
    * \brief A virtual member.
    * \param config - Config