12.1.20. UDF control

12.1.20.1. C(USER-DEFINED ID)

Data Type: DOUBLE PRECISION

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

User defined constants.

12.1.20.2. 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.20.3. 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.95 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined subroutines.

.FALSE.

◉

Do NOT call user-defined subroutines.

12.1.20.4. 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.96 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined source.

.FALSE.

◉

MFIX default: No additional source.

12.1.20.5. 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.

12.1.20.6. 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.97 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.7. 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.98 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.8. 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.99 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.9. 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.100 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.10. USR_DT(USR)

Data Type: DOUBLE PRECISION

  • \(1 \le USR \le 5\)

Interval at which subroutine write_usr1 is called.

12.1.20.11. USR_EXT(USR)

Data Type: CHARACTER

  • \(1 \le USR \le 5\)

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

12.1.20.12. 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.101 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.13. USR_FORMAT(USR)

Data Type: CHARACTER

  • \(1 \le USR \le 5\)

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

12.1.20.14. 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.102 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.15. 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.103 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.16. USR_I_E(USR)

Data Type: INTEGER

  • \(1 \le USR \le 5\)

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

12.1.20.17. USR_I_W(USR)

Data Type: INTEGER

  • \(1 \le USR \le 5\)

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

12.1.20.18. USR_J_N(USR)

Data Type: INTEGER

  • \(1 \le USR \le 5\)

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

12.1.20.19. USR_J_S(USR)

Data Type: INTEGER

  • \(1 \le USR \le 5\)

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

12.1.20.20. USR_K_B(USR)

Data Type: INTEGER

  • \(1 \le USR \le 5\)

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

12.1.20.21. USR_K_T(USR)

Data Type: INTEGER

  • \(1 \le USR \le 5\)

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

12.1.20.22. 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.104 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.23. 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.105 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.24. 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.106 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.25. 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.107 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.26. 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.108 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.27. 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.109 Valid Values

Name

Default?

Description

.TRUE.

Call user-defined function.

.FALSE.

◉

Use MFIX default calculation.

12.1.20.28. USR_TYPE(USR)

Data Type: CHARACTER

  • \(1 \le USR \le 5\)

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

12.1.20.29. 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.20.30. 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.20.31. 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.20.32. 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.20.33. 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.20.34. 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.20.35. USR_Z_T(USR)

Data Type: DOUBLE PRECISION

  • \(1 \le USR \le 5\)

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