8.3
general documentation
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 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...
 

Detailed Description

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

See f_parameters 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

◆ usipes()

subroutine usipes ( integer  nmodpp)

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.

◆ usipsu()

subroutine usipsu ( integer  nmodpp)

User subroutine for the input of additional user parameters.

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.

Parameters
[in]nmodppnumber of active specific physical models !

◆ 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]ixmlpuindicates if an XML file from the GUI is used !