Package PyFoam

source code

Utility-classes for OpenFOAM

Module for the Execution of OpenFOAM-commands and processing their output

Submodules

[hide private]

PyFoam.Applications: Application-Classes
- PyFoam.Applications.APoMaFoXiiQt: Application-class that implements pyFoamAPoMaFoX.py (A Poor Man's FoamX)
- PyFoam.Applications.AddCaseDataToDatabase: Application-class that implements pyFoamAddCaseDataToDatabase.py
- PyFoam.Applications.Benchmark: Class that implements pyFoamBenchmark
- PyFoam.Applications.BinarySize: Application-class that implements pyFoamBinarySize.py
- PyFoam.Applications.BlockMeshRewrite: Application-class that implements pyFoamBlockMeshRewrite.py
- PyFoam.Applications.BuildHelper: Application class that implements pyFoamBuildHelper
- PyFoam.Applications.CaseBuilder: Application-class that implements pyFoamCaseBuilder.py
- PyFoam.Applications.CaseBuilderBackend: Represents the actual CaseBuilder-File and other things that have to do with the Casebuilder
- PyFoam.Applications.CaseReport: Application class that implements pyFoamCasedReport.py
- PyFoam.Applications.ChangeBoundaryName: Application class that implements pyFoamChangeBoundaryName.py
- PyFoam.Applications.ChangeBoundaryType: Application class that implements pyFoamChangeBoundaryType.py
- PyFoam.Applications.ClearBoundaryValue: Application class that implements pyFoamClearBoundaryValue.py
- PyFoam.Applications.ClearCase: Application-class that implements pyFoamClearCase.py
- PyFoam.Applications.ClearInternalField: Application class that implements pyFoamClearInternalField.py
- PyFoam.Applications.CloneCase: Application-class that implements pyFoamCloneCase.py
- PyFoam.Applications.ClusterTester: Application class that implements pyFoamClusterTester
- PyFoam.Applications.CommonCaseBuilder: Class that implements the common functionality for CaseBuilder-applications
- PyFoam.Applications.CommonClearCase: Class that implements the common functionality for clearing the cases
- PyFoam.Applications.CommonLibFunctionTrigger: Implements a trigger that removes the libs and/or function entry from the controlDict
- PyFoam.Applications.CommonMultiRegion: Class that implements the common functionality for cases with multiple regions
- PyFoam.Applications.CommonParallel: Class that implements the common functionality for running cases in parallel
- PyFoam.Applications.CommonParserOptions: Class that implements the common functionality for passing options to the parser
- PyFoam.Applications.CommonPickledDataInput: Class that implements reading vom a pickled file.
- PyFoam.Applications.CommonPlotLines: Class that implements common functionality for collecting plot-lines
- PyFoam.Applications.CommonPlotOptions: Class that implements common functionality for plotting options
- PyFoam.Applications.CommonPrePostHooks: Class that implements the common functionality for executing hooks before and after the running of the solver
- PyFoam.Applications.CommonReadWriteCSV: Class that implements the common functionality for reading and writing CSV-files
- PyFoam.Applications.CommonReportRunnerData: Class that implements the common functionality for reporting the data that was submitted to the runner
- PyFoam.Applications.CommonReportUsage: Class that implements the common functionality for reporting the usage of a run
- PyFoam.Applications.CommonRestart: Class that implements the common functionality for restarting cases
- PyFoam.Applications.CommonSafeTrigger: Implements a trigger that sets and resets 'safer' settings for Steady runs
- PyFoam.Applications.CommonSelectTimesteps: Class that implements common functionality for selecting timesteps
- PyFoam.Applications.CommonServer: Class that implements the common functionality for having a server
- PyFoam.Applications.CommonStandardOutput: Class that implements the common functionality for treatment of the standard output
- PyFoam.Applications.CommonTemplateBehaviour: Common class with options that describe the behaviour of the template parser
- PyFoam.Applications.CommonTemplateFormat: Class that implements the common functionality for the format of templates
- PyFoam.Applications.CommonVCSCommit: Class that implements the common functionality commiting cases to the VCS
- PyFoam.Applications.CommonWriteAllTrigger: Implements a trigger that manipulates the controlDict in such a way that every time-step is written to disk
- PyFoam.Applications.Comparator: Application class that implements pyFoamComparator
- PyFoam.Applications.CompareDictionary: Application class that implements pyFoamCompareDictionary.py
- PyFoam.Applications.CompressCaseFiles: Application-class that implements pyFoamCompressCaseFiles.py
- PyFoam.Applications.ConvertToCSV: Application-class that implements pyFoamConvertToCSV.py
- PyFoam.Applications.CopyLastToFirst: Application-class that implements pyFoamCopyLastToFirst.py
- PyFoam.Applications.CreateBoundaryPatches: Application class that implements pyFoamCreateBoundaryPatches.py
- PyFoam.Applications.CreateModuleFile: Application-class that implements pyFoamCreateModuleFile.py
- PyFoam.Applications.Decomposer: Class that implements pyFoamDecompose
- PyFoam.Applications.DisplayBlockMesh: Old implementation using Tkinter.
- PyFoam.Applications.DisplayBlockMeshQt: New implementation of DisplayBlockMesh using PyQT4
- PyFoam.Applications.DumpRunDatabaseToCSV: Application-class that implements pyFoamDumpRunDatabaseToCSV.py
- PyFoam.Applications.EchoDictionary: Application class that implements pyFoamEchoDictionary
- PyFoam.Applications.EchoPickledApplicationData: Application class that implements pyFoamEchoPickledApplicationData
- PyFoam.Applications.Execute: Application class that implements pyFoamExecute
- PyFoam.Applications.FromTemplate: Application class that implements pyFoamFromTemplate
- PyFoam.Applications.IPythonNotebook: Application-class that implements pyFoamIPythonNotebook.py
- PyFoam.Applications.InitVCSCase: Application-class that implements pyFoamInitVCSCase.py
- PyFoam.Applications.JoinCSV: Application-class that implements pyFoamJoinCSV.py
- PyFoam.Applications.ListCases: Application-class that implements pyFoamListCases.py
- PyFoam.Applications.MeshUtilityRunner: Application class that implements pyFoamMeshUtilityRunner
- PyFoam.Applications.ModifyGGIBoundary: Application-class that implements pyFoamModifyGGIBoundary.py
- PyFoam.Applications.PackCase: Application-class that implements pyFoamPackCase.py
- PyFoam.Applications.PlotHelpers: Helper-functions for the plots
- PyFoam.Applications.PlotRunner: Class that implements pyFoamPlotRunner
- PyFoam.Applications.PlotWatcher: Class that implements pyFoamPlotWatcher
- PyFoam.Applications.PotentialRunner: Application class that implements pyFoamSteadyRunner
- PyFoam.Applications.PrepareCase: Application-class that implements pyFoamPrepareCase.py
- PyFoam.Applications.PrintData2DStatistics: Application class that implements pyFoamPrintData2DStatistics
- PyFoam.Applications.PyFoamApplication: Base class for pyFoam-applications
- PyFoam.Applications.PyFoamApplicationQt4: Base class for pyFoam-applications that have a QT4-GUI
- PyFoam.Applications.ReadDictionary: Application class that implements pyFoamReadDictionary
- PyFoam.Applications.RedoPlot: A test utility that ghets all the information necessary for plotting from a remote machine and writes some plots<<
- PyFoam.Applications.RunAtMultipleTimes: Application class that implements pyFoamRunAtMultipleTimes
- PyFoam.Applications.RunParameterVariation: Application class that implements pyFoamPrepareCase
- PyFoam.Applications.Runner: Application class that implements pyFoamRunner
- PyFoam.Applications.STLUtility: Application-class that implements pyFoamSTLUtility.py
- PyFoam.Applications.SamplePlot: Application class that implements pyFoamSamplePlot.py
- PyFoam.Applications.SteadyRunner: Application class that implements pyFoamSteadyRunner
- PyFoam.Applications.SurfacePlot: Application class that implements pyFoamSurfacePlot.py
- PyFoam.Applications.SymlinkToFile: Application-class that implements pyFoamSymlinkToFile.py
- PyFoam.Applications.TestConfiguration: Application class that implements pyFoamTestConfiguration.py
- PyFoam.Applications.TimelinePlot: Application class that implements pyFoamTimelinePlot.py
- PyFoam.Applications.UpdateDictionary: Application class that implements pyFoamUpdateDictionary.py
- PyFoam.Applications.UpgradeDictionariesTo17: Application class that implements pyFoamUpgradeDictionariesTo17
- PyFoam.Applications.UpgradeDictionariesTo20: Application class that implements pyFoamUpgradeDictionariesTo20
- PyFoam.Applications.UtilityRunnerApp: Application class that implements pyFoamUtilityRunner
- PyFoam.Applications.WriteDictionary: Application class that implements pyFoamWriteDictionary
PyFoam.Basics: Helper-Classes
- PyFoam.Basics.BasicFile: Basic file output
- PyFoam.Basics.CSVCollection: Collects data and writes it to a CSV-file.
- PyFoam.Basics.CustomPlotInfo: Information about custom plots
- PyFoam.Basics.Data2DStatistics: Data structure to do some calculations on the results from SpreadSheetData-methods metrics and compare that are organized in 2 dimensions
- PyFoam.Basics.DataStructures: Data structures in Foam-Files that can't be directly represented by Python-Structures
- PyFoam.Basics.DummyPlotTimelines: Plots a collection of timelines
- PyFoam.Basics.FoamFileGenerator: Transform a Python data-structure into a OpenFOAM-File-Representation
- PyFoam.Basics.FoamOptionParser: Parse options for the PyFoam-Scripts
- PyFoam.Basics.GeneralPlotTimelines: Plots a collection of timelines.
- PyFoam.Basics.GeneralVCSInterface: General interface to VCS implementations
- PyFoam.Basics.GitInterface: A VCS-interface to Mercurial
- PyFoam.Basics.GnuplotCompare: Compare files with Gnuplot
- PyFoam.Basics.GnuplotFile: Analyze a file with GNUPLOT-Data
- PyFoam.Basics.GnuplotTimelines: Plots a collection of timelines
- PyFoam.Basics.Helpers: Utility functions
- PyFoam.Basics.HgInterface: A VCS-interface to Mercurial
- PyFoam.Basics.LineReader: Read a file line by line
- PyFoam.Basics.MatplotlibTimelines: Plots a collection of timelines
- PyFoam.Basics.OutFileCollection: Collections of output files
- PyFoam.Basics.OutputFile: Output of time-dependent data
- PyFoam.Basics.PlotTimelinesFactory: Creates subclasses of GeneralPlotTimelines
- PyFoam.Basics.PlyParser: Base class for all parser classes based on PLY
- PyFoam.Basics.ProgressOutput: Output of progress
- PyFoam.Basics.QwtPlotTimelines: Plots a collection of timelines
- PyFoam.Basics.RestructuredTextHelper: Helps formatting output for restructured text
- PyFoam.Basics.RingBuffer: A ring-buffer data structure
- PyFoam.Basics.RunDatabase: Collects data about runs in a small SQLite database
- PyFoam.Basics.STLFile: Read a STL file and do simple manipulations
- PyFoam.Basics.SpreadsheetData: Data that can go into a spreadsheet (title line and rectangular data)
- PyFoam.Basics.SvkInterface: A VCS-interface to Mercurial
- PyFoam.Basics.SvnInterface: A VCS-interface to Mercurial
- PyFoam.Basics.TableData: A simple object for table data where data is accessed with a tuple (rowLabel,colLabel)
- PyFoam.Basics.TemplateFile
- PyFoam.Basics.TerminalFormatter: Formats the output on a terminal
- PyFoam.Basics.TimeLineCollection: Collection of array of timelines
- PyFoam.Basics.Utilities: Utility functions
- PyFoam.Basics.XkcdMatplotlibTimelines: Plots a collection of timelines
PyFoam.Error: Standardized Error Messages
PyFoam.Execution: Program execution
- PyFoam.Execution.AnalyzedCommon: Common stuff for classes that use analyzers
- PyFoam.Execution.AnalyzedRunner: Command is run and output is analyzed
- PyFoam.Execution.AnalyzedWatcher: Watches output and analyzes it
- PyFoam.Execution.BasicRunner: Run a OpenFOAM command
- PyFoam.Execution.BasicWatcher: Watches the output of Foam-run
- PyFoam.Execution.ConvergenceRunner: Stop solver at convergence
- PyFoam.Execution.FoamThread: Thread wrappers for OpenFOAM
- PyFoam.Execution.GnuplotRunner: Runner that outputs the residuals of the linear solver with Gnuplot
- PyFoam.Execution.ParallelExecution: Things that are needed for convenient parallel Execution
- PyFoam.Execution.StepAnalyzedCommon: Common stuff for classes that do something at every timestep
- PyFoam.Execution.StepAnalyzedRunner: An Analyzed Runner that does something at every time-step
- PyFoam.Execution.StepAnalyzedWatcher: An Analyzed Runner that does something at every time-step
- PyFoam.Execution.UtilityRunner: Run a non-solver utility
PyFoam.FoamInformation: Getting Information about the Foam-Installation (like the installation directory)
PyFoam.IPythonHelpers: IPython
- PyFoam.IPythonHelpers.Case: Encapsulate a case and give convenient access to certain applications
- PyFoam.IPythonHelpers.Notebook: Read and create IPython-Notebooks
- PyFoam.IPythonHelpers.PermanentStorage: PermanentStorage
PyFoam.Infrastructure: Infrastructure-Classes
- PyFoam.Infrastructure.CTestRun: A wrapper to run a solver as a CTest
- PyFoam.Infrastructure.ClusterJob: Encapsulates all necessary things for a cluster-job, like setting up, running, restarting
- PyFoam.Infrastructure.Configuration: Reads configuration-files that define defaults for various PyFoam-Settings
- PyFoam.Infrastructure.FoamMetaServer: A XMLRPC-Server that knows all PyFoam-Runs in its subnet
- PyFoam.Infrastructure.FoamServer: A XMLRPC-Server that answeres about the current state of a Foam-Run
- PyFoam.Infrastructure.Hardcoded: Hardcoded values
- PyFoam.Infrastructure.Logging: Writes Logfiles
- PyFoam.Infrastructure.NetworkHelpers: Helpers for the networking functionality
- PyFoam.Infrastructure.RunHook: Base class for all Run-Hooks
- PyFoam.Infrastructure.RunHooks: RuntimeHook-Classes
  - PyFoam.Infrastructure.RunHooks.MailToAddress: Send an EMail to a specified address
  - PyFoam.Infrastructure.RunHooks.PrintMessageHook: A simple hook that only prints a user-specified message
  - PyFoam.Infrastructure.RunHooks.SendToWebservice: Call an URL from a webservice
  - PyFoam.Infrastructure.RunHooks.WriteToSqliteDatabase: Write the data to a sqlite database
- PyFoam.Infrastructure.ServerBase: Basis for the XMLRPC-Servers in PyFoam
PyFoam.LogAnalysis: Log Analysis
- PyFoam.LogAnalysis.BoundingLineAnalyzer: Check lines for Boundedness
- PyFoam.LogAnalysis.BoundingLogAnalyzer: Basic log analyer with boundedness
- PyFoam.LogAnalysis.ContextLineAnalyzer: Line analyzer that finds data n lines after a matching line
- PyFoam.LogAnalysis.ContinuityLineAnalyzer: Check lines for continuity information
- PyFoam.LogAnalysis.DeltaTLineAnalyzer: Check lines for timestep information
- PyFoam.LogAnalysis.EchoLineAnalyzer: Echos a line
- PyFoam.LogAnalysis.EchoLogAnalyzer: Echos a log
- PyFoam.LogAnalysis.ExecutionTimeLineAnalyzer: Check for Execution-Time information
- PyFoam.LogAnalysis.FileLineAnalyzer: Line analyzer with output
- PyFoam.LogAnalysis.FoamLogAnalyzer: Analyze OpenFOAM logs
- PyFoam.LogAnalysis.GeneralLineAnalyzer: Line analyzer with output and the capability to store lines
- PyFoam.LogAnalysis.LinearSolverLineAnalyzer: Analyze information from the linear solver
- PyFoam.LogAnalysis.LogAnalyzerApplication: Wraps an Analyzer
- PyFoam.LogAnalysis.LogLineAnalyzer: Base class for analyzing lines
- PyFoam.LogAnalysis.NameFinderLineAnalyzer: A line analyzer that generates a list of names
- PyFoam.LogAnalysis.PhaseChangerLineAnalyzer: Analyzes lines with regular expressions and changes the phase if it fits
- PyFoam.LogAnalysis.RegExpLineAnalyzer: Analyzes lines with regular expressions
- PyFoam.LogAnalysis.SimpleLineAnalyzer: Do analysis for simple expressions
- PyFoam.LogAnalysis.StandardLogAnalyzer: Analyze standard solver
- PyFoam.LogAnalysis.SteadyConvergedLineAnalyzer: Analyze Steady Solver
- PyFoam.LogAnalysis.TimeLineAnalyzer: Analyze Line for Time
- PyFoam.LogAnalysis.TimeLineLineAnalyzer: Line analyzer that collects datga in arrays
- PyFoam.LogAnalysis.UtilityAnalyzer: Analyze OpenFOAM utility
- PyFoam.LogAnalysis.ValueLineAnalyzer: Do analysis for a line with values
PyFoam.RunDictionary: Manipulating the data files
- PyFoam.RunDictionary.BlockMesh: Manipulate a blockMeshDict
- PyFoam.RunDictionary.BoundaryDict: Works with a polyMesh/boundary-File
- PyFoam.RunDictionary.FileBasis: Basis for the handling of OpenFOAM-files
- PyFoam.RunDictionary.ListFile: File that contains only a list (for instance points)
- PyFoam.RunDictionary.MeshInformation: Gets information about the mesh of a case.
- PyFoam.RunDictionary.ParameterFile: Working with parameter-files
- PyFoam.RunDictionary.ParsedBlockMeshDict: A parsed blockMeshDict
- PyFoam.RunDictionary.ParsedParameterFile: Parameter file is read into memory and modified there
- PyFoam.RunDictionary.RegionCases: Pseudo-Cases for Regions, built from symlinks
- PyFoam.RunDictionary.SampleDirectory: Working with a directory of samples
- PyFoam.RunDictionary.SolutionDirectory: Working with a solution directory
- PyFoam.RunDictionary.SolutionFile: Working with solutions
- PyFoam.RunDictionary.SurfaceDirectory: Working with a directory of surface samples
- PyFoam.RunDictionary.TimeDirectory: Working with direcotries from a time-step
- PyFoam.RunDictionary.TimelineDirectory: Working with a directory of timelines
PyFoam.Site: Site-specific Packages
- PyFoam.Site.ChangeGGIBoundary: Application-class that implements pyFoamChangeGGIBoundary.py
- PyFoam.Site.ChangeMixingPlaneBoundary: Application-class that implements pyFoamChangeMixingPlaneBoundary.py
- PyFoam.Site.ConvertMixingPlaneBoundaryToNewSyntax: Application-class that implements pyFoamConvertMixingPlaneToNewSyntax.py
- PyFoam.Site.InitGgiInterface: Application-class that implements pyFoamInitGgiInterface.py
- PyFoam.Site.InitMixingPlaneInterface: Application-class that implements pyFoamInitMixingPlaneInterface.py
PyFoam.ThirdParty: ThirdParty-Packages
- PyFoam.ThirdParty.Gnuplot: Gnuplot -- A pipe-based interface to the gnuplot plotting program.
  - PyFoam.ThirdParty.Gnuplot.Errors: Exception types that can be raised by Gnuplot.py.
  - PyFoam.ThirdParty.Gnuplot.PlotItems: PlotItems.py -- Objects that can be plotted by Gnuplot.
  - PyFoam.ThirdParty.Gnuplot._Gnuplot: _Gnuplot.py -- An object that represents a running gnuplot process.
  - PyFoam.ThirdParty.Gnuplot.demo: demo.py -- Demonstrate the Gnuplot python module.
  - PyFoam.ThirdParty.Gnuplot.funcutils: funcutils.py -- Subroutines that tabulate a function's values.
  - PyFoam.ThirdParty.Gnuplot.gnuplot_Suites: Suite gnuplot Suite: Events supplied by gnuplot Level 1, version 1
  - PyFoam.ThirdParty.Gnuplot.gp: gp -- a platform-independent interface to a gnuplot process.
  - PyFoam.ThirdParty.Gnuplot.gp_cygwin: gp_cygwin -- an interface to gnuplot for cygwin under Windows.
  - PyFoam.ThirdParty.Gnuplot.gp_macosx: gp_macosx -- an interface to the command line version of gnuplot used under Mac OS X.
  - PyFoam.ThirdParty.Gnuplot.gp_unix: gp_unix -- an interface to gnuplot used for unix platforms.
  - PyFoam.ThirdParty.Gnuplot.gp_win32: gp_win32 -- an interface to gnuplot for Windows.
  - PyFoam.ThirdParty.Gnuplot.termdefs: Terminal definition file.
  - PyFoam.ThirdParty.Gnuplot.test: test.py -- Exercise the Gnuplot.py module.
  - PyFoam.ThirdParty.Gnuplot.utils: utils.py -- Utility functions used by Gnuplot.
- PyFoam.ThirdParty.IPy: IPy - class and tools for handling of IPv4 and IPv6 Addresses and Networks.
- PyFoam.ThirdParty.ply
  - PyFoam.ThirdParty.ply.lex
  - PyFoam.ThirdParty.ply.yacc
- PyFoam.ThirdParty.pyratemp: Small, simple and powerful template-engine for python.
- PyFoam.ThirdParty.six: Utilities for writing code that runs on Python 2 and 3
- PyFoam.ThirdParty.winhacks: ------------------------------------------------------------------------------ License This file is part of blueCAPE's modifications to PyFoam for working on Windows.
PyFoam.Wrappers: Wrappers
- PyFoam.Wrappers.Pandas: Extended version of the Pandas-Dataframe

Functions

[hide private]

configuration()
Returns: The Configuration information of PyFoam

source code

foamVersionString()

source code

version()
Returns: Version number as a tuple

source code

versionString()
Returns: Version number of PyFoam

source code

Variables

[hide private]

__package__ = 'PyFoam'

_configuration = <PyFoam.Infrastructure.Configuration.Configur...

Imports: Configuration, Infrastructure, ThirdParty

Function Details

[hide private]

configuration()

source code

Returns:: The Configuration information of PyFoam

version()

source code

Returns:: Version number as a tuple

versionString()

source code

Returns:: Version number of PyFoam

Variables Details

[hide private]

_configuration

Value:

<PyFoam.Infrastructure.Configuration.Configuration instance at 0x10f94
0e60>