programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions/Subroutines
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
 
subroutine usipph
 
subroutine usipsu
 
subroutine usipes
 
subroutine usati1
 
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
 
subroutine uscfx2
 
subroutine uscti1
 
subroutine user_darcy_ini1
 

Detailed Description

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

See Input of calculation parameters (Fortran modules) 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:

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

subroutine cs_f_user_radiative_transfer_param ( )

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

subroutine cs_user_combustion ( )

This routine is called:

  1. Additional Calculation Options a. Density Relaxation
  2. 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
subroutine usati1 ( )

Initialize non-standard calculation options for the atmospheric version.

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 .

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 .

subroutine uscti1 ( )

Definition of cooling tower model and exchange zones

subroutine user_darcy_ini1 ( )

User routine for definition of computation parameters dealing with darcy module

subroutine usipes ( )

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

Parameters
[in]nmodppnumber 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. 
subroutine usipph ( )

User subroutine for input of parameters.

Parameters
[in]ixmlpuindicates if the XML file from the GUI is used used (1: yes, 0: no
[in,out]iturbturbulence model
[in,out]ithermthermal model
[in,out]ialeale module
[in,out]icavitcavitation model

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.

subroutine usipsu ( )

User subroutine for the input of additional user parameters.

Parameters
[in]nmodppnumber 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.

subroutine usppmo ( )

User subroutine.

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]ixmlpuindicates if the XML file from the GUI is used (1 : yes, 0 : no)