PyFoam.RunDictionary package

Submodules

• PyFoam.RunDictionary.BlockMesh module
  • BlockMesh
    • BlockMesh.__annotations__
    • BlockMesh.__endProcess()
    • BlockMesh.__init__()
    • BlockMesh.__module__
    • BlockMesh.__startProcess()
    • BlockMesh._getVertexes()
    • BlockMesh.mergeVertices()
    • BlockMesh.normalizePatches()
    • BlockMesh.numberVertices()
    • BlockMesh.refineMesh()
    • BlockMesh.renumberVertices()
    • BlockMesh.stripVertexNumber()
• PyFoam.RunDictionary.BlockMesh2D module
  • BlockMesh2D
    • BlockMesh2D.__annotations__
    • BlockMesh2D.__endProcess()
    • BlockMesh2D.__init__()
    • BlockMesh2D.__module__
    • BlockMesh2D.__startProcess()
    • BlockMesh2D._get2DBlocks()
    • BlockMesh2D._get2DBoundaries()
    • BlockMesh2D._get2DEdges()
    • BlockMesh2D._get2DMesh()
    • BlockMesh2D._get2DVertexes()
    • BlockMesh2D._get3DBoundaries()
    • BlockMesh2D._get3DEdges()
    • BlockMesh2D._get3DVertexes()
    • BlockMesh2D._getFrontAndBackBoundaries()
    • BlockMesh2D._getVertexes()
    • BlockMesh2D.convert2DBlockMesh()
    • BlockMesh2D.convertBlocks()
    • BlockMesh2D.convertBoundaries()
    • BlockMesh2D.convertEdges()
    • BlockMesh2D.convertVertices()
    • BlockMesh2D.getBounds()
• PyFoam.RunDictionary.BoundaryDict module
  • BoundaryDict
    • BoundaryDict.__annotations__
    • BoundaryDict.__getitem__()
    • BoundaryDict.__init__()
    • BoundaryDict.__iter__()
    • BoundaryDict.__module__
    • BoundaryDict.__setitem__()
    • BoundaryDict.patches()
• PyFoam.RunDictionary.FileBasis module
  • CleanCharactersFile
    • CleanCharactersFile.__annotations__
    • CleanCharactersFile.__init__()
    • CleanCharactersFile.__module__
    • CleanCharactersFile.parse()
  • FileBasis
    • FileBasis.__annotations__
    • FileBasis.__enter__()
    • FileBasis.__exit__()
    • FileBasis.__init__()
    • FileBasis.__module__
    • FileBasis.__str__()
    • FileBasis.addedString
    • FileBasis.baseName()
    • FileBasis.closeFile()
    • FileBasis.copyRest()
    • FileBasis.encode()
    • FileBasis.getCaseDir()
    • FileBasis.goMatch()
    • FileBasis.goTo()
    • FileBasis.makeTemp()
    • FileBasis.openFile()
    • FileBasis.parse()
    • FileBasis.purgeFile()
    • FileBasis.readFile()
    • FileBasis.realName()
    • FileBasis.removedString
    • FileBasis.writeEncoded()
    • FileBasis.writeFile()
    • FileBasis.writeFileAs()
  • FileBasisBackup
    • FileBasisBackup.__annotations__
    • FileBasisBackup.__init__()
    • FileBasisBackup.__module__
    • FileBasisBackup.counter
    • FileBasisBackup.restore()
  • exists()
• PyFoam.RunDictionary.LagrangianCloudData module
  • LagrangianCloudData
    • LagrangianCloudData.__dict__
    • LagrangianCloudData.__init__()
    • LagrangianCloudData.__module__
    • LagrangianCloudData.__weakref__
  • LagrangianCloudDataDirectory
    • LagrangianCloudDataDirectory.__dict__
    • LagrangianCloudDataDirectory.__init__()
    • LagrangianCloudDataDirectory.__module__
    • LagrangianCloudDataDirectory.__weakref__
• PyFoam.RunDictionary.LagrangianPatchData module
  • LagrangianPatchData
    • LagrangianPatchData.__dict__
    • LagrangianPatchData.__init__()
    • LagrangianPatchData.__module__
    • LagrangianPatchData.__weakref__
    • LagrangianPatchData.pandas()
  • LagrangianPatchDataAll
    • LagrangianPatchDataAll.__dict__
    • LagrangianPatchDataAll.__init__()
    • LagrangianPatchDataAll.__module__
    • LagrangianPatchDataAll.__weakref__
    • LagrangianPatchDataAll.pandas()
  • LagrangianPatchDataTime
    • LagrangianPatchDataTime.__dict__
    • LagrangianPatchDataTime.__init__()
    • LagrangianPatchDataTime.__module__
    • LagrangianPatchDataTime.__weakref__
    • LagrangianPatchDataTime.pandas()
  • globalId()
