Developer Guide

A Brief Overview of the PyFR Framework

Where to Start

The symbolic link pyfr.scripts.pyfr points to the script pyfr.scripts.main, which is where it all starts! Specifically, the function process_run calls the function _process_common, which in turn calls the function get_solver, returning an Integrator – a composite of a Controller and a Stepper. The Integrator has a method named run, which is then called to run the simulation.

Controller

A Controller acts to advance the simulation in time. Specifically, a Controller has a method named advance_to which advances a System to a specified time. There are three types of physical-time Controller available in PyFR 1.11.0:

pyfr.integrators.std.controllers.StdNoneController[source]
  1. _accept_step (dt, idxcurr, err=None)
  2. _add (*args)
  3. _controller_needs_errest
  4. _get_axnpby_kerns (n, subdims=None)
  5. _get_gndofs ()
  6. _get_kernels (name, nargs, **kwargs)
  7. _get_plugins ()
  8. _init_reg_banks ()
  9. _prepare_reg_banks (*bidxes)
  10. _reject_step (dt, idxold, err=None)
  11. _stepper_has_errest
  12. advance_to (t)[source]
  13. call_plugin_dt (dt)
  14. cfgmeta
  15. collect_stats (stats)
  16. controller_name = 'none'
  17. formulation = 'std'
  18. nsteps
  19. run ()
  20. soln
  21. step (t, dt)
pyfr.integrators.std.controllers.StdPIController[source]
  1. _accept_step (dt, idxcurr, err=None)
  2. _add (*args)
  3. _controller_needs_errest
  4. _errest (x, y, z)[source]
  5. _get_axnpby_kerns (n, subdims=None)
  6. _get_errest_kerns ()[source]
  7. _get_gndofs ()
  8. _get_kernels (name, nargs, **kwargs)
  9. _get_plugins ()
  10. _init_reg_banks ()
  11. _prepare_reg_banks (*bidxes)
  12. _reject_step (dt, idxold, err=None)
  13. _stepper_has_errest
  14. advance_to (t)[source]
  15. call_plugin_dt (dt)
  16. cfgmeta
  17. collect_stats (stats)
  18. controller_name = 'pi'
  19. formulation = 'std'
  20. nsteps
  21. run ()
  22. soln
  23. step (t, dt)
pyfr.integrators.dual.phys.controllers.DualNoneController[source]
  1. _accept_step (idxcurr)
  2. _get_plugins ()
  3. _stepper_coeffs
  4. advance_to (t)[source]
  5. call_plugin_dt (dt)
  6. cfgmeta
  7. collect_stats (stats)
  8. controller_name = 'none'
  9. formulation = 'dual'
  10. nsteps
  11. pseudostepinfo
  12. run ()
  13. soln
  14. step (t, dt)
  15. system

Types of physical-time Controller are related via the following inheritance diagram:

Inheritance diagram of pyfr.integrators.std.controllers, pyfr.integrators.dual.phys.controllers

There are two types of pseudo-time Controller available in PyFR 1.11.0:

