OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface module#

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

class OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFoamGeneralConfig(application: str = 'foamRun', startFrom: str = 'startTime', startTime: float = 0, stopAt: str = 'endTime', endTime: float = 1.0, deltaT: float = 0.1, writeControl: str = 'timeStep', writeInterval: float = 1, purgeWrite: float = 0, writeFormat: str = 'binary', writePrecision: int = 6, writeCompression: str = 'off', timeFormat: str = 'general', timePrecision: int = 6, runTimeModifiable: str = 'true', relativeTolerance: float = 0.0)[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

application: str = 'foamRun'#

deltaT: float = 0.1#

endTime: float = 1.0#

purgeWrite: float = 0#

relativeTolerance: float = 0.0#

runTimeModifiable: str = 'true'#

startFrom: str = 'startTime'#

startTime: float = 0#

stopAt: str = 'endTime'#

timeFormat: str = 'general'#

timePrecision: int = 6#

writeCompression: str = 'off'#

writeControl: str = 'timeStep'#

writeFormat: str = 'binary'#

writeInterval: float = 1#

writePrecision: int = 6#

class OpenPisco.ExternalTools.OpenFoam.OpenFoamInterface.OpenFoamInterface[source]#

Bases: AppExecutableBase

class OpenFoamInterface#

Interface for the finite volume solver OpenFoam

ExecuteOpenFoam()[source]#

ExecuteOpenFoamPostProcess(functionToCompute)[source]#

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