• PyFoam.RunDictionary.ListFile module
  • ListFile
    • ListFile.__annotations__
    • ListFile.__init__()
    • ListFile.__module__
    • ListFile.getSize()
• PyFoam.RunDictionary.MeshInformation module
  • MeshInformation
    • MeshInformation.__dict__
    • MeshInformation.__init__()
    • MeshInformation.__module__
    • MeshInformation.__weakref__
    • MeshInformation.nrOfCells()
    • MeshInformation.nrOfFaces()
    • MeshInformation.nrOfPoints()
• PyFoam.RunDictionary.ParameterFile module
  • ParameterFile
    • ParameterFile.__annotations__
    • ParameterFile.__init__()
    • ParameterFile.__module__
    • ParameterFile.parameterPattern()
    • ParameterFile.readParameter()
    • ParameterFile.replaceParameter()
• PyFoam.RunDictionary.ParsedBlockMeshDict module
  • ParsedBlockMeshDict
    • ParsedBlockMeshDict.__annotations__
    • ParsedBlockMeshDict.__init__()
    • ParsedBlockMeshDict.__module__
    • ParsedBlockMeshDict.arcs()
    • ParsedBlockMeshDict.blocks()
    • ParsedBlockMeshDict.convertToMeters()
    • ParsedBlockMeshDict.getBounds()
    • ParsedBlockMeshDict.patches()
    • ParsedBlockMeshDict.typicalLength()
    • ParsedBlockMeshDict.vertices()
