Open-source Fortran files

A large proportion of the Fortran coding of PHOENICS is open to viewing by all users.

Those who have access to the programmable (ie re-compilable) version, are also free (at their own risk!) to modify it.

Access is here organised under the headings of:

1. core coding,
2. coding associated with the twelve options, and
3. special-purpose-program coding.

a. PHOENICS-core coding concerned with

1. General organization of the calculations
2. Material properties
3. Turbulence
4. Sources, other than of turbulence energy
5. Creation of shapes
6. Use of special source or boundary-condition patches
7. User-created solvers, and other interventions in the equation-forming and solving process
8. Arrangements for output
9. Utilities

b.The 12 options, in alphabetical order

1. Advanced multi-phase flow (algebraic-slip; free-surface flows)
2. Advanced chemistry
3. Advanced numerical algorithms
4. Advanced radiation
5. Advanced turbulence models
6. Body-fitted coordinates
7. GENTRA (particle tracking)
8. (Inter-spersed) two-phase flows
9. Multi-block and fine-grid embedding
10. PLANT, the automatic Fortran-code creator
11. Simultaneous solid-stress analysis

c. Special-purpose programs

1. HOTBOX
2. FLAIR
3. ESTER
4. CVD

The open-source Fortran files of the PHOENICS core concerned with:

1. General organization of the calculations are
   • GROUND, the "frame-work" subroutine, into which users can introduce their own coding, either directly or by way of PLANT
   • GREX3 an exemplary GROUND, which activates many of the sub-routines in the following files.

2. Material properties, in the order in which they are referred to in the PROPS file
   1. Density
      • The Fortran file gxdens
      • The options:
        1 2 3 4 5 6 7 8 9
      • The subroutines:
        density slbden iniden setden

   2. Viscosity
      • The kinematic viscosity file gxknvsl
      • The options:
        -1 1 2 3 4 5 6 7 8 9 0
      • The subroutines:
        KINVISL SLBVSL INIVSL SETVSL

   3. gxspehe for the specific heat capacity, and
      gxtempr for the related coding which deduces the temperature when this is not a directly-solved-for variable
   4. gxprndtl for the (laminar) prandtl number or thermal conductivity
   5. gxthrmx for the thermal-expansion coefficient
   6. gxdrdp for compressibility

      and also:
      

   7. gxprutil for associated utility subroutines.

3. Turbulence
   • gxknvst for turbulent (effective) kinematic viscosity
   • gxmxlen for length scale of turbulence
   • gxturb for turbulence-energy generation
   • gxgenk for further subroutines use in the calculation of energy generation
   • gxwall for turbulent "wall functions"

4. Sources, other than those of turbulence energy
   • gxbuoyso for sources of momentum induced by buoyancy
   • gxrotaso for sources of momentum induced by rotation of coordinates
   • gxchemso for sources of chemical species resulting from reaction
   • gxradiat for sources associated with radiation
   • gxmiscso for miscellaneous sources
   • gxblin for sources associated with the WIND_PROFILE object
   • gxio for sources associated with ANGLED_IN and ANGLED_OUT objects
   • gxfire for sources associated with the FIRE object
   • gxswfan for sources associated with the FAN object in 'swirl' mode

5. Creation of shapes
   • gxshap for simple algebraically-defined shapes
   • gxmask for shapes created by way of masks
   • gxmovpor for varying or moving porosities
   • gxpiston for a grid which expands and contracts in piston-cylinder manner

6. Use of special source or boundary-condition patches
   • gxtimpat for conditions which vary with time
   • gxnepat for neighbour-cell patches
   • gxfuldev for fully-developed flows
   • gxprofil for introducing specific boundary-condition profiles

7. User-created solvers
   • gxgauss for a Gauss-Seidel solver
   • gxconvec for modifications to the convection terms for compressible flows
   • gxsettim for re-setting the time step in a fast transient

8. Arrangements for output
   • gxpara for providing photon-displayable files in parabolic runs
   • gxarrtim for computing flame (or other) arrival times
   • gxusteer for enabling intervention in EARTH execution by way of USTEER=T
   • gxpotflo for for computing velocity components in potential-flow calculations
   • gxresult for display of convergence results at end of calculations

9. Utilities
   • gxutil for miscellaneous utilities