foamToC.C File Reference

Run-time selection table of contents printing and interrogation. More...

Go to the source code of this file.

Detailed Description

Run-time selection table of contents printing and interrogation.

Original source file foamToC.C

The run-time selection tables are populated by the optionally specified solver class and any additional libraries listed in the -libs option or all libraries using the -allLibs option. Once populated the tables can be searched and printed by a range of options listed below. Table entries are printed with the corresponding library they are in to aid selection and the addition of libs entries to ensure availability to the solver.

Usage

foamToC [OPTION]

-noLibs

Load only the core libOpenFOAM.so library by default

• -libs '("lib1.so" ... "libN.so")'

  Pre-load additional libraries

• -solvers <name>

  List solvers

• -solver <name>

  Load libraries associated with specified solver

• -listLibs

  List libraries as they are loaded

• switches,

  List all available debug, info and optimisation switches

• all,

  List the contents of all the run-time selection tables

• tables

  List the run-time selection table names (this is the default action)

• table <name>

  List the contents of the specified table or the list sub-tables

• search <name> or "<regular expression>"

  Search for and list the tables containing the given name or all matches to the given regular expression

• scalarBCs,

  List scalar field boundary conditions (fvPatchField<scalar>)

• vectorBCs,

  List vector field boundary conditions (fvPatchField<vector>)

• functionObjects,

  List functionObjects

• fvModels,

  List fvModels

• fvConstraints,

  List fvConstraints

  Example usage:
• Print the list of solvers

          foamToC -solvers

• Print the list of scalar boundary conditions (fvPatchField<scalar>) provided by the fluid solver without additional libraries:

          foamToC -solver fluid -scalarBCs

• Print the list of RAS momentum transport models provided by the fluid solver:

          foamToC -solver fluid -table RAScompressibleMomentumTransportModel

• Print the list of functionObjects provided by the multicomponentFluid solver with the libfieldFunctionObjects.so library:

          foamToC -solver multicomponentFluid \
              -libs '("libfieldFunctionObjects.so")' -functionObjects

• Print a complete list of all run-time selection tables:

          foamToC -tables
          or simply
          foamToC

• Print a complete list of all entries in all run-time selection tables:

          foamToC -all

Definition in file foamToC.C.