PyFoam.IPythonHelpers.Case module

Encapsulate a case and give convenient access to certain applications

class PyFoam.IPythonHelpers.Case.Case(input)

Bases: object

This class is initialized with a path and gives access to reporting functions

__callCaseReport(region=None, level=3, **kwargs)

Helper function that does the actual calling of CaseReport and returning of the HTML-formatted output

__dict__ = mappingproxy({'__module__': 'PyFoam.IPythonHelpers.Case', '__doc__': 'This class is initialized with a path and gives access to\n    reporting functions\n\n    ', '__init__': <function Case.__init__>, 'sol': <property object>, 'path': <property object>, 'regions': <property object>, '_Case__callCaseReport': <function Case.__callCaseReport>, 'size': <function Case.size>, 'boundaryConditions': <function Case.boundaryConditions>, 'longBoundaryConditions': <function Case.longBoundaryConditions>, 'dimensions': <function Case.dimensions>, 'internalField': <function Case.internalField>, 'linearSolvers': <function Case.linearSolvers>, 'relaxationFactors': <function Case.relaxationFactors>, 'processorMatrix': <function Case.processorMatrix>, 'decomposition': <function Case.decomposition>, 'timeline': <function Case.timeline>, 'timelineInfo': <function Case.timelineInfo>, 'sampleTime': <function Case.sampleTime>, 'sampleField': <function Case.sampleField>, 'sampleInfo': <function Case.sampleInfo>, 'distributionInfo': <function Case.distributionInfo>, 'distribution': <function Case.distribution>, 'pickledPlots': <function Case.pickledPlots>, 'pickledData': <function Case.pickledData>, '_Case__getObjectName': <function Case.__getObjectName>, '_Case__getStorageName': <function Case.__getStorageName>, 'timelineSelector': <function Case.timelineSelector>, 'sampleSelector': <function Case.sampleSelector>, 'distributionSelector': <function Case.distributionSelector>, 'pickledPlotSelector': <function Case.pickledPlotSelector>, 'pickledDataSelector': <function Case.pickledDataSelector>, '__dict__': <attribute '__dict__' of 'Case' objects>, '__weakref__': <attribute '__weakref__' of 'Case' objects>, '__annotations__': {}})

__getObjectName(obj)

__getStorageName()

__init__(input)

Parameters:

input – either a SolutionDirectory-instance or a string

with a pathname

__module__ = 'PyFoam.IPythonHelpers.Case'

__weakref__

list of weak references to the object (if defined)

boundaryConditions(region=None, **kwargs)

decomposition(region=None, **kwargs)

dimensions(region=None, **kwargs)

distribution(directory, line, time)

distributionInfo(directory)

distributionSelector(directoryName)

internalField(region=None, **kwargs)

linearSolvers(region=None, **kwargs)

longBoundaryConditions(region=None, **kwargs)

property path

The path to the solution

pickledData(pickleFile)

pickledDataSelector()

pickledPlotSelector()

pickledPlots(pickleFile)

processorMatrix(region=None, **kwargs)

property regions

Regions in the case

relaxationFactors(region=None, **kwargs)

sampleField(directory, line, field)

sampleInfo(directory)

sampleSelector(directoryName)

sampleTime(directory, line, time)

size(region=None, **kwargs)

property sol

The actual solution directory

timeline(directory, fieldname)

timelineInfo(directory)

timelineSelector(directoryName)