pyfr.integrators.dual.pseudo.pseudocontrollers.DualNonePseudoController[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_errest_kerns ()
  4. _get_gndofs ()
  5. _get_kernels (name, nargs, **kwargs)
  6. _init_reg_banks ()
  7. _prepare_reg_banks (*bidxes)
  8. _pseudo_controller_needs_lerrest
  9. _pseudo_stepper_regidx
  10. _resid (dtau, x)
  11. _stepper_regidx
  12. _update_pseudostepinfo (niters, resid)
  13. aux_nregs = 0
  14. convmon (i, minniters)[source]
  15. finalise_pseudo_advance (currsoln)
  16. formulation = 'dual'
  17. pseudo_advance (tcurr)[source]
  18. pseudo_controller_name = 'none'
pyfr.integrators.dual.pseudo.pseudocontrollers.DualPIPseudoController[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_errest_kerns ()
  4. _get_gndofs ()
  5. _get_kernels (name, nargs, **kwargs)
  6. _init_reg_banks ()
  7. _prepare_reg_banks (*bidxes)
  8. _pseudo_controller_needs_lerrest
  9. _pseudo_stepper_regidx
  10. _resid (dtau, x)
  11. _stepper_regidx
  12. _update_pseudostepinfo (niters, resid)
  13. aux_nregs = 0
  14. convmon (i, minniters)[source]
  15. finalise_pseudo_advance (currsoln)
  16. formulation = 'dual'
  17. localerrest (errbank)[source]
  18. pseudo_advance (tcurr)[source]
  19. pseudo_controller_name = 'local-pi'

Types of pseudo-time Controller are related via the following inheritance diagram:

Inheritance diagram of pyfr.integrators.dual.pseudo.pseudocontrollers

Stepper

A Stepper acts to advance the simulation by a single time-step. Specifically, a Stepper has a method named step which advances a System by a single time-step. There are eight types of Stepper available in PyFR 1.11.0:

pyfr.integrators.std.steppers.StdEulerStepper[source]
  1. _add (*args)
  2. _controller_needs_errest
  3. _get_axnpby_kerns (n, subdims=None)
  4. _get_gndofs ()
  5. _get_kernels (name, nargs, **kwargs)
  6. _get_plugins ()
  7. _init_reg_banks ()
  8. _prepare_reg_banks (*bidxes)
  9. _stepper_has_errest
  10. _stepper_nfevals
  11. _stepper_nregs
  12. _stepper_order
  13. advance_to (t)
  14. call_plugin_dt (dt)
  15. cfgmeta
  16. collect_stats (stats)
  17. formulation = 'std'
  18. nsteps
  19. run ()
  20. soln
  21. step (t, dt)[source]
  22. stepper_name = 'euler'
pyfr.integrators.std.steppers.StdRK4Stepper[source]
  1. _add (*args)
  2. _controller_needs_errest
  3. _get_axnpby_kerns (n, subdims=None)
  4. _get_gndofs ()
  5. _get_kernels (name, nargs, **kwargs)
  6. _get_plugins ()
  7. _init_reg_banks ()
  8. _prepare_reg_banks (*bidxes)
  9. _stepper_has_errest
  10. _stepper_nfevals
  11. _stepper_nregs
  12. _stepper_order
  13. advance_to (t)
  14. call_plugin_dt (dt)
  15. cfgmeta
  16. collect_stats (stats)
  17. formulation = 'std'
  18. nsteps
  19. run ()
  20. soln
  21. step (t, dt)[source]
  22. stepper_name = 'rk4'
pyfr.integrators.std.steppers.StdRK34Stepper[source]
  1. _add (*args)
  2. _controller_needs_errest
  3. _get_axnpby_kerns (n, subdims=None)
  4. _get_gndofs ()
  5. _get_kernels (name, nargs, **kwargs)
  6. _get_plugins ()
  7. _init_reg_banks ()
  8. _prepare_reg_banks (*bidxes)
  9. _stepper_has_errest
  10. _stepper_nfevals
  11. _stepper_nregs
  12. _stepper_order
  13. a = [0.32416573882874605, 0.5570978645055429, -0.08605491431272755]
  14. advance_to (t)
  15. b = [0.10407986927510238, 0.6019391368822611, 2.9750900268840206, -2.681109033041384]
  16. bhat = [0.3406814840808433, 0.09091523008632837, 2.866496742725443, -2.298093456892615]
  17. call_plugin_dt (dt)
  18. cfgmeta
  19. collect_stats (stats)
  20. formulation = 'std'
  21. nsteps
  22. run ()
  23. soln
  24. step (t, dt)
  25. stepper_name = 'rk34'
pyfr.integrators.std.steppers.StdRK45Stepper[source]
  1. _add (*args)
  2. _controller_needs_errest
  3. _get_axnpby_kerns (n, subdims=None)
  4. _get_gndofs ()
  5. _get_kernels (name, nargs, **kwargs)
  6. _get_plugins ()
  7. _init_reg_banks ()
  8. _prepare_reg_banks (*bidxes)
  9. _stepper_has_errest
  10. _stepper_nfevals
  11. _stepper_nregs
  12. _stepper_order
  13. a = [0.22502245872571303, 0.5440433129514047, 0.14456824349399464, 0.7866643421983568]
  14. advance_to (t)
  15. b = [0.05122930664033915, 0.3809548257264019, -0.3733525963923833, 0.5925012850263623, 0.34866717899927996]
  16. bhat = [0.13721732210321927, 0.19188076232938728, -0.2292067211595315, 0.6242946765438954, 0.27581396018302956]
  17. call_plugin_dt (dt)
  18. cfgmeta
  19. collect_stats (stats)
  20. formulation = 'std'
  21. nsteps
  22. run ()
  23. soln
  24. step (t, dt)
  25. stepper_name = 'rk45'
pyfr.integrators.std.steppers.StdTVDRK3Stepper[source]
  1. _add (*args)
  2. _controller_needs_errest
  3. _get_axnpby_kerns (n, subdims=None)
  4. _get_gndofs ()
  5. _get_kernels (name, nargs, **kwargs)
  6. _get_plugins ()
  7. _init_reg_banks ()
  8. _prepare_reg_banks (*bidxes)
  9. _stepper_has_errest
  10. _stepper_nfevals
  11. _stepper_nregs
  12. _stepper_order
  13. advance_to (t)
  14. call_plugin_dt (dt)
  15. cfgmeta
  16. collect_stats (stats)
  17. formulation = 'std'
  18. nsteps
  19. run ()
  20. soln
  21. step (t, dt)[source]
  22. stepper_name = 'tvd-rk3'
pyfr.integrators.dual.phys.steppers.DualBDF2Stepper[source]
  1. _get_plugins ()
  2. _stepper_coeffs
  3. _stepper_order
  4. advance_to (t)
  5. call_plugin_dt (dt)
  6. cfgmeta
  7. collect_stats (stats)
  8. formulation = 'dual'
  9. nsteps
  10. pseudostepinfo
  11. run ()
  12. soln
  13. step (t, dt)
  14. stepper_name = 'bdf2'
  15. system
pyfr.integrators.dual.phys.steppers.DualBDF3Stepper[source]
  1. _get_plugins ()
  2. _stepper_coeffs
  3. _stepper_order
  4. advance_to (t)
  5. call_plugin_dt (dt)
  6. cfgmeta
  7. collect_stats (stats)
  8. formulation = 'dual'
  9. nsteps
  10. pseudostepinfo
  11. run ()
  12. soln
  13. step (t, dt)
  14. stepper_name = 'bdf3'
  15. system
pyfr.integrators.dual.phys.steppers.DualBackwardEulerStepper[source]
  1. _get_plugins ()
  2. _stepper_coeffs
  3. _stepper_order
  4. advance_to (t)
  5. call_plugin_dt (dt)
  6. cfgmeta
  7. collect_stats (stats)
  8. formulation = 'dual'
  9. nsteps
  10. pseudostepinfo
  11. run ()
  12. soln
  13. step (t, dt)
  14. stepper_name = 'backward-euler'
  15. system

Types of Stepper are related via the following inheritance diagram:

Inheritance diagram of pyfr.integrators.std.steppers, pyfr.integrators.dual.phys.steppers

PseudoStepper

A PseudoStepper acts to advance the simulation by a single pseudo-time-step. They are used to converge implicit Stepper time-steps via a dual time-stepping formulation. There are six types of PseudoStepper available in PyFR 1.11.0:

pyfr.integrators.dual.pseudo.pseudosteppers.DualDenseRKPseudoStepper[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_gndofs ()
  4. _get_kernels (name, nargs, **kwargs)
  5. _init_reg_banks ()
  6. _prepare_reg_banks (*bidxes)
  7. _pseudo_stepper_nfevals
  8. _pseudo_stepper_regidx
  9. _rhs_with_dts (t, uin, fout)
  10. _stepper_regidx
  11. aux_nregs = 0
  12. collect_stats (stats)
  13. finalise_pseudo_advance (currsoln)
  14. formulation = 'dual'
  15. ntotiters
  16. step (t)[source]
pyfr.integrators.dual.pseudo.pseudosteppers.DualRK4PseudoStepper[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_gndofs ()
  4. _get_kernels (name, nargs, **kwargs)
  5. _init_reg_banks ()
  6. _prepare_reg_banks (*bidxes)
  7. _pseudo_stepper_has_lerrest
  8. _pseudo_stepper_nfevals
  9. _pseudo_stepper_nregs
  10. _pseudo_stepper_order
  11. _pseudo_stepper_regidx
  12. _rhs_with_dts (t, uin, fout)
  13. _stepper_regidx
  14. aux_nregs = 0
  15. collect_stats (stats)
  16. finalise_pseudo_advance (currsoln)
  17. formulation = 'dual'
  18. ntotiters
  19. pseudo_stepper_name = 'rk4'
  20. step (t)[source]
pyfr.integrators.dual.pseudo.pseudosteppers.DualTVDRK3PseudoStepper[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_gndofs ()
  4. _get_kernels (name, nargs, **kwargs)
  5. _init_reg_banks ()
  6. _prepare_reg_banks (*bidxes)
  7. _pseudo_stepper_has_lerrest
  8. _pseudo_stepper_nfevals
  9. _pseudo_stepper_nregs
  10. _pseudo_stepper_order
  11. _pseudo_stepper_regidx
  12. _rhs_with_dts (t, uin, fout)
  13. _stepper_regidx
  14. aux_nregs = 0
  15. collect_stats (stats)
  16. finalise_pseudo_advance (currsoln)
  17. formulation = 'dual'
  18. ntotiters
  19. pseudo_stepper_name = 'tvd-rk3'
  20. step (t)[source]
pyfr.integrators.dual.pseudo.pseudosteppers.DualEulerPseudoStepper[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_gndofs ()
  4. _get_kernels (name, nargs, **kwargs)
  5. _init_reg_banks ()
  6. _prepare_reg_banks (*bidxes)
  7. _pseudo_stepper_has_lerrest
  8. _pseudo_stepper_nfevals
  9. _pseudo_stepper_nregs
  10. _pseudo_stepper_order
  11. _pseudo_stepper_regidx
  12. _rhs_with_dts (t, uin, fout)
  13. _stepper_regidx
  14. aux_nregs = 0
  15. collect_stats (stats)
  16. finalise_pseudo_advance (currsoln)
  17. formulation = 'dual'
  18. ntotiters
  19. pseudo_stepper_name = 'euler'
  20. step (t)[source]
pyfr.integrators.dual.pseudo.pseudosteppers.DualRK34PseudoStepper[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_gndofs ()
  4. _get_kernels (name, nargs, **kwargs)
  5. _init_reg_banks ()
  6. _prepare_reg_banks (*bidxes)
  7. _pseudo_stepper_has_lerrest
  8. _pseudo_stepper_nfevals
  9. _pseudo_stepper_nregs
  10. _pseudo_stepper_order
  11. _pseudo_stepper_regidx
  12. _rhs_with_dts (t, uin, fout)
  13. _stepper_regidx
  14. a = [0.32416573882874605, 0.5570978645055429, -0.08605491431272755]
  15. aux_nregs = 0
  16. b = [0.10407986927510238, 0.6019391368822611, 2.9750900268840206, -2.681109033041384]
  17. bhat = [0.3406814840808433, 0.09091523008632837, 2.866496742725443, -2.298093456892615]
  18. collect_stats (stats)
  19. finalise_pseudo_advance (currsoln)
  20. formulation = 'dual'
  21. localdtau (uinbank, inv=0)
  22. ntotiters
  23. pseudo_stepper_name = 'rk34'
  24. step (t)
pyfr.integrators.dual.pseudo.pseudosteppers.DualRK45PseudoStepper[source]
  1. _add (*args)
  2. _get_axnpby_kerns (n, subdims=None)
  3. _get_gndofs ()
  4. _get_kernels (name, nargs, **kwargs)
  5. _init_reg_banks ()
  6. _prepare_reg_banks (*bidxes)
  7. _pseudo_stepper_has_lerrest
  8. _pseudo_stepper_nfevals
  9. _pseudo_stepper_nregs
  10. _pseudo_stepper_order
  11. _pseudo_stepper_regidx
  12. _rhs_with_dts (t, uin, fout)
  13. _stepper_regidx
  14. a = [0.22502245872571303, 0.5440433129514047, 0.14456824349399464, 0.7866643421983568]
  15. aux_nregs = 0
  16. b = [0.05122930664033915, 0.3809548257264019, -0.3733525963923833, 0.5925012850263623, 0.34866717899927996]
  17. bhat = [0.13721732210321927, 0.19188076232938728, -0.2292067211595315, 0.6242946765438954, 0.27581396018302956]
  18. collect_stats (stats)
  19. finalise_pseudo_advance (currsoln)
  20. formulation = 'dual'
  21. localdtau (uinbank, inv=0)
  22. ntotiters
  23. pseudo_stepper_name = 'rk45'
  24. step (t)

Note that DualDenseRKPseudoStepper includes families of PseudoStepper whose coefficients are read from .txt files named thus:

{scheme name}-s{stage count}-p{temporal order}-sp{optimal spatial polynomial order}.txt

Types of PseudoStepper are related via the following inheritance diagram:

Inheritance diagram of pyfr.integrators.dual.pseudo.pseudosteppers

System

A System holds information/data for the system, including Elements, Interfaces, and the Backend with which the simulation is to run. A System has a method named rhs, which obtains the divergence of the flux (the ‘right-hand-side’) at each solution point. The method rhs invokes various kernels which have been pre-generated and loaded into queues. A System also has a method named _gen_kernels which acts to generate all the kernels required by a particular System. A kernel is an instance of a ‘one-off’ class with a method named run that implements the required kernel functionality. Individual kernels are produced by a kernel provider. PyFR 1.11.0 has various types of kernel provider. A Pointwise Kernel Provider produces point-wise kernels such as Riemann solvers and flux functions etc. These point-wise kernels are specified using an in-built platform-independent templating language derived from Mako, henceforth referred to as PyFR-Mako. There are four types of System available in PyFR 1.11.0:

pyfr.solvers.aceuler.system.ACEulerSystem[source]
  1. _gen_kernels (eles, iint, mpiint, bcint)
  2. _gen_queues ()
  3. _load_bc_inters (rallocs, mesh, elemap)
  4. _load_eles (rallocs, mesh, initsoln, nregs, nonce)
  5. _load_int_inters (rallocs, mesh, elemap)
  6. _load_mpi_inters (rallocs, mesh, elemap)
  7. _nonce_seq = count(0)
  8. _nqueues = 2
  9. bbcinterscls
  10. ele_scal_upts (idx)
  11. elementscls
  12. filt (uinoutbank)
  13. intinterscls
  14. mpiinterscls
  15. name = 'ac-euler'
  16. rhs (t, uinbank, foutbank)
pyfr.solvers.acnavstokes.system.ACNavierStokesSystem[source]
  1. _gen_kernels (eles, iint, mpiint, bcint)
  2. _gen_queues ()
  3. _load_bc_inters (rallocs, mesh, elemap)
  4. _load_eles (rallocs, mesh, initsoln, nregs, nonce)
  5. _load_int_inters (rallocs, mesh, elemap)
  6. _load_mpi_inters (rallocs, mesh, elemap)
  7. _nonce_seq = count(0)
  8. _nqueues = 2
  9. bbcinterscls
  10. ele_scal_upts (idx)
  11. elementscls
  12. filt (uinoutbank)
  13. intinterscls
  14. mpiinterscls
  15. name = 'ac-navier-stokes'
  16. rhs (t, uinbank, foutbank)
pyfr.solvers.euler.system.EulerSystem[source]
  1. _gen_kernels (eles, iint, mpiint, bcint)
  2. _gen_queues ()
  3. _load_bc_inters (rallocs, mesh, elemap)
  4. _load_eles (rallocs, mesh, initsoln, nregs, nonce)
  5. _load_int_inters (rallocs, mesh, elemap)
  6. _load_mpi_inters (rallocs, mesh, elemap)
  7. _nonce_seq = count(0)
  8. _nqueues = 2
  9. bbcinterscls
  10. ele_scal_upts (idx)
  11. elementscls
  12. filt (uinoutbank)
  13. intinterscls
  14. mpiinterscls
  15. name = 'euler'
  16. rhs (t, uinbank, foutbank)
pyfr.solvers.navstokes.system.NavierStokesSystem[source]
  1. _gen_kernels (eles, iint, mpiint, bcint)
  2. _gen_queues ()
  3. _load_bc_inters (rallocs, mesh, elemap)
  4. _load_eles (rallocs, mesh, initsoln, nregs, nonce)
  5. _load_int_inters (rallocs, mesh, elemap)
  6. _load_mpi_inters (rallocs, mesh, elemap)
  7. _nonce_seq = count(0)
  8. _nqueues = 2
  9. bbcinterscls
  10. ele_scal_upts (idx)
  11. elementscls
  12. filt (uinoutbank)
  13. intinterscls
  14. mpiinterscls
  15. name = 'navier-stokes'
  16. rhs (t, uinbank, foutbank)

Types of System are related via the following inheritance diagram:

Inheritance diagram of pyfr.solvers.navstokes.system, pyfr.solvers.euler.system, pyfr.solvers.acnavstokes.system, pyfr.solvers.aceuler.system

Elements

An Elements holds information/data for a group of elements. There are four types of Elements available in PyFR 1.11.0:

pyfr.solvers.aceuler.elements.ACEulerElements[source]
  1. _gen_pnorm_fpts ()
  2. _mag_pnorm_fpts = None
  3. _mesh_regions
  4. _norm_pnorm_fpts = None
  5. _ploc_in_src_exprs = None
  6. _scratch_bufs
  7. _slice_mat (mat, region, ra=None, rb=None)
  8. _smats_djacs_mpts = None
  9. _soln_in_src_exprs = None
  10. _src_exprs = None
  11. _srtd_face_fpts = None
  12. con_to_pri (convs, cfg)
  13. convarmap = {2: ['p', 'u', 'v'], 3: ['p', 'u', 'v', 'w']}
  14. dualcoeffs = {2: ['u', 'v'], 3: ['u', 'v', 'w']}
  15. formulations = ['dual']
  16. get_mag_pnorms (eidx, fidx)
  17. get_mag_pnorms_for_inter (eidx, fidx)
  18. get_norm_pnorms (eidx, fidx)
  19. get_norm_pnorms_for_inter (eidx, fidx)
  20. get_ploc_for_inter (eidx, fidx)
  21. get_scal_fpts_for_inter (eidx, fidx)
  22. get_vect_fpts_for_inter (eidx, fidx)
  23. opmat (expr)
  24. ploc_at (name, side=None)
  25. ploc_at_np (name)
  26. plocfpts = None
  27. pri_to_con (pris, cfg)
  28. privarmap = {2: ['p', 'u', 'v'], 3: ['p', 'u', 'v', 'w']}
  29. qpts = None
  30. rcpdjac_at (name, side=None)
  31. rcpdjac_at_np (name)
  32. set_backend (*args, **kwargs)[source]
  33. set_ics_from_cfg ()
  34. set_ics_from_soln (solnmat, solncfg)
  35. sliceat (fn)
  36. smat_at (name, side=None)
  37. smat_at_np (name)
  38. upts = None
  39. visvarmap = {2: [('velocity', ['u', 'v']), ('pressure', ['p'])], 3: [('velocity', ['u', 'v', 'w']), ('pressure', ['p'])]}
pyfr.solvers.acnavstokes.elements.ACNavierStokesElements[source]
  1. _gen_pnorm_fpts ()
  2. _mag_pnorm_fpts = None
  3. _mesh_regions
  4. _norm_pnorm_fpts = None
  5. _ploc_in_src_exprs = None
  6. _scratch_bufs
  7. _slice_mat (mat, region, ra=None, rb=None)
  8. _smats_djacs_mpts = None
  9. _soln_in_src_exprs = None
  10. _src_exprs = None
  11. _srtd_face_fpts = None
  12. con_to_pri (convs, cfg)
  13. convarmap = {2: ['p', 'u', 'v'], 3: ['p', 'u', 'v', 'w']}
  14. dualcoeffs = {2: ['u', 'v'], 3: ['u', 'v', 'w']}
  15. formulations = ['dual']
  16. get_artvisc_fpts_for_inter (eidx, fidx)
  17. get_mag_pnorms (eidx, fidx)
  18. get_mag_pnorms_for_inter (eidx, fidx)
  19. get_norm_pnorms (eidx, fidx)
  20. get_norm_pnorms_for_inter (eidx, fidx)
  21. get_ploc_for_inter (eidx, fidx)
  22. get_scal_fpts_for_inter (eidx, fidx)
  23. get_vect_fpts_for_inter (eidx, fidx)
  24. opmat (expr)
  25. ploc_at (name, side=None)
  26. ploc_at_np (name)
  27. plocfpts = None
  28. pri_to_con (pris, cfg)
  29. privarmap = {2: ['p', 'u', 'v'], 3: ['p', 'u', 'v', 'w']}
  30. qpts = None
  31. rcpdjac_at (name, side=None)
  32. rcpdjac_at_np (name)
  33. set_backend (*args, **kwargs)[source]
  34. set_ics_from_cfg ()
  35. set_ics_from_soln (solnmat, solncfg)
  36. sliceat (fn)
  37. smat_at (name, side=None)
  38. smat_at_np (name)
  39. upts = None
  40. visvarmap = {2: [('velocity', ['u', 'v']), ('pressure', ['p'])], 3: [('velocity', ['u', 'v', 'w']), ('pressure', ['p'])]}
pyfr.solvers.euler.elements.EulerElements[source]
  1. _gen_pnorm_fpts ()
  2. _mag_pnorm_fpts = None
  3. _mesh_regions
  4. _norm_pnorm_fpts = None
  5. _ploc_in_src_exprs = None
  6. _scratch_bufs
  7. _slice_mat (mat, region, ra=None, rb=None)
  8. _smats_djacs_mpts = None
  9. _soln_in_src_exprs = None
  10. _src_exprs = None
  11. _srtd_face_fpts = None
  12. con_to_pri (cons, cfg)
  13. convarmap = {2: ['rho', 'rhou', 'rhov', 'E'], 3: ['rho', 'rhou', 'rhov', 'rhow', 'E']}
  14. dualcoeffs = {2: ['rho', 'rhou', 'rhov', 'E'], 3: ['rho', 'rhou', 'rhov', 'rhow', 'E']}
  15. formulations = ['std', 'dual']
  16. get_mag_pnorms (eidx, fidx)
  17. get_mag_pnorms_for_inter (eidx, fidx)
  18. get_norm_pnorms (eidx, fidx)
  19. get_norm_pnorms_for_inter (eidx, fidx)
  20. get_ploc_for_inter (eidx, fidx)
  21. get_scal_fpts_for_inter (eidx, fidx)
  22. get_vect_fpts_for_inter (eidx, fidx)
  23. opmat (expr)
  24. ploc_at (name, side=None)
  25. ploc_at_np (name)
  26. plocfpts = None
  27. pri_to_con (pris, cfg)
  28. privarmap = {2: ['rho', 'u', 'v', 'p'], 3: ['rho', 'u', 'v', 'w', 'p']}
  29. qpts = None
  30. rcpdjac_at (name, side=None)
  31. rcpdjac_at_np (name)
  32. set_backend (*args, **kwargs)[source]
  33. set_ics_from_cfg ()
  34. set_ics_from_soln (solnmat, solncfg)
  35. sliceat (fn)
  36. smat_at (name, side=None)
  37. smat_at_np (name)
  38. upts = None
  39. visvarmap = {2: [('density', ['rho']), ('velocity', ['u', 'v']), ('pressure', ['p'])], 3: [('density', ['rho']), ('velocity', ['u', 'v', 'w']), ('pressure', ['p'])]}
pyfr.solvers.navstokes.elements.NavierStokesElements[source]
  1. _gen_pnorm_fpts ()
  2. _mag_pnorm_fpts = None
  3. _mesh_regions
  4. _norm_pnorm_fpts = None
  5. _ploc_in_src_exprs = None
  6. _scratch_bufs
  7. _slice_mat (mat, region, ra=None, rb=None)
  8. _smats_djacs_mpts = None
  9. _soln_in_src_exprs = None
  10. _src_exprs = None
  11. _srtd_face_fpts = None
  12. con_to_pri (cons, cfg)
  13. convarmap = {2: ['rho', 'rhou', 'rhov', 'E'], 3: ['rho', 'rhou', 'rhov', 'rhow', 'E']}
  14. dualcoeffs = {2: ['rho', 'rhou', 'rhov', 'E'], 3: ['rho', 'rhou', 'rhov', 'rhow', 'E']}
  15. formulations = ['std', 'dual']
  16. get_artvisc_fpts_for_inter (eidx, fidx)
  17. get_mag_pnorms (eidx, fidx)
  18. get_mag_pnorms_for_inter (eidx, fidx)
  19. get_norm_pnorms (eidx, fidx)
  20. get_norm_pnorms_for_inter (eidx, fidx)
  21. get_ploc_for_inter (eidx, fidx)
  22. get_scal_fpts_for_inter (eidx, fidx)
  23. get_vect_fpts_for_inter (eidx, fidx)
  24. opmat (expr)
  25. ploc_at (name, side=None)
  26. ploc_at_np (name)
  27. plocfpts = None
  28. pri_to_con (pris, cfg)
  29. privarmap = {2: ['rho', 'u', 'v', 'p'], 3: ['rho', 'u', 'v', 'w', 'p']}
  30. qpts = None
  31. rcpdjac_at (name, side=None)
  32. rcpdjac_at_np (name)
  33. set_backend (*args, **kwargs)[source]
  34. set_ics_from_cfg ()
  35. set_ics_from_soln (solnmat, solncfg)
  36. shockvar = 'rho'
  37. sliceat (fn)
  38. smat_at (name, side=None)
  39. smat_at_np (name)
  40. upts = None
  41. visvarmap = {2: [('density', ['rho']), ('velocity', ['u', 'v']), ('pressure', ['p'])], 3: [('density', ['rho']), ('velocity', ['u', 'v', 'w']), ('pressure', ['p'])]}

Types of Elements are related via the following inheritance diagram:

Inheritance diagram of pyfr.solvers.navstokes.elements, pyfr.solvers.euler.elements, pyfr.solvers.acnavstokes.elements, pyfr.solvers.aceuler.elements

Interfaces

An Interfaces holds information/data for a group of interfaces. There are eight types of (non-boundary) Interfaces available in PyFR 1.11.0:

pyfr.solvers.aceuler.inters.ACEulerIntInters[source]
  1. _const_mat (inter, meth)
  2. _gen_perm (lhs, rhs)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)
pyfr.solvers.aceuler.inters.ACEulerMPIInters[source]
  1. MPI_TAG = 2314
  2. _const_mat (inter, meth)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)
pyfr.solvers.acnavstokes.inters.ACNavierStokesIntInters[source]
  1. _const_mat (inter, meth)
  2. _gen_perm (lhs, rhs)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)
pyfr.solvers.acnavstokes.inters.ACNavierStokesMPIInters[source]
  1. MPI_TAG = 2314
  2. _const_mat (inter, meth)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)
pyfr.solvers.euler.inters.EulerIntInters[source]
  1. _const_mat (inter, meth)
  2. _gen_perm (lhs, rhs)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)
pyfr.solvers.euler.inters.EulerMPIInters[source]
  1. MPI_TAG = 2314
  2. _const_mat (inter, meth)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)
pyfr.solvers.navstokes.inters.NavierStokesIntInters[source]
  1. _const_mat (inter, meth)
  2. _gen_perm (lhs, rhs)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)