• PyFoam.RunDictionary.ParsedParameterFile module
  • BinaryParserError
    • BinaryParserError.__annotations__
    • BinaryParserError.__init__()
    • BinaryParserError.__module__
  • Enumerate
    • Enumerate.__dict__
    • Enumerate.__init__()
    • Enumerate.__module__
    • Enumerate.__weakref__
  • FoamFileParser
    • FoamFileParser.__annotations__
    • FoamFileParser.__contains__()
    • FoamFileParser.__delitem__()
    • FoamFileParser.__getitem__()
    • FoamFileParser.__init__()
    • FoamFileParser.__iter__()
    • FoamFileParser.__module__
    • FoamFileParser.__setitem__()
    • FoamFileParser.addCommentToDecorations()
    • FoamFileParser.addNewlinesToDecorations()
    • FoamFileParser.addToDecoration()
    • FoamFileParser.condenseAllPreFixLists()
    • FoamFileParser.directory()
    • FoamFileParser.getData()
    • FoamFileParser.getDecoration()
    • FoamFileParser.getHeader()
    • FoamFileParser.literals
    • FoamFileParser.p_afterHeader()
    • FoamFileParser.p_binaryblob()
    • FoamFileParser.p_boundaryDict()
    • FoamFileParser.p_codeSeen()
    • FoamFileParser.p_codestream()
    • FoamFileParser.p_dictbody()
    • FoamFileParser.p_dictionary()
    • FoamFileParser.p_dictitem()
    • FoamFileParser.p_dictkey()
    • FoamFileParser.p_dictline()
    • FoamFileParser.p_dimension()
    • FoamFileParser.p_empty()
    • FoamFileParser.p_enter_dict()
    • FoamFileParser.p_error()
    • FoamFileParser.p_exit_dict()
    • FoamFileParser.p_fieldvalue_nonuniform()
    • FoamFileParser.p_fieldvalue_uniform()
    • FoamFileParser.p_float()
    • FoamFileParser.p_global()
    • FoamFileParser.p_gotHeader()
    • FoamFileParser.p_header()
    • FoamFileParser.p_ignore_rest_of_line()
    • FoamFileParser.p_include()
    • FoamFileParser.p_inputMode()
    • FoamFileParser.p_integer()
    • FoamFileParser.p_item()
    • FoamFileParser.p_itemlist()
    • FoamFileParser.p_list()
    • FoamFileParser.p_longitem()
    • FoamFileParser.p_macro()
    • FoamFileParser.p_noBody()
    • FoamFileParser.p_noHeader()
    • FoamFileParser.p_number()
    • FoamFileParser.p_onlyListOrPList()
    • FoamFileParser.p_pitem()
    • FoamFileParser.p_pitemlist()
    • FoamFileParser.p_prelist()
    • FoamFileParser.p_prelist_seen()
    • FoamFileParser.p_pureList()
    • FoamFileParser.p_pureListWithHeader()
    • FoamFileParser.p_remove()
    • FoamFileParser.p_substitution()
    • FoamFileParser.p_symbolic_dimension()
    • FoamFileParser.p_symbolic_dimension_terminal()
    • FoamFileParser.p_symmtensor()
    • FoamFileParser.p_tensor()
    • FoamFileParser.p_uniformfield()
    • FoamFileParser.p_unparsed()
    • FoamFileParser.p_vector()
    • FoamFileParser.p_wlist()
    • FoamFileParser.p_word()
    • FoamFileParser.p_wordlist()
    • FoamFileParser.parseSubst_root()
    • FoamFileParser.parserError()
    • FoamFileParser.printContext()
    • FoamFileParser.reserved
    • FoamFileParser.resetDecoration()
    • FoamFileParser.states
    • FoamFileParser.t_CODEEND
    • FoamFileParser.t_CODESTART
    • FoamFileParser.t_FCONST
    • FoamFileParser.t_ICONST
    • FoamFileParser.t_KANALGITTER
    • FoamFileParser.t_NAME()
    • FoamFileParser.t_SCONST
    • FoamFileParser.t_SUBSTITUITION()
    • FoamFileParser.t_binaryblob_close()
    • FoamFileParser.t_binaryblob_error()
    • FoamFileParser.t_binaryblob_ignore
    • FoamFileParser.t_binaryblob_throwaway()
    • FoamFileParser.t_ccode_comment()
    • FoamFileParser.t_codestream_end()
    • FoamFileParser.t_codestream_error()
    • FoamFileParser.t_codestream_ignore
    • FoamFileParser.t_codestream_throwaway()
    • FoamFileParser.t_error()
    • FoamFileParser.t_ignore
    • FoamFileParser.t_ignorerestofline_SCONST()
    • FoamFileParser.t_ignorerestofline_error()
    • FoamFileParser.t_ignorerestofline_ignore
    • FoamFileParser.t_ignorerestofline_newline()
    • FoamFileParser.t_ignorerestofline_restofline()
    • FoamFileParser.t_mlcomment_endcomment()
    • FoamFileParser.t_mlcomment_error()
    • FoamFileParser.t_mlcomment_ignore
    • FoamFileParser.t_mlcomment_newlevel()
    • FoamFileParser.t_mlcomment_throwaway()
    • FoamFileParser.t_newline()
    • FoamFileParser.t_startmlcomment()
    • FoamFileParser.t_unparsed_error()
    • FoamFileParser.t_unparsed_ignore
    • FoamFileParser.t_unparsed_left()
    • FoamFileParser.t_unparsed_right()
    • FoamFileParser.tokens
  • FoamStringParser
    • FoamStringParser.__annotations__
    • FoamStringParser.__init__()
    • FoamStringParser.__module__
    • FoamStringParser.__str__()
  • NotAPrelist
    • NotAPrelist.__dict__
    • NotAPrelist.__init__()
    • NotAPrelist.__module__
    • NotAPrelist.__weakref__
  • ParsedBoundaryDict
    • ParsedBoundaryDict.__annotations__
    • ParsedBoundaryDict.__init__()
    • ParsedBoundaryDict.__module__
    • ParsedBoundaryDict.__str__()
    • ParsedBoundaryDict.parse()
  • ParsedFileHeader
    • ParsedFileHeader.__annotations__
    • ParsedFileHeader.__contains__()
    • ParsedFileHeader.__getitem__()
    • ParsedFileHeader.__init__()
    • ParsedFileHeader.__len__()
    • ParsedFileHeader.__module__
  • ParsedParameterFile
    • ParsedParameterFile.__annotations__
    • ParsedParameterFile.__contains__()
    • ParsedParameterFile.__delitem__()
    • ParsedParameterFile.__getitem__()
    • ParsedParameterFile.__init__()
    • ParsedParameterFile.__iter__()
    • ParsedParameterFile.__len__()
    • ParsedParameterFile.__module__
    • ParsedParameterFile.__setitem__()
    • ParsedParameterFile.__str__()
    • ParsedParameterFile.getValueDict()
    • ParsedParameterFile.parse()
  • PyFoamParserError
    • PyFoamParserError.__annotations__
    • PyFoamParserError.__init__()
    • PyFoamParserError.__module__
    • PyFoamParserError.__repr__()
    • PyFoamParserError.__str__()
  • WriteParameterFile
    • WriteParameterFile.__annotations__
    • WriteParameterFile.__init__()
    • WriteParameterFile.__module__
• PyFoam.RunDictionary.RegionCases module
  • RegionCases
    • RegionCases.__dict__
    • RegionCases.__init__()
    • RegionCases.__module__
    • RegionCases.__weakref__
    • RegionCases._mklink()
    • RegionCases._rename()
    • RegionCases.clean()
    • RegionCases.cleanAll()
    • RegionCases.resync()
    • RegionCases.resyncAll()
• PyFoam.RunDictionary.SampleDirectory module
  • SampleData
    • SampleData.__call__()
    • SampleData.__dict__
    • SampleData.__init__()
    • SampleData.__module__
    • SampleData.__repr__()
    • SampleData.__weakref__
    • SampleData.component()
    • SampleData.domain()
    • SampleData.isVector()
    • SampleData.line()
    • SampleData.range()
    • SampleData.time()
  • SampleDirectory
    • SampleDirectory.__contains__()
    • SampleDirectory.__dict__
    • SampleDirectory.__getitem__()
    • SampleDirectory.__init__()
    • SampleDirectory.__iter__()
    • SampleDirectory.__len__()
    • SampleDirectory.__module__
    • SampleDirectory.__weakref__
    • SampleDirectory.getData()
    • SampleDirectory.lines()
    • SampleDirectory.values()
  • SampleTime
    • SampleTime.__dict__
    • SampleTime.__getitem__()
    • SampleTime.__init__()
    • SampleTime.__module__
    • SampleTime.__weakref__
    • SampleTime.determineIndex()
    • SampleTime.extractLine()
    • SampleTime.extractValues()
• PyFoam.RunDictionary.SolutionDirectory module
  • ChemkinSolutionDirectory
    • ChemkinSolutionDirectory.__annotations__
    • ChemkinSolutionDirectory.__init__()
    • ChemkinSolutionDirectory.__module__
    • ChemkinSolutionDirectory.chemkinDir()
    • ChemkinSolutionDirectory.chemkinName
  • NoTouchSolutionDirectory
    • NoTouchSolutionDirectory.__annotations__
    • NoTouchSolutionDirectory.__init__()
    • NoTouchSolutionDirectory.__module__
  • SolutionDirectory
    • SolutionDirectory.__annotations__
    • SolutionDirectory.__classifyDirectory()
    • SolutionDirectory.__contains__()
    • SolutionDirectory.__delitem__()
    • SolutionDirectory.__getitem__()
    • SolutionDirectory.__init__()
    • SolutionDirectory.__iter__()
    • SolutionDirectory.__len__()
    • SolutionDirectory.__module__
    • SolutionDirectory.__scanForPostproc()
    • SolutionDirectory.__scanPostproc()
    • SolutionDirectory.__setitem__()
    • SolutionDirectory.__symlinkDir()
    • SolutionDirectory.addBackup()
    • SolutionDirectory.addLocalConfig()
    • SolutionDirectory.addPostprocDir()
    • SolutionDirectory.addToClone()
    • SolutionDirectory.addToHistory()
    • SolutionDirectory.addToTar()
    • SolutionDirectory.blockMesh()
    • SolutionDirectory.boundaryDict()
    • SolutionDirectory.clear()
    • SolutionDirectory.clearOther()
    • SolutionDirectory.clearPattern()
    • SolutionDirectory.clearResults()
    • SolutionDirectory.cloneCase()
    • SolutionDirectory.constantDir()
    • SolutionDirectory.controlDict()
    • SolutionDirectory.determineVCS()
    • SolutionDirectory.distributions
    • SolutionDirectory.fullPath()
    • SolutionDirectory.getDictionaryContents()
    • SolutionDirectory.getDictionaryText()
    • SolutionDirectory.getFirst()
    • SolutionDirectory.getLast()
    • SolutionDirectory.getParallelTimes()
    • SolutionDirectory.getParametersFromFile()
    • SolutionDirectory.getRegions()
    • SolutionDirectory.getTimes()
    • SolutionDirectory.initialDir()
    • SolutionDirectory.isValid()
    • SolutionDirectory.lastToArchive()
    • SolutionDirectory.latestDir()
    • SolutionDirectory.listFiles()
    • SolutionDirectory.makeFile()
    • SolutionDirectory.missingFiles()
    • SolutionDirectory.nrProcs()
    • SolutionDirectory.packCase()
    • SolutionDirectory.pickledData
    • SolutionDirectory.pickledPlots
    • SolutionDirectory.polyMeshDir()
    • SolutionDirectory.processorDirs()
    • SolutionDirectory.regions()
    • SolutionDirectory.reread()
    • SolutionDirectory.samples
    • SolutionDirectory.setToParallel()
    • SolutionDirectory.surfaces
    • SolutionDirectory.symlinkCase()
    • SolutionDirectory.systemDir()
    • SolutionDirectory.timeIndex()
    • SolutionDirectory.timeName()
    • SolutionDirectory.timelines
    • SolutionDirectory.writeDictionaryContents()
    • SolutionDirectory.writeDictionaryText()
• PyFoam.RunDictionary.SolutionFile module
  • SolutionFile
    • SolutionFile.__annotations__
    • SolutionFile.__init__()
    • SolutionFile.__module__
    • SolutionFile.dimensionPattern()
    • SolutionFile.getContent()
    • SolutionFile.getDimensionString()
    • SolutionFile.internalPattern()
    • SolutionFile.internalPatternGeneral()
    • SolutionFile.internalPatternUniform()
    • SolutionFile.readBoundary()
    • SolutionFile.readDimension()
    • SolutionFile.readInternal()
    • SolutionFile.readInternalUniform()
    • SolutionFile.replaceBoundary()
    • SolutionFile.replaceInternal()
    • SolutionFile.stopPattern()
    • SolutionFile.valuePattern()
• PyFoam.RunDictionary.SurfaceDirectory module
  • SurfaceDirectory
    • SurfaceDirectory.__contains__()
    • SurfaceDirectory.__dict__
    • SurfaceDirectory.__getitem__()
    • SurfaceDirectory.__init__()
    • SurfaceDirectory.__iter__()
    • SurfaceDirectory.__module__
    • SurfaceDirectory.__weakref__
    • SurfaceDirectory.getData()
    • SurfaceDirectory.surfaces()
    • SurfaceDirectory.values()
  • SurfaceTime
    • SurfaceTime.__dict__
    • SurfaceTime.__getitem__()
    • SurfaceTime.__init__()
    • SurfaceTime.__module__
    • SurfaceTime.__weakref__
  • extractSurface()
  • extractValue()
• PyFoam.RunDictionary.TimeDirectory module
  • TimeDirectory
    • TimeDirectory.__contains__()
    • TimeDirectory.__delitem__()
    • TimeDirectory.__dict__
    • TimeDirectory.__getitem__()
    • TimeDirectory.__init__()
    • TimeDirectory.__iter__()
    • TimeDirectory.__len__()
    • TimeDirectory.__module__
    • TimeDirectory.__remove()
    • TimeDirectory.__setitem__()
    • TimeDirectory.__weakref__
    • TimeDirectory.baseName()
    • TimeDirectory.clear()
    • TimeDirectory.copy()
    • TimeDirectory.getFiles()
    • TimeDirectory.reread()
• PyFoam.RunDictionary.TimelineDirectory module
  • TimelineDirectory
    • TimelineDirectory.__contains__()
    • TimelineDirectory.__dict__
    • TimelineDirectory.__getitem__()
    • TimelineDirectory.__init__()
    • TimelineDirectory.__iter__()
    • TimelineDirectory.__len__()
    • TimelineDirectory.__module__
    • TimelineDirectory.__weakref__
    • TimelineDirectory.getData()
    • TimelineDirectory.getDataLocation()
    • TimelineDirectory.positions()
    • TimelineDirectory.timeRange()
  • TimelineValue
    • TimelineValue.__call__()
    • TimelineValue.__dict__
    • TimelineValue.__init__()
    • TimelineValue.__module__
    • TimelineValue.__repr__()
    • TimelineValue.__weakref__
    • TimelineValue.getData()
    • TimelineValue.isProbe()
    • TimelineValue.timeRange()

Module contents

Manipulating the data files

Classes that manipulate the parameter and the solution files in the data dictionary used by the OpenFOAM applications