@@ -39,7 +39,7 @@ MODULE CVODE_INTERFACE
3939! > \param TN_C is the current time
4040! > \param SUNVEC_Y is the current array of molar concentrations, temperature and pressure.
4141! > \param SUNVEC_F is the array of derivatives returned
42- ! > \param USER_DATA is the user data array. Not yet used in FDS .
42+ ! > \param C_USER_DATA is the user data array. Hold unburned zone data for mixing+chem .
4343! > \details The right hand side function of the ode d[c]/dt = wdot (=f). Provides the Derivative function to CVODE.
4444INTEGER (C_INT) FUNCTION RHSFN(TN_C, SUNVEC_Y, SUNVEC_F, C_USER_DATA) &
4545 RESULT(IERR) BIND(C,NAME= ' RHSFN' )
@@ -86,7 +86,7 @@ END FUNCTION RHSFN
8686! > \param CVEC is the current array of molar concentrations, temperature and pressure.
8787! > \param FVEC is the array of derivatives returned
8888! > \param TN is the current time
89- ! > \param USER_DATA is the user data containing mixing information
89+ ! > \param USER_DATA is the user data array. Hold unburned zone data for mixing+chem.
9090
9191SUBROUTINE DERIVATIVE (CVEC ,FVEC , TN , USER_DATA )
9292USE PHYSICAL_FUNCTIONS, ONLY : GET_SPECIFIC_HEAT_INTERP, GET_ENTHALPY, GET_ENTHALPY_Z, &
@@ -258,7 +258,7 @@ END FUNCTION CALCFCENT
258258! > \param SUNVEC_Y is the current array of molar concentrations, temperature and pressure.
259259! > \param SUNVEC_F is the array of derivatives returned
260260! > \param SUNMAT_J is the Jacobian array returned to CVODE
261- ! > \param USER_DATA is the user data array. Not yet used in FDS .
261+ ! > \param C_USER_DATA is the user data array. Hold unburned zone data for mixing+chem .
262262! > \param TMP1 is not yet used in FDS.
263263! > \param TMP2 is not yet used in FDS.
264264! > \param TMP3 is not yet used in FDS.
@@ -328,6 +328,8 @@ END FUNCTION JACFN
328328! > \param CVEC is the current array of molar concentrations, temperature and pressure.
329329! > \param FVEC is the array of derivatives passed as input
330330! > \param JMAT is the jacobian matrix returned
331+ ! > \param TN is the current time provided by CVODE during callback, not the actual CFD time.
332+ ! > \param USER_DATA is the user data array. Hold unburned zone data for mixing+chem.
331333
332334SUBROUTINE JACOBIAN (CVEC ,FVEC ,JMAT ,TN ,USER_DATA )
333335
@@ -779,10 +781,11 @@ END FUNCTION DDTMP_TROE
779781
780782
781783! > \brief cvode interface for ODE integrator. Call sundials cvode in serial mode.
782- ! > \param CC species mass fraction array
783- ! > \param TMP_IN is the temperature
784+ ! > \param CC species concentration (kmol/m3) array
785+ ! > \param ZZ_0 initial species mass fraction array (of the unbuned zone),needed for mixing+chem
786+ ! > \param TMP_IN is the temperature of the cell (unburned zone)
784787! > \param PR_IN is the pressure
785- ! > \param ZETA0 is the initial unmixed fraction
788+ ! > \param ZETA0 is the initial unmixed fraction
786789! > \param TAU_MIX is Mixing timescale
787790! > \param CELL_MASS total mass of the cell (mixed + unmixed)
788791! > \param TCUR is the start time in seconds
0 commit comments