pyfr.solvers.navstokes.inters.NavierStokesMPIInters[source]
  1. MPI_TAG = 2314
  2. _const_mat (inter, meth)
  3. _scal_view (inter, meth)
  4. _scal_xchg_view (inter, meth)
  5. _set_external (name, spec, value=None)
  6. _vect_view (inter, meth)
  7. _vect_xchg_view (inter, meth)
  8. _view (inter, meth, vshape=())
  9. _xchg_view (inter, meth, vshape=())
  10. prepare (t)

Types of (non-boundary) Interfaces are related via the following inheritance diagram:

Inheritance diagram of pyfr.solvers.navstokes.inters.NavierStokesMPIInters, pyfr.solvers.navstokes.inters.NavierStokesIntInters, pyfr.solvers.euler.inters.EulerMPIInters, pyfr.solvers.euler.inters.EulerIntInters, pyfr.solvers.acnavstokes.inters.ACNavierStokesMPIInters, pyfr.solvers.acnavstokes.inters.ACNavierStokesIntInters, pyfr.solvers.aceuler.inters.ACEulerMPIInters, pyfr.solvers.aceuler.inters.ACEulerIntInters

Backend

A Backend holds information/data for a backend. There are four types of Backend available in PyFR 1.11.0:

pyfr.backends.cuda.base.CUDABackend[source]
  1. _malloc_impl (nbytes)[source]
  2. alias (obj, aobj)
  3. commit ()
  4. const_matrix (initval, extent=None, tags=set())
  5. kernel (name, *args, **kwargs)
  6. lookup = None
  7. malloc (obj, extent)
  8. matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  9. matrix_bank (mats, initbank=0, tags=set())
  10. matrix_slice (mat, ra, rb, ca, cb)
  11. name = 'cuda'
  12. queue ()
  13. runall (sequence)
  14. view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())
  15. xchg_matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  16. xchg_matrix_for_view (view, tags=set())
  17. xchg_view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())
