From 10add1f29e3e91f157cfa0a857148fdaba3a1441 Mon Sep 17 00:00:00 2001
From: minzhang0929 <78373564+minzhang0929@users.noreply.github.com>
Date: Wed, 8 Feb 2023 14:27:50 +0800
Subject: [PATCH] Update input.rst

introduction to combustionProperties
---
 docs/source/qs/input.rst | 71 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/docs/source/qs/input.rst b/docs/source/qs/input.rst
index 73b6065c..4aed76b0 100644
--- a/docs/source/qs/input.rst
+++ b/docs/source/qs/input.rst
@@ -47,5 +47,76 @@ In the above example, the meanings of the parameters are:
 * ``torchModel``: name of network.     
 * ``coresPerNode``: If you are using one node on a cluster or using your own PC, set this parameter to the actual number of cores used to run the task. If you are using more than one node on a cluster, set this parameter the total number of cores on one node. The number of GPUs used is auto-detected.
 
+The dictionary ``CanteraTorchProperties`` is the original dictionary of DeepFlame. It reads in network related parameters and configurations. It typically looks like:
+
+.. code-block::
+
+    combustionModel  flareFGM;//PaSR,EDC
+
+    EDCCoeffs
+    {
+        version v2005;
+    }
 
+    PaSRCoeffs
+    {
+       mixingScale
+       {
+          type   globalScale;//globalScale,kolmogorovScale,geometriMeanScale,dynamicScale 
+
+          globalScaleCoeffs
+          {
+            Cmix  0.01;
+          }
+       }
+       chemistryScale
+       {
+          type  formationRate;//formationRate,globalConvertion
+          formationRateCoeffs
+          {}
+       }
+
+    }  
+    
+    flareFGMCoeffs
+    {
+      buffer           false;
+      scaledPV         false;
+      combustion       false;
+      ignition         false;
+      solveEnthalpy    false;
+      flameletT        false;
+      relaxation       false;
+      DpDt             false;
+    /*ignition         false;
+      ignBeginTime     0.1;
+      ignDurationTime  0.0;
+      x0               0.0;
+      y0               0.0;
+      z0               0.0;
+      R0               0.0;*/
+      Sct              0.7;
+      bufferTime       0.0;
+      speciesName      ("CO");
+    }
+
+In the above example, the meanings of the parameters are:
 
+* ``combustionModel``: the name of the combustion model, alternative models include PaSR, EDC, flareFGM.
+* ``EDCCoeffs, PaSRCoeffs, flareFGMCoeffs``: model cofficients we need to define.
+* ``mixingScale``: turbulent mixing time scale including globalScale,kolmogorovScale,geometriMeanScale,dynamicScale.
+* ``chemistryScale``: chemistry reaction time scale including formationRate,globalConvertion  .
+* ``buffer``: switch for buffer time.
+* ``scaledPV``:the switch is used to determine whether to use scaled progress variables or not.
+* ``combustion``:the switch is used to control whether the chemical reactions are on or off.
+* ``ignition``:the switch is used to control whether the ignition is on or off.     
+* ``solveEnthalpy``:the switch is used to determine whether to solve enthalpy equation or not.
+* ``flameletT``:the switch is used to determine whether to read flame temperature from table or not.
+* ``relaxation``:the switch is used to determine whether to use relaxation iteration for transport equations or not.
+* ``DpDt``:the switch is used to determine whether to include material derivatives or not.
+* ``ignBeginTime``:beginning time of ignition.
+* ``ignDurationTime``:duration time of ignition.
+* ``x0, y0, z0``:coordinate of ignition center.
+* ``R0``:radius of ignition region.
+* ``Sct``:turbulent Schmidt number, default value is set as 0.7.
+* ``speciesName``:name of species we need to lookup.