The cape.pyfun module

The cape.pyfun module contains the top-level interface for FUN3D setup, execution, and post-processing. It loads some of the most important methods from the various submodules so that they are easier to access. Most tasks using the pyFun API can be accessed by loading this module and reading one instance of the cape.pyfun.cntl.Cntl class.

import cape.pyfun

For example the following will read in a global settings instance assuming that the present working directory contains the correct files. (If not, various defaults will be used, but it is unlikely that the resulting setup will be what you intended.)

import cape.pyfun
cntl = cape.pyfun.Cntl()

Most of the pyFun submodules essentially contain a single class definition, which is derived from a similarly named cape module. For example, cape.pyfun.dataBook.DBComp is subclassed to cape.cfdx.dataBook.DBComp, but several functions are edited because their functionality needs customization for FUN3D. For example, reading iterative force & moment histories require a customized method for each solver.

The following classes are imported in this module, so that code like cape.pyfun.Cntl will work (although cape.pyfun.cntl.Cntl will also work).

Modules included within this one are outlined below.

The following lists the pyFun submodules, which contain the main functionality and define the classes that are the workhorses of pyFun.