pyfr.backends.hip.base.HIPBackend[source]
  1. _malloc_impl (nbytes)[source]
  2. alias (obj, aobj)
  3. commit ()
  4. const_matrix (initval, extent=None, tags=set())
  5. kernel (name, *args, **kwargs)
  6. lookup = None
  7. malloc (obj, extent)
  8. matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  9. matrix_bank (mats, initbank=0, tags=set())
  10. matrix_slice (mat, ra, rb, ca, cb)
  11. name = 'hip'
  12. queue ()
  13. runall (sequence)
  14. view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())
  15. xchg_matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  16. xchg_matrix_for_view (view, tags=set())
  17. xchg_view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())
pyfr.backends.opencl.base.OpenCLBackend[source]
  1. _malloc_impl (nbytes)[source]
  2. alias (obj, aobj)
  3. commit ()
  4. const_matrix (initval, extent=None, tags=set())
  5. kernel (name, *args, **kwargs)
  6. lookup = None
  7. malloc (obj, extent)
  8. matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  9. matrix_bank (mats, initbank=0, tags=set())
  10. matrix_slice (mat, ra, rb, ca, cb)
  11. name = 'opencl'
  12. queue ()
  13. runall (sequence)
  14. view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())
  15. xchg_matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  16. xchg_matrix_for_view (view, tags=set())
  17. xchg_view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())
