12.1.14. UDF Control¶

12.1.14.1. CALL_USR¶

Data Type: LOGICAL

Flag to enable user-defined subroutines: USR0, USR1, USR2, USR3, USR0_DES, USR1_DES, USR2_DES, USR3_DES, USR4_DES.

Table 12.75 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined subroutines.
`.FALSE.`	◉	Do NOT call user-defined subroutines.

12.1.14.2. CALL_USR_SOURCE(EQUATION ID NUMBER)¶

Data Type: LOGICAL

\(1 \le Equation ID Number \le 10\)

Flag to enable user_defined subroutine, usr_source, for calculating source terms in the indicated equation.

Table 12.76 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined source.
`.FALSE.`	◉	MFIX default: No additional source.

12.1.14.3. USR_ROG¶

Data Type: LOGICAL

Flag to use the User Defined Function, USR_PROP_ROg, in model/usr_properties.f for calculating the gas phase density, RO_g.

Table 12.77 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.4. USR_CPG¶

Data Type: LOGICAL

Flag to use the User Defined Function, USR_PROP_CPg, in model/usr_properties.f for calculating the gas phase constant pressure specific heat, C_pg.

Table 12.78 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.5. USR_KG¶

Data Type: LOGICAL

Flag to use the User Defined Function, USR_PROP_Kg, in model/usr_properties.f for calculating the gas phase conductivity, K_g.

Table 12.79 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.6. USR_DIFG¶

Data Type: LOGICAL

Flag to use the User Defined Function, USR_PROP_Difg, in model/usr_properties.f for calculating the gas phase diffusivity.

Table 12.80 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.7. USR_MUG¶

Data Type: LOGICAL

Flag to use the User Defined Function, USR_PROP_Mug, in model/usr_properties.f for calculating the gas phase viscosity, Mu_g.

Table 12.81 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.8. USR_ROS(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le 10\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_ROs, in model/usr_properties.f for calculating the solids phase density, RO_s.

Table 12.82 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.9. USR_CPS(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le 10\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_CPs, in model/usr_properties.f for calculating the solids phase constant pressure specific heat, C_ps.

Table 12.83 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.10. USR_KS(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le 10\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_Ks, in model/usr_properties.f for calculating the solids phase conductivity, K_s.

Table 12.84 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.11. USR_DIFS(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le 10\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_Difs, in model/usr_properties.f for calculating the solids phase diffusivity, Dif_s.

Table 12.85 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.12. USR_MUS(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le 10\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_Mus, in model/usr_properties.f for calculating the solids phase viscosity, Mu_s; second viscosity, lambda_s; and pressure, P_s.

Table 12.86 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.13. USR_GAMA(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le 10\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_Gama, in model/usr_properties.f for calculating the gas-solids phase heat transfer coefficient, Gama_gs.

Table 12.87 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.14. USR_FGS(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le 10\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_Fgs, in model/usr_properties.f for calculating the gas-solids phase drag coefficient due to relative velocity differences, F_gs. Currently unavailable.

Table 12.88 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.15. USR_FSS(PHASE)¶

Data Type: LOGICAL

\(1 \le Phase \le DIM{\_}LM\)

Applies to Solids Model(s): TFM

Flag to use the User Defined Function, USR_PROP_Fss, in model/usr_properties.f for calculating the solids-solids phase drag coefficient due to relative velocity differences, F_ss. Currently unavailable.

Table 12.89 Valid Values¶
Name	Default?	Description
`.TRUE.`		Call user-defined function.
`.FALSE.`	◉	Use MFIX default calculation.

12.1.14.16. C(USER-DEFINED ID)¶

Data Type: DOUBLE PRECISION

\(1 \le User-defined ID \le DIMENSION{\_}C\)

User defined constants.

12.1.14.17. C_NAME(USER-DEFINED ID)¶

Data Type: CHARACTER

\(1 \le User-defined ID \le DIMENSION{\_}C\)

Name of user-defined constant. (20 character max)

12.1.14.18. USR_DT(USR)¶

Data Type: DOUBLE PRECISION

\(1 \le USR \le 5\)

Interval at which subroutine write_usr1 is called.

12.1.14.19. USR_X_W(USR)¶

Data Type: DOUBLE PRECISION

\(1 \le USR \le 5\)

UDF hook: x coordinate of the west face or edge.

12.1.14.20. USR_X_E(USR)¶

Data Type: DOUBLE PRECISION

\(1 \le USR \le 5\)

UDF hook: x coordinate of the east face or edge.

12.1.14.21. USR_Y_S(USR)¶

Data Type: DOUBLE PRECISION

\(1 \le USR \le 5\)

UDF hook: y coordinate of the south face or edge.

12.1.14.22. USR_Y_N(USR)¶

Data Type: DOUBLE PRECISION

\(1 \le USR \le 5\)

UDF hook: y coordinate of the north face or edge.

12.1.14.23. USR_Z_B(USR)¶

Data Type: DOUBLE PRECISION

\(1 \le USR \le 5\)

UDF hook: z coordinate of the bottom face or edge.

12.1.14.24. USR_Z_T(USR)¶

Data Type: DOUBLE PRECISION

\(1 \le USR \le 5\)

UDF hook: z coordinate of the top face or edge.

12.1.14.25. USR_I_W(USR)¶

Data Type: INTEGER

\(1 \le USR \le 5\)

UDF hook: i index of the west-most cell.

12.1.14.26. USR_I_E(USR)¶

Data Type: INTEGER

\(1 \le USR \le 5\)

UDF hook: i index of the east-most cell.

12.1.14.27. USR_J_S(USR)¶

Data Type: INTEGER

\(1 \le USR \le 5\)

UDF hook: j index of the south-most cell.

12.1.14.28. USR_J_N(USR)¶

Data Type: INTEGER

\(1 \le USR \le 5\)

UDF hook: j index of the north-most cell.

12.1.14.29. USR_K_B(USR)¶

Data Type: INTEGER

\(1 \le USR \le 5\)

UDF hook: k index of the bottom-most cell.

12.1.14.30. USR_K_T(USR)¶

Data Type: INTEGER

\(1 \le USR \le 5\)

UDF hook: k index of the top-most cell.

12.1.14.31. USR_TYPE(USR)¶

Data Type: CHARACTER

\(1 \le USR \le 5\)

UDF hook: Type of user-defined output: Binary or ASCII.

12.1.14.32. USR_VAR(USR)¶

Data Type: CHARACTER

\(1 \le USR \le 5\)

UDF hook:: Variable to be written in the user-defined output files.

12.1.14.33. USR_FORMAT(USR)¶

Data Type: CHARACTER

\(1 \le USR \le 5\)

UDF hook:: Format for writing user-defined (ASCII) output file.

12.1.14.34. USR_EXT(USR)¶

Data Type: CHARACTER

\(1 \le USR \le 5\)

UDF hook: File extension for the user-defined output.

12.1.14.35. DES_USR_VAR_SIZE¶

Data Type: INTEGER

Applies to Solids Model(s): DEM

Defines the size of the particle-based user variable: DES_USR_VAR(SIZE, PARTICLES). Information in this array follows the particle throughout a simulation.