cs_user_parameters.f90 File Reference

User subroutines for input of calculation parameters (Fortran modules). These subroutines are called in all cases. More...

Functions/Subroutines
subroutine	usppmo (ixmlpu)
	User subroutine for selection of specific physics module. More...
subroutine	usipph (ixmlpu, iturb, itherm, iale)
	User subroutine for input of model selection parameters. More...
subroutine	usipsu (nmodpp)
	User subroutine for the input of additional user parameters. More...
subroutine	usipes (nmodpp)
	User subroutine for the input of additional user parameters for input/output. More...
subroutine	usati1
	Initialize non-standard calculation options for the atmospheric version. More...
subroutine	cs_user_combustion
	This routine is called: More...
subroutine	cs_f_user_radiative_transfer_param
	User subroutines for input of calculation parameters, and to initialize variables used for radiative transfer module. More...
subroutine	uscfx1
	User subroutine. More...
subroutine	uscfx2
	User subroutine. More...
subroutine	cs_user_cooling_towers
	Definition of cooling tower model and exchange zones. More...
subroutine	user_darcy_ini1
	User routine for definition of computation parameters dealing with Darcy module. More...

Detailed Description

User subroutines for input of calculation parameters (Fortran modules). These subroutines are called in all cases.

See Input of calculation parameters (Fortran subroutines in cs_user_parameters.f90) for examples.

If the Code_Saturne GUI is used, this file is not required (but may be used to override parameters entered through the GUI, and to set parameters not accessible through the GUI).

Several routines are present in the file, each destined to defined specific parameters.

To modify the default value of parameters which do not appear in the examples provided, code should be placed as follows:

• usipsu for numerical and physical options
• usipes for input-output related options

As a convention, "specific physics" defers to the following modules only: pulverized coal, gas combustion, electric arcs.

In addition, specific routines are provided for the definition of some "specific physics" options. These routines are described at the end of this file and will be activated when the corresponding option is selected in the usppmo routine.

Function/Subroutine Documentation

cs_f_user_radiative_transfer_param()

subroutine cs_f_user_radiative_transfer_param

(

)

User subroutines for input of calculation parameters, and to initialize variables used for radiative transfer module.

cs_user_combustion()

subroutine cs_user_combustion

(

)

This routine is called:

1. Additional Calculation Options a. Density Relaxation
   1. Physical Constants a.Dynamic Diffusion Coefficient b.Constants of the chosen model (EBU, Libby-Williams, ...) - Eddy Break Up pre-mixed flame
      • Diffusion flame in the framework of `‘3 points’' rapid complete chemistry
      • Libby-Williams pre-mixed flame
      • Lagrangian module coupled with pulverized coal: Eulerian combustion of pulverized coal and Lagrangian transport of coal particles
      • Pulverised coal combustion
      • Fuel (oil) combustion

cs_user_cooling_towers()

subroutine cs_user_cooling_towers

(

)

Definition of cooling tower model and exchange zones.

usati1()

subroutine usati1

(

)

Initialize non-standard calculation options for the atmospheric version.

uscfx1()

subroutine uscfx1

(

)

User subroutine.

Initialize non standard options for the compressible flow scheme such as the variability of the thermal conductivity and the volume viscosity. Their values can be given in the subroutine uscfx2 .

uscfx2()

subroutine uscfx2

(

)

User subroutine.

Set values for the reference volumic viscosity, the reference conductivity and the molar mass for compressible flow.

Initialize non standard options for the compressible flow scheme such as the hydrostatic equilibrium.

In addition to options set in the user subroutine uscfx1 (or in the GUI): this subroutine allows to set a switch to indicate if the molecular viscosity is constant, its values being given in the user subroutine usipsu .

user_darcy_ini1()

subroutine user_darcy_ini1

(

)

User routine for definition of computation parameters dealing with Darcy module.

usipes()

subroutine usipes

(

integer

nmodpp

)

User subroutine for the input of additional user parameters for input/output.

Parameters

[in]

nmodpp

number of active specific physics models

This subroutine allows setting parameters which do not already appear in the other subroutines of this file.

It is possible to add or remove parameters. The number of physical properties and variables is known here.

usipph()

subroutine usipph	(	integer	ixmlpu,
		integer	iturb,
		integer	itherm,
		integer	iale
	)

User subroutine for input of model selection parameters.

Parameters

[in]	ixmlpu	indicates if the XML file from the GUI is used used (1: yes, 0: no
[in,out]	iturb	turbulence model
[in,out]	itherm	thermal model
[in,out]	iale	ALE module

In this subroutine, only the parameters which already appear may be set, to the exclusion of any other.

If we are not using the Code_Saturne GUI: All the parameters which appear in this subroutine must be set.

If we are using the Code_Saturne GUI: parameters protected by a test of the form:

if (ixmlpu.eq.0) then ... endif

should already have been defined using the GUI, so only experts should consider removing the test and adapting them here.

usipsu()

subroutine usipsu

(

integer

nmodpp

)

User subroutine for the input of additional user parameters.

Parameters

[in]

nmodpp

number of active specific physics models

This subroutine allows setting parameters which do not already appear in the other subroutines of this file.

It is possible to add or remove parameters. The number of physical properties and variables is known here.

usppmo()

subroutine usppmo

(

integer

ixmlpu

)

User subroutine for selection of specific physics module.

Define the use of a specific physics amongst the following:

• combustion with gas / coal / heavy fuel oil
• compressible flows
• electric arcs
• atmospheric modelling
• radiative transfer

• cooling towers modelling

  Only one specific physics module can be activated at once.

  Parameters

  [in]

  ixmlpu

  indicates if the XML file from the GUI is used (1 : yes, 0 : no)