pyfr.backends.openmp.base.OpenMPBackend[source]
  1. _malloc_impl (nbytes)[source]
  2. alias (obj, aobj)
  3. commit ()
  4. const_matrix (initval, extent=None, tags=set())
  5. kernel (name, *args, **kwargs)
  6. lookup = None
  7. malloc (obj, extent)
  8. matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  9. matrix_bank (mats, initbank=0, tags=set())
  10. matrix_slice (mat, ra, rb, ca, cb)
  11. name = 'openmp'
  12. queue ()
  13. runall (sequence)
  14. view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())
  15. xchg_matrix (ioshape, initval=None, extent=None, aliases=None, tags=set())
  16. xchg_matrix_for_view (view, tags=set())
  17. xchg_view (matmap, rmap, cmap, rstridemap=None, vshape=(), tags=set())

Types of Backend are related via the following inheritance diagram:

Inheritance diagram of pyfr.backends.cuda.base, pyfr.backends.hip.base, pyfr.backends.opencl.base, pyfr.backends.openmp.base

Pointwise Kernel Provider

A Pointwise Kernel Provider produces point-wise kernels. Specifically, a Pointwise Kernel Provider has a method named register, which adds a new method to an instance of a Pointwise Kernel Provider. This new method, when called, returns a kernel. A kernel is an instance of a ‘one-off’ class with a method named run that implements the required kernel functionality. The kernel functionality itself is specified using PyFR-Mako. Hence, a Pointwise Kernel Provider also has a method named _render_kernel, which renders PyFR-Mako into low-level platform-specific code. The _render_kernel method first sets the context for Mako (i.e. details about the Backend etc.) and then uses Mako to begin rendering the PyFR-Mako specification. When Mako encounters a pyfr:kernel an instance of a Kernel Generator is created, which is used to render the body of the pyfr:kernel. There are four types of Pointwise Kernel Provider available in PyFR 1.11.0:

pyfr.backends.cuda.provider.CUDAPointwiseKernelProvider[source]
  1. _build_arglst (dims, argn, argt, argdict)
  2. _build_kernel (name, src, argtypes)
  3. _instantiate_kernel (dims, fun, arglst)[source]
  4. _render_kernel (name, mod, extrns, tplargs)
  5. kernel_generator_cls
  6. register (mod)
pyfr.backends.hip.provider.HIPPointwiseKernelProvider[source]
  1. _build_arglst (dims, argn, argt, argdict)
  2. _build_kernel (name, src, argtypes)
  3. _instantiate_kernel (dims, fun, arglst)[source]
  4. _render_kernel (name, mod, extrns, tplargs)
  5. kernel_generator_cls
  6. register (mod)
pyfr.backends.opencl.provider.OpenCLPointwiseKernelProvider[source]
  1. _build_arglst (dims, argn, argt, argdict)
  2. _build_kernel (name, src, argtypes)
  3. _instantiate_kernel (dims, fun, arglst)[source]
  4. _render_kernel (name, mod, extrns, tplargs)
  5. kernel_generator_cls
  6. register (mod)
pyfr.backends.openmp.provider.OpenMPPointwiseKernelProvider[source]
  1. _build_arglst (dims, argn, argt, argdict)
  2. _build_kernel (name, src, argtypes, restype=None)
  3. _instantiate_kernel (dims, fun, arglst)[source]
  4. _render_kernel (name, mod, extrns, tplargs)
  5. kernel_generator_cls
  6. register (mod)

Types of Pointwise Kernel Provider are related via the following inheritance diagram:

Inheritance diagram of pyfr.backends.openmp.provider, pyfr.backends.cuda.provider, pyfr.backends.hip.provider, pyfr.backends.opencl.provider, pyfr.backends.base.kernels.BasePointwiseKernelProvider

Kernel Generator

A Kernel Generator renders the PyFR-Mako in a pyfr:kernel into low-level platform-specific code. Specifically, a Kernel Generator has a method named render, which applies Backend specific regex and adds Backend specific ‘boiler plate’ code to produce the low-level platform-specific source – which is compiled, linked, and loaded. There are four types of Kernel Generator available in PyFR 1.11.0:

pyfr.backends.cuda.generator.CUDAKernelGenerator[source]
  1. _deref_arg_array_1d (arg)
  2. _deref_arg_array_2d (arg)
  3. _deref_arg_view (arg)
  4. _render_body (body)
  5. _render_spec ()[source]
  6. argspec ()
  7. needs_ldim (arg)
  8. render ()[source]
pyfr.backends.hip.generator.HIPKernelGenerator[source]
  1. _deref_arg_array_1d (arg)
  2. _deref_arg_array_2d (arg)
  3. _deref_arg_view (arg)
  4. _render_body (body)
  5. _render_spec ()[source]
  6. argspec ()
  7. needs_ldim (arg)
  8. render ()[source]
pyfr.backends.opencl.generator.OpenCLKernelGenerator[source]
  1. _deref_arg_array_1d (arg)
  2. _deref_arg_array_2d (arg)
  3. _deref_arg_view (arg)
  4. _render_body (body)
  5. _render_spec ()[source]
  6. argspec ()
  7. needs_ldim (arg)
  8. render ()[source]
pyfr.backends.openmp.generator.OpenMPKernelGenerator[source]
  1. _deref_arg_array_1d (arg)
  2. _deref_arg_array_2d (arg)
  3. _deref_arg_view (arg)
  4. _render_body (body)
  5. _render_spec ()[source]
  6. argspec ()
  7. needs_ldim (arg)
  8. render ()[source]

Types of Kernel Generator are related via the following inheritance diagram:

Inheritance diagram of pyfr.backends.cuda.generator.CUDAKernelGenerator, pyfr.backends.hip.generator.HIPKernelGenerator, pyfr.backends.opencl.generator.OpenCLKernelGenerator, pyfr.backends.openmp.generator.OpenMPKernelGenerator

PyFR-Mako

PyFR-Mako Kernels

PyFR-Mako kernels are specifications of point-wise functionality that can be invoked directly from within PyFR. They are opened with a header of the form:

<%pyfr:kernel name='kernel-name' ndim='data-dimensionality' [argument-name='argument-intent argument-attribute argument-data-type' ...]>

where

  1. kernel-name — name of kernel

    string

  2. data-dimensionality — dimensionality of data

    int

  3. argument-name — name of argument

    string

  4. argument-intent — intent of argument

    in | out | inout

  5. argument-attribute — attribute of argument

    mpi | scalar | view

  6. argument-data-type — data type of argument

    string

and are closed with a footer of the form:

</%pyfr:kernel>
PyFR-Mako Macros

PyFR-Mako macros are specifications of point-wise functionality that cannot be invoked directly from within PyFR, but can be embedded into PyFR-Mako kernels. PyFR-Mako macros can be viewed as building blocks for PyFR-mako kernels. They are opened with a header of the form:

<%pyfr:macro name='macro-name' params='[parameter-name, ...]'>

where

  1. macro-name — name of macro

    string

  2. parameter-name — name of parameter

    string

and are closed with a footer of the form:

</%pyfr:macro>

PyFR-Mako macros are embedded within a kernel using an expression of the following form:

${pyfr.expand('macro-name', ['parameter-name', ...])};

where

  1. macro-name — name of the macro

    string

  2. parameter-name — name of parameter

    string

Syntax

Basic Functionality

Basic functionality can be expressed using a restricted subset of the C programming language. Specifically, use of the following is allowed:

  1. +,-,*,/ — basic arithmetic
  2. sin, cos, tan — basic trigonometric functions
  3. exp — exponential
  4. pow — power
  5. fabs — absolute value
  6. output = ( condition ? satisfied : unsatisfied ) — ternary if
  7. min — minimum
  8. max — maximum

However, conditional if statements, as well as for/while loops, are not allowed.

Expression Substitution

Mako expression substitution can be used to facilitate PyFR-Mako kernel specification. A Python expression expression prescribed thus ${expression} is substituted for the result when the PyFR-Mako kernel specification is interpreted at runtime.

Example:

E = s[${ndims - 1}]

Conditionals

Mako conditionals can be used to facilitate PyFR-Mako kernel specification. Conditionals are opened with % if condition: and closed with % endif. Note that such conditionals are evaluated when the PyFR-Mako kernel specification is interpreted at runtime, they are not embedded into the low-level kernel.

Example:

% if ndims == 2:
    fout[0][1] += t_xx;     fout[1][1] += t_xy;
    fout[0][2] += t_xy;     fout[1][2] += t_yy;
    fout[0][3] += u*t_xx + v*t_xy + ${-c['mu']*c['gamma']/c['Pr']}*T_x;
    fout[1][3] += u*t_xy + v*t_yy + ${-c['mu']*c['gamma']/c['Pr']}*T_y;
% endif

Loops

Mako loops can be used to facilitate PyFR-Mako kernel specification. Loops are opened with % for condition: and closed with % endfor. Note that such loops are unrolled when the PyFR-Mako kernel specification is interpreted at runtime, they are not embedded into the low-level kernel.

Example:

% for i in range(ndims):
    rhov[${i}] = s[${i + 1}];
    v[${i}] = invrho*rhov[${i}];
% endfor

Latest Release

PyFR 1.11.0:

  • Added native HIP backend for targeting AMD GPUs.
  • Rewritten CUDA backend which no longer depends on PyCUDA.
  • Updated defaults for CUDA backend to improve out of the box performance.

Twitter