OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface module#

OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.CheckIntegrity(GUI=False)[source]#

OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.CheckIntegrity_GeneralConfig(GUI=False)[source]#

OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.CheckIntegrity_Log(GUI=False)[source]#

OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.ComputeDirectorySize(path)[source]#

OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.CopyCleanConfig(originalPath, copyPath)[source]#

exception OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFOAMAdjointConvergenceError[source]#: Bases: OpenFOAMConvergenceError

exception OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFOAMConvergenceError[source]#: Bases: Exception

exception OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFOAMCoreDumpedError[source]#: Bases: Exception

exception OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFOAMDirectConvergenceError[source]#: Bases: OpenFOAMConvergenceError

exception OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFOAMIllPosedError[source]#: Bases: Exception

exception OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFOAMNoResidualInfoError[source]#: Bases: Exception

class OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFoamGeneralConfig(startFrom: str = 'latestTime', startTime: float = 0, stopAt: str = 'endTime', endTime: float = 1.0, deltaT: float = 1.0, writeControl: str = 'timeStep', writeInterval: float = 1, purgeWrite: float = 1, writeFormat: str = 'binary', writePrecision: int = 6, writeCompression: str = 'off', timeFormat: str = 'general', timePrecision: int = 6, runTimeModifiable: str = 'true', relativeTolerance: float = 0.0, continuityError: float = 0.0001, variableError: float = 1e-05, enableParallelism: bool = False, numberOfSubDomains: int = 1, optimizeRenumbering: bool = True, enableCheckError: bool = True, enableCheckMesh: bool = True, computeSensitivity: bool = False, plotFoamQuantities: bool = False)[source]#

Bases: object

ToDict() → dict[source]#

Convert to dict

Returns: instance as a dict
Return type: dict

UpdateFromDict(params: dict)[source]#

Update instance from dict

Parameters: params (dict) – new parameters
Returns: instance
Return type: OpenFoamGeneralConfig

UpdateFromInstance(other: Optional[OpenFoamGeneralConfig] = None)[source]#

Update instance from another instance

Parameters: other (OpenFoamGeneralConfig,optional) – another instance
Returns: instance
Return type: OpenFoamGeneralConfig

computeSensitivity: bool = False#

continuityError: float = 0.0001#

deltaT: float = 1.0#

enableCheckError: bool = True#

enableCheckMesh: bool = True#

enableParallelism: bool = False#

endTime: float = 1.0#

numberOfSubDomains: int = 1#

optimizeRenumbering: bool = True#

plotFoamQuantities: bool = False#

purgeWrite: float = 1#

relativeTolerance: float = 0.0#

runTimeModifiable: str = 'true'#

startFrom: str = 'latestTime'#

startTime: float = 0#

stopAt: str = 'endTime'#

timeFormat: str = 'general'#

timePrecision: int = 6#

variableError: float = 1e-05#

writeCompression: str = 'off'#

writeControl: str = 'timeStep'#

writeFormat: str = 'binary'#

writeInterval: float = 1#

writePrecision: int = 6#

class OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFoamInterface(foamGeneralConfig: Optional[OpenFoamGeneralConfig] = None)[source]#

Bases: AppExecutableBase

class OpenFoamInterface#

Interface for the finite volume solver OpenFoam

AddQuantityToTrack(quantityToTrack)[source]#

BuildCmdFromUtilityName(foamUtilityName)[source]#

CheckContinuityError(residualByVariable)[source]#

CheckConvergence(logFile)[source]#

CheckVariableConvergence(residualByVariable)[source]#

CleanAdjointWorkingDirectory(copyId: int, adjointPhysicalVariables: Iterable)[source]#: To use when the adjoint solver fails. The aim is to remove the diverging adjoint solution on disk (else OpenFOAM will use it as a starting point and fails again) but to keep the direct solution as an initialization to accelerate the convergence (should take a single iteration, significantly save computation time)

CleanWorkingDirectory()[source]#: To use in order to remove all directories create during OpenFOAM execution

ExecuteOpenFoam()[source]#

ExecuteOpenFoamPostProcess(functionToCompute)[source]#

ExecuteParallelFoamUtility(foamUtilityName)[source]#

ExecuteSequentialFoamUtility(foamUtilityName)[source]#

GetAppName()[source]#

GetLogFilePath()[source]#

GetResiduals()[source]#

ParseMeshAnalysis()[source]#

PlotFoamQuantities(residualByVariable)[source]#

RetrieveProblemConvergenceIteration(problemName)[source]#

RevertToOriginalNumbering()[source]#

RunInParallel()[source]#

RunInSequential()[source]#

WriteDecompositionStrategy()[source]#

OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.ParseInfoFromLogFile(logFile: str, extraQuantities: Iterable, startingFromLineId: int = 0)[source]#

OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.SkipFoamTest()[source]#