Added todos

Author: EvertBunschoten

Documentation/source/documentation/configs/Config_FGM.rst

@@ -196,6 +196,8 @@ The functions listed in this section allow the user to access the preferential d
 
 The preferential diffusion scalars are calculated when preferential diffusion is enabled in the *SU2 DataMiner* configuration, which can be done with the following functions. 
 
+# TODO: write preferential diffusion scalar equations 
+
 .. autofunction:: Common.DataDrivenConfig.Config_FGM.EnablePreferentialDiffusion
 
 .. autofunction:: Common.DataDrivenConfig.Config_FGM.PreferentialDiffusion  

Documentation/source/documentation/datageneration/flameletdatagen.rst

@@ -11,12 +11,25 @@ Generation of Flamelet Data
 
 This page provides the documentation on the methods used for generating flamelet data with *SU2 DataMiner*. 
 
+.. _flamelet_data_gen_workflow: 
+
+Process Diagram 
+---------------
+
+# TODO: show solution diagram 
+
+# TODO: describe steps 
+
+# TODO: describe which data are saved and how to retrieve dependent variables.
 
 .. _flameletgen:
 
 Flamelet Calculations
 ---------------------
 
+# TODO: solution processes for each flamelet type 
+
+
 .. autofunction:: Data_Generation.DataGenerator_FGM.DataGenerator_Cantera.ComputeFreeFlames
 
 

Documentation/source/documentation/datageneration/nicfddatagen.rst

@@ -17,18 +17,38 @@ This page provides the documentation on the methods used for generating thermody
 .. autofunction:: Data_Generation.DataGenerator_NICFD.DataGenerator_CoolProp.__init__
 
 
+.. _flamelet_data_gen_workflow: 
+
+Process Diagram 
+---------------
+
+# TODO: show solution diagram 
+
+# TODO: describe steps 
+
+
+
 .. _thermodynamicstates:
 
 Thermodynamic State Calculations
 --------------------------------
 
+# TODO: describe how thermophysical properties are calculated in single and two-phase regions.
+
+
 .. autofunction:: Data_Generation.DataGenerator_NICFD.DataGenerator_CoolProp.PreprocessData
 
+
+# TODO: describe how data ranges are automatically determined 
+
+
 .. autofunction:: Data_Generation.DataGenerator_NICFD.DataGenerator_CoolProp.ComputeData
 
 .. autofunction:: Data_Generation.DataGenerator_NICFD.DataGenerator_CoolProp.SaveData
 
 
+# TODO: describe newly added methods 
+
 
 .. _configoverwrite_nicfd:
 

Documentation/source/documentation/datamining/datamining.rst

@@ -5,4 +5,41 @@ Retrieving FGM Controlling Variables and Manifold Data from Flamelets
 
 .. important::
 
-    Documentation in development
+    Documentation in development
+
+
+.. _datamining_general_process:
+
+Process Diagram 
+---------------
+
+# TODO: process diagram of flamelet data mining.
+
+# TODO: describe general process 
+
+.. _datamining_fgm_resolution: 
+
+Ranges and Resolution 
+---------------------
+
+# TODO: describe range setter methods 
+
+# TODO: Describe resolution settings
+
+# TODO: Sampling and interpolation method for flamelet types 
+
+
+.. _datamining_fgm_variables: 
+
+Output and Passive Variables 
+----------------------------
+
+# TODO: describe default variables included in output 
+
+# TODO: Describe passive variables methods
+ 
+ 
+.. _datamining_fgm_config:
+
+Overwriting Config Settings 
+---------------------------

Documentation/source/documentation/datamining/index.rst

@@ -2,8 +2,8 @@ Accumulating Manifold Data
 ==========================
 
 .. toctree::
-   progressvariablemethods
-   datamining
-   variablegrouping
+   progressvariablemethods.rst
+   datamining.rst
+   variablegrouping.rst
    :caption: Processing of flamelet data
    :maxdepth: 1

Documentation/source/documentation/datamining/progressvariablemethods.rst

@@ -5,4 +5,38 @@ Automated Methods for Defining the Progress Variable
 
 .. important::
 
-    Documentation in development
+    Documentation in development
+
+
+.. _pvmethod_default:
+
+Default method: Weighted Reactants and Products 
+-----------------------------------------------
+
+# TODO: default method: weighted reactants and products 
+
+
+.. _pvmethod_optim: 
+
+Optimization Method 
+-------------------
+
+# TODO: process diagram of optimization process 
+
+# TODO: description of optimization process
+
+# TODO: methods for optimization settings 
+
+# TODO: filtering process, 
+
+# TODO: progress vector definition
+
+# TODO: penalty function, merit function description
+
+
+.. _pvmethod_pca: 
+
+Principal Component Analysis 
+----------------------------
+
+# TODO: describe features

Documentation/source/documentation/datamining/variablegrouping.rst

@@ -6,4 +6,17 @@ Grouping of Thermochemical Variables
 
 .. important::
 
-    Documentation in development
+    Documentation in development
+
+
+.. _variablegrouping_general_process: 
+
+Process Diagram 
+---------------
+
+# TODO: process diagram 
+
+# TODO: describe general process 
+
+# TODO: describe affinity selection algorithm 
+