pybFoam

Top-level package — re-exports the canonical public API from pybFoam.pybFoam_core.

class pybFoam.DictionaryGetOrDefaultProxy
class pybFoam.DictionaryGetProxy
class pybFoam.IOobject(*args, **kwargs)
AUTO_WRITE = 16
MUST_READ = 1
NO_READ = 0
NO_WRITE = 0
READ_IF_PRESENT = 4
class readOption(value)
MUST_READ = 1
NO_READ = 0
READ_IF_PRESENT = 4
class writeOption(value)
AUTO_WRITE = 16
NO_WRITE = 0
pybFoam.Info(arg: str, /) → None
pybFoam.Info(arg: pybFoam.pybFoam_core.dictionary, /) → None
class pybFoam.Pstream
master = <nanobind.nb_func object>
myProcNo = <nanobind.nb_func object>
nProcs = <nanobind.nb_func object>
parRun = <nanobind.nb_func object>
class pybFoam.SolverScalarPerformance(*args, **kwargs)
converged(self) → bool
fieldName(self) → pybFoam.pybFoam_core.Word
finalResidual(self) → float
initialResidual(self) → float
nIterations(self) → int
singular(self) → bool
solverName(self) → pybFoam.pybFoam_core.Word
class pybFoam.SolverSymmTensorPerformance(*args, **kwargs)
converged(self) → bool
fieldName(self) → pybFoam.pybFoam_core.Word
finalResidual(self) → pybFoam.pybFoam_core.symmTensor
initialResidual(self) → pybFoam.pybFoam_core.symmTensor
nIterations(self) → pybFoam.pybFoam_core.SymmTensorInt
singular(self) → bool
solverName(self) → pybFoam.pybFoam_core.Word
class pybFoam.SolverTensorPerformance(*args, **kwargs)
converged(self) → bool
fieldName(self) → pybFoam.pybFoam_core.Word
finalResidual(self) → pybFoam.pybFoam_core.tensor
initialResidual(self) → pybFoam.pybFoam_core.tensor
nIterations(self) → pybFoam.pybFoam_core.TensorInt
singular(self) → bool
solverName(self) → pybFoam.pybFoam_core.Word
class pybFoam.SolverVectorPerformance(*args, **kwargs)
converged(self) → bool
fieldName(self) → pybFoam.pybFoam_core.Word
finalResidual(self) → pybFoam.pybFoam_core.vector
initialResidual(self) → pybFoam.pybFoam_core.vector
nIterations(self) → pybFoam.pybFoam_core.VectorInt
singular(self) → bool
solverName(self) → pybFoam.pybFoam_core.Word
class pybFoam.SymmTensorInt
pybFoam.T(arg: pybFoam.pybFoam_core.volTensorField, /) → pybFoam.pybFoam_core.tmp_volTensorField
pybFoam.T(arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → pybFoam.pybFoam_core.tmp_volTensorField
class pybFoam.TensorInt
class pybFoam.Time(*args, **kwargs)
deltaTValue(self) → float
increment(self) → None
loop(self) → bool
outputTime(self) → bool
printExecutionTime(self) → None
run(self) → bool
setDeltaT(self, newDeltaT: float) → None
setTime(self, arg0: pybFoam.pybFoam_core.instant, arg1: int, /) → None
timeName(self) → pybFoam.pybFoam_core.Word
value(self) → float
write(self, arg: bool, /) → bool
class pybFoam.VectorInt
class pybFoam.Word(*args, **kwargs)
pybFoam.adjustPhi(arg0: pybFoam.pybFoam_core.surfaceScalarField, arg1: pybFoam.pybFoam_core.volVectorField, arg2: pybFoam.pybFoam_core.volScalarField, /) → bool
class pybFoam.argList(*args, **kwargs)
class pybFoam.boolList(*args, **kwargs)
list(self) → list[bool]
pybFoam.bound(arg0: pybFoam.pybFoam_core.volScalarField, arg1: pybFoam.pybFoam_core.dimensionedScalar, /) → pybFoam.pybFoam_core.volScalarField
pybFoam.cbrt(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.cbrt(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.clone_example(name: str, *, prefix: str = 'pybfoam_') → Path[source]

Copy examples/<name>/ to a tmp dir, restoring 0.orig → 0.

pybFoam.computeCFLNumber(arg: pybFoam.pybFoam_core.surfaceScalarField, /) → tuple[float, float]
pybFoam.computeContinuityErrors(phi: pybFoam.pybFoam_core.surfaceScalarField) → tuple[float, float]
pybFoam.constrainHbyA(arg0: pybFoam.pybFoam_core.tmp_volVectorField, arg1: pybFoam.pybFoam_core.volVectorField, arg2: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volVectorField
pybFoam.constrainPressure(p: pybFoam.pybFoam_core.volScalarField, U: pybFoam.pybFoam_core.volVectorField, phiHbyA: pybFoam.pybFoam_core.surfaceScalarField, rAU: pybFoam.pybFoam_core.volScalarField) → None
pybFoam.constrainPressure(p: pybFoam.pybFoam_core.volScalarField, U: pybFoam.pybFoam_core.volVectorField, phiHbyA: pybFoam.pybFoam_core.surfaceScalarField, rAU: pybFoam.pybFoam_core.surfaceScalarField) → None
pybFoam.cos(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.cos(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.createMesh(time: pybFoam.pybFoam_core.Time, autoWrite: bool = False) → pybFoam.pybFoam_core.fvMesh

Create a mesh from a Time object

pybFoam.createPhi(U: pybFoam.pybFoam_core.volVectorField) → pybFoam.pybFoam_core.surfaceScalarField
pybFoam.dev2(arg: pybFoam.pybFoam_core.volSymmTensorField, /) → pybFoam.pybFoam_core.tmp_volSymmTensorField
pybFoam.dev2(arg: pybFoam.pybFoam_core.tmp_volSymmTensorField, /) → pybFoam.pybFoam_core.tmp_volSymmTensorField
pybFoam.dev2(arg: pybFoam.pybFoam_core.volTensorField, /) → pybFoam.pybFoam_core.tmp_volTensorField
pybFoam.dev2(arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → pybFoam.pybFoam_core.tmp_volTensorField
pybFoam.devTwoSymm(arg: pybFoam.pybFoam_core.volTensorField, /) → pybFoam.pybFoam_core.tmp_volSymmTensorField
pybFoam.devTwoSymm(arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → pybFoam.pybFoam_core.tmp_volSymmTensorField
class pybFoam.dictionary(*args, **kwargs)
add(self, arg0: pybFoam.pybFoam_core.entry, arg1: bool, /) → None
add(self, key: str, value: pybFoam.pybFoam_core.Word) → None
add(self, arg0: str, arg1: float, /) → None
add(self, arg0: str, arg1: pybFoam.pybFoam_core.vector, /) → None
add(self, arg0: str, arg1: pybFoam.pybFoam_core.tensor, /) → None
add(self, arg0: str, arg1: pybFoam.pybFoam_core.wordList, /) → None
add(self, arg0: str, arg1: pybFoam.pybFoam_core.scalarField, /) → None
add(self, arg0: str, arg1: pybFoam.pybFoam_core.vectorField, /) → None
add(self, arg0: str, arg1: pybFoam.pybFoam_core.tensorField, /) → None
clear(self) → None
found(self, arg: str, /) → bool
property get

(self) -> DictionaryGetProxy

property getOrDefault

(self) -> DictionaryGetOrDefaultProxy

get_scalar(self, arg: str, /) → float
get_scalarField(self, arg: str, /) → pybFoam.pybFoam_core.scalarField
get_tensor(self, arg: str, /) → pybFoam.pybFoam_core.tensor
get_tensorField(self, arg: str, /) → pybFoam.pybFoam_core.tensorField
get_vector(self, arg: str, /) → pybFoam.pybFoam_core.vector
get_vectorField(self, arg: str, /) → pybFoam.pybFoam_core.vectorField
get_word(self, arg: str, /) → pybFoam.pybFoam_core.Word
get_wordList(self, arg: str, /) → pybFoam.pybFoam_core.wordList
isDict(self, arg: str, /) → bool
lookupSolverPerformanceScalarList(self, arg: str, /) → list[pybFoam.pybFoam_core.SolverScalarPerformance]
lookupSolverPerformanceTensorList(self, arg: str, /) → list[pybFoam.pybFoam_core.SolverTensorPerformance]
lookupSolverPerformanceVectorList(self, arg: str, /) → list[pybFoam.pybFoam_core.SolverVectorPerformance]
print(self) → None
read = <nanobind.nb_func object>
set(self, arg0: str, arg1: pybFoam.pybFoam_core.Word, /) → None
set(self, arg0: str, arg1: bool, /) → None
set(self, arg0: str, arg1: float, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.vector, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.tensor, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.wordList, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.scalarField, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.vectorField, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.tensorField, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.labelList, /) → None
set(self, arg0: str, arg1: pybFoam.pybFoam_core.dictionary, /) → None
subDict(self, arg: str, /) → pybFoam.pybFoam_core.dictionary
subDictOrAdd(self, arg: str, /) → pybFoam.pybFoam_core.dictionary
toc(self) → pybFoam.pybFoam_core.wordList
write(self, arg: str, /) → None
class pybFoam.dimensionSet(*args, **kwargs)
class pybFoam.dimensionedScalar(*args, **kwargs)
dimensions(self) → pybFoam.pybFoam_core.dimensionSet
name(self) → str
value(self) → float
class pybFoam.dimensionedSymmTensor(*args, **kwargs)
dimensions(self) → pybFoam.pybFoam_core.dimensionSet
name(self) → str
value(self) → pybFoam.pybFoam_core.symmTensor
class pybFoam.dimensionedTensor(*args, **kwargs)
dimensions(self) → pybFoam.pybFoam_core.dimensionSet
name(self) → str
value(self) → pybFoam.pybFoam_core.tensor
class pybFoam.dimensionedVector(*args, **kwargs)
dimensions(self) → pybFoam.pybFoam_core.dimensionSet
name(self) → str
value(self) → pybFoam.pybFoam_core.vector
pybFoam.doubleInner(arg0: pybFoam.pybFoam_core.volTensorField, arg1: pybFoam.pybFoam_core.volSymmTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.doubleInner(arg0: pybFoam.pybFoam_core.volTensorField, arg1: pybFoam.pybFoam_core.tmp_volSymmTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
class pybFoam.dynamicFvMesh
New = <nanobind.nb_func object>
controlledUpdateMesh(self) → bool
dynamic(self) → bool
updateMesh(self) → bool
class pybFoam.entry
pybFoam.examples_root() → Path[source]

Path to the repo’s examples/ directory.

pybFoam.exp(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.exp(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
class pybFoam.fileName(*args, **kwargs)
class pybFoam.fvMesh(*args, **kwargs)
C(self) → pybFoam.pybFoam_core.volVectorField
Cf(self) → pybFoam.pybFoam_core.surfaceVectorField
Sf(self) → pybFoam.pybFoam_core.surfaceVectorField
V(self) → pybFoam.pybFoam_core.scalarField
boundary(self) → pybFoam.pybFoam_core.fvBoundaryMesh
changing(self) → bool
fromPolyMesh = <nanobind.nb_func object>
magSf(self) → pybFoam.pybFoam_core.surfaceScalarField
nCells(self) → int
nFaces(self) → int
nInternalFaces(self) → int
nPoints(self) → int
setFluxRequired(self, arg: pybFoam.pybFoam_core.Word, /) → None
solverPerformanceDict(self) → pybFoam.pybFoam_core.dictionary
time(self) → pybFoam.pybFoam_core.Time
write(self) → bool

Write mesh to disk

class pybFoam.fvScalarMatrix(*args, **kwargs)
A(self) → pybFoam.pybFoam_core.tmp_volScalarField
D(self) → pybFoam.pybFoam_core.tmp_scalarField
H(self) → pybFoam.pybFoam_core.tmp_volScalarField
H1(self) → pybFoam.pybFoam_core.tmp_volScalarField
flux(self) → pybFoam.pybFoam_core.tmp_surfaceScalarField
relax(self, arg: float, /) → None
relax(self) → None
setReference(self, arg0: int, arg1: float, arg2: bool, /) → None
solve(self) → None
solve(self, arg: pybFoam.pybFoam_core.Word, /) → None
source(self) → pybFoam.pybFoam_core.scalarField
class pybFoam.fvSymmTensorMatrix(*args, **kwargs)
A(self) → pybFoam.pybFoam_core.tmp_volScalarField
D(self) → pybFoam.pybFoam_core.tmp_scalarField
H(self) → pybFoam.pybFoam_core.tmp_volSymmTensorField
H1(self) → pybFoam.pybFoam_core.tmp_volScalarField
flux(self) → pybFoam.pybFoam_core.tmp_surfaceSymmTensorField
relax(self, arg: float, /) → None
relax(self) → None
setReference(self, arg0: int, arg1: pybFoam.pybFoam_core.symmTensor, arg2: bool, /) → None
solve(self) → None
solve(self, arg: pybFoam.pybFoam_core.Word, /) → None
source(self) → pybFoam.pybFoam_core.symmTensorField
class pybFoam.fvTensorMatrix(*args, **kwargs)
A(self) → pybFoam.pybFoam_core.tmp_volScalarField
D(self) → pybFoam.pybFoam_core.tmp_scalarField
H(self) → pybFoam.pybFoam_core.tmp_volTensorField
H1(self) → pybFoam.pybFoam_core.tmp_volScalarField
flux(self) → pybFoam.pybFoam_core.tmp_surfaceTensorField
relax(self, arg: float, /) → None
relax(self) → None
setReference(self, arg0: int, arg1: pybFoam.pybFoam_core.tensor, arg2: bool, /) → None
solve(self) → None
solve(self, arg: pybFoam.pybFoam_core.Word, /) → None
source(self) → pybFoam.pybFoam_core.tensorField
class pybFoam.fvVectorMatrix(*args, **kwargs)
A(self) → pybFoam.pybFoam_core.tmp_volScalarField
D(self) → pybFoam.pybFoam_core.tmp_scalarField
H(self) → pybFoam.pybFoam_core.tmp_volVectorField
H1(self) → pybFoam.pybFoam_core.tmp_volScalarField
flux(self) → pybFoam.pybFoam_core.tmp_surfaceVectorField
relax(self, arg: float, /) → None
relax(self) → None
setReference(self, arg0: int, arg1: pybFoam.pybFoam_core.vector, arg2: bool, /) → None
solve(self) → None
solve(self, arg: pybFoam.pybFoam_core.Word, /) → None
source(self) → pybFoam.pybFoam_core.vectorField
class pybFoam.instant
class pybFoam.instantList
class iterator
class pybFoam.keyType(*args, **kwargs)
class pybFoam.labelList(*args, **kwargs)
class iterator
list(self) → list[int]
pybFoam.log(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.log(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.log10(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.log10(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: float, /) → float
pybFoam.mag(arg: pybFoam.pybFoam_core.vector, /) → float
pybFoam.mag(arg: pybFoam.pybFoam_core.tensor, /) → float
pybFoam.mag(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.vectorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_vectorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_tensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.symmTensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_symmTensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.volVectorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_volVectorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.volTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.volSymmTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_volSymmTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.surfaceScalarField, /) → pybFoam.pybFoam_core.tmp_surfaceScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_surfaceScalarField, /) → pybFoam.pybFoam_core.tmp_surfaceScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.surfaceVectorField, /) → pybFoam.pybFoam_core.tmp_surfaceScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_surfaceVectorField, /) → pybFoam.pybFoam_core.tmp_surfaceScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.surfaceTensorField, /) → pybFoam.pybFoam_core.tmp_surfaceScalarField
pybFoam.mag(arg: pybFoam.pybFoam_core.tmp_surfaceTensorField, /) → pybFoam.pybFoam_core.tmp_surfaceScalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.vectorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tmp_vectorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tmp_tensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.symmTensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tmp_symmTensorField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tmp_volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.volVectorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tmp_volVectorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.volTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.magSqr(arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.max(arg0: pybFoam.pybFoam_core.volScalarField, arg1: pybFoam.pybFoam_core.dimensionedScalar, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.max(arg0: pybFoam.pybFoam_core.volScalarField, arg1: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.max(arg0: pybFoam.pybFoam_core.volScalarField, arg1: float, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.max(arg0: pybFoam.pybFoam_core.tmp_volScalarField, arg1: pybFoam.pybFoam_core.dimensionedScalar, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.max(arg0: pybFoam.pybFoam_core.tmp_volScalarField, arg1: float, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.min(arg0: pybFoam.pybFoam_core.volScalarField, arg1: pybFoam.pybFoam_core.dimensionedScalar, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.min(arg0: pybFoam.pybFoam_core.volScalarField, arg1: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.min(arg0: pybFoam.pybFoam_core.volScalarField, arg1: float, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.min(arg0: pybFoam.pybFoam_core.tmp_volScalarField, arg1: float, /) → pybFoam.pybFoam_core.tmp_volScalarField
class pybFoam.nearWallDist(*args, **kwargs)
correct(self) → None
class pybFoam.nearWallDistNoSearch(*args, **kwargs)
correct(self) → None
pybFoam.neg(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.neg(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
class pybFoam.pimpleControl(*args, **kwargs)
correct(self) → bool
correctNonOrthogonal(self) → bool
finalInnerIter(self) → bool
finalIter(self) → bool
finalNonOrthogonalIter(self) → bool
loop(self) → bool
momentumPredictor(self) → bool
nNonOrthCorr(self) → int
turbCorr(self) → bool
class pybFoam.pisoControl(*args, **kwargs)
correct(self) → bool
correctNonOrthogonal(self) → bool
finalInnerIter(self) → bool
finalNonOrthogonalIter(self) → bool
momentumPredictor(self) → bool
nNonOrthCorr(self) → int
class pybFoam.polyBoundaryMesh
findPatchID(self, arg: pybFoam.pybFoam_core.Word, /) → int
size(self) → int
class pybFoam.polyMesh(*args, **kwargs)
addPatches(self, patches: collections.abc.Sequence[pybFoam.pybFoam_core.polyPatch], validBoundary: bool = True) → None
boundaryMesh(self) → pybFoam.pybFoam_core.polyBoundaryMesh
faces(self) → pybFoam.pybFoam_core.faceList
facesInstance(self) → pybFoam.pybFoam_core.fileName
property meshSubDir

(self) -> Foam::word

nCells(self) → int
nFaces(self) → int
nInternalFaces(self) → int
nPoints(self) → int
neighbour(self) → pybFoam.pybFoam_core.labelList
owner(self) → pybFoam.pybFoam_core.labelList
points(self) → pybFoam.pybFoam_core.vectorField
removeBoundary(self) → None

Remove boundary patches from mesh

write(self) → bool
class pybFoam.polyPatch(*args, **kwargs)
name(self) → pybFoam.pybFoam_core.Word
size(self) → int
start(self) → int
type(self) → pybFoam.pybFoam_core.Word
pybFoam.pos(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.pos(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.pow(arg0: pybFoam.pybFoam_core.volScalarField, arg1: float, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.pow(arg0: pybFoam.pybFoam_core.tmp_volScalarField, arg1: float, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.pow3(arg: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.pow3(arg: pybFoam.pybFoam_core.tmp_volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.pow6(arg: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.pow6(arg: pybFoam.pybFoam_core.tmp_volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.pyvista_read(case: str | Path, *, time: float | None = None, cell_arrays: Iterable[str] | None = None) → pv.POpenFOAMReader[source]

Read an OpenFOAM case via pyvista (fields must be on disk).

class pybFoam.scalarField(*args, **kwargs)
pybFoam.selectTimes(arg0: pybFoam.pybFoam_core.Time, arg1: collections.abc.Sequence[str], /) → pybFoam.pybFoam_core.instantList
pybFoam.setRefCell(p: pybFoam.pybFoam_core.volScalarField, dict: pybFoam.pybFoam_core.dictionary, forceReference: bool = False) → tuple[int, float]
pybFoam.sign(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.sign(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
class pybFoam.simpleControl(*args, **kwargs)
correctNonOrthogonal(self) → bool
finalNonOrthogonalIter(self) → bool
loop(self) → bool
momentumPredictor(self) → bool
nNonOrthCorr(self) → int
pybFoam.sin(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.sin(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.skew(arg: pybFoam.pybFoam_core.volTensorField, /) → pybFoam.pybFoam_core.tmp_volTensorField
pybFoam.skew(arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → pybFoam.pybFoam_core.tmp_volTensorField
pybFoam.solve(arg: pybFoam.pybFoam_core.fvScalarMatrix, /) → pybFoam.pybFoam_core.SolverScalarPerformance
pybFoam.solve(arg: pybFoam.pybFoam_core.tmp_fvScalarMatrix, /) → pybFoam.pybFoam_core.SolverScalarPerformance
pybFoam.solve(arg: pybFoam.pybFoam_core.fvVectorMatrix, /) → pybFoam.pybFoam_core.SolverVectorPerformance
pybFoam.solve(arg: pybFoam.pybFoam_core.tmp_fvVectorMatrix, /) → pybFoam.pybFoam_core.SolverVectorPerformance
pybFoam.solve(arg: pybFoam.pybFoam_core.fvTensorMatrix, /) → pybFoam.pybFoam_core.SolverTensorPerformance
pybFoam.solve(arg: pybFoam.pybFoam_core.tmp_fvTensorMatrix, /) → pybFoam.pybFoam_core.SolverTensorPerformance
pybFoam.solve(arg: pybFoam.pybFoam_core.fvSymmTensorMatrix, /) → pybFoam.pybFoam_core.SolverSymmTensorPerformance
pybFoam.solve(arg: pybFoam.pybFoam_core.tmp_fvSymmTensorMatrix, /) → pybFoam.pybFoam_core.SolverSymmTensorPerformance
pybFoam.sqr(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.sqr(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.sqr(arg: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.sqr(arg: pybFoam.pybFoam_core.tmp_volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.sqrt(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.sqrt(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.sqrt(arg: pybFoam.pybFoam_core.volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.sqrt(arg: pybFoam.pybFoam_core.tmp_volScalarField, /) → pybFoam.pybFoam_core.tmp_volScalarField
pybFoam.sum(arg: pybFoam.pybFoam_core.scalarField, /) → float
pybFoam.sum(arg: pybFoam.pybFoam_core.vectorField, /) → pybFoam.pybFoam_core.vector
pybFoam.sum(arg: pybFoam.pybFoam_core.tensorField, /) → pybFoam.pybFoam_core.tensor
pybFoam.sum(arg: pybFoam.pybFoam_core.symmTensorField, /) → pybFoam.pybFoam_core.symmTensor
class pybFoam.surfaceScalarField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.surfaceScalarField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_surfaceScalarField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.scalarField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
class pybFoam.surfaceSymmTensorField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.surfaceSymmTensorField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_surfaceSymmTensorField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.symmTensorField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
class pybFoam.surfaceTensorField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.surfaceTensorField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_surfaceTensorField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.tensorField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
class pybFoam.surfaceVectorField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.surfaceVectorField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_surfaceVectorField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.vectorField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
pybFoam.symm(arg: pybFoam.pybFoam_core.volTensorField, /) → pybFoam.pybFoam_core.tmp_volSymmTensorField
pybFoam.symm(arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → pybFoam.pybFoam_core.tmp_volSymmTensorField
class pybFoam.symmTensor(*args, **kwargs)
class pybFoam.symmTensorField(*args, **kwargs)
pybFoam.tan(arg: pybFoam.pybFoam_core.scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
pybFoam.tan(arg: pybFoam.pybFoam_core.tmp_scalarField, /) → pybFoam.pybFoam_core.tmp_scalarField
class pybFoam.tensor(*args, **kwargs)
class pybFoam.tensorField(*args, **kwargs)
class pybFoam.tmp_fvScalarMatrix
class pybFoam.tmp_fvSymmTensorMatrix
class pybFoam.tmp_fvTensorMatrix
class pybFoam.tmp_fvVectorMatrix
class pybFoam.tmp_scalarField
class iterator
class pybFoam.tmp_surfaceScalarField
ref(self) → pybFoam.pybFoam_core.surfaceScalarField
class pybFoam.tmp_surfaceSymmTensorField
ref(self) → pybFoam.pybFoam_core.surfaceSymmTensorField
class pybFoam.tmp_surfaceTensorField
ref(self) → pybFoam.pybFoam_core.surfaceTensorField
class pybFoam.tmp_surfaceVectorField
ref(self) → pybFoam.pybFoam_core.surfaceVectorField
class pybFoam.tmp_symmTensorField
class pybFoam.tmp_tensorField
class pybFoam.tmp_vectorField
class pybFoam.tmp_volScalarField
ref(self) → pybFoam.pybFoam_core.volScalarField
class pybFoam.tmp_volSymmTensorField
ref(self) → pybFoam.pybFoam_core.volSymmTensorField
class pybFoam.tmp_volTensorField
ref(self) → pybFoam.pybFoam_core.volTensorField
class pybFoam.tmp_volVectorField
ref(self) → pybFoam.pybFoam_core.volVectorField
class pybFoam.uniformDimensionedScalarField(*args, **kwargs)
dimensions(self) → pybFoam.pybFoam_core.dimensionSet

Get the field dimensions

name(self) → pybFoam.pybFoam_core.Word

Get the field name

value(self) → float

Get the uniform scalar value

class pybFoam.uniformDimensionedVectorField(*args, **kwargs)
dimensions(self) → pybFoam.pybFoam_core.dimensionSet

Get the field dimensions

name(self) → pybFoam.pybFoam_core.Word

Get the field name

value(self) → pybFoam.pybFoam_core.vector

Get the uniform vector value

class pybFoam.vector(*args, **kwargs)
class pybFoam.vectorField(*args, **kwargs)
class pybFoam.volScalarField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.volScalarField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_volScalarField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.scalarField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
class pybFoam.volSymmTensorField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.volSymmTensorField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_volSymmTensorField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.symmTensorField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
class pybFoam.volTensorField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.volTensorField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_volTensorField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.tensorField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
class pybFoam.volVectorField(*args, **kwargs)
assign(self, arg: pybFoam.pybFoam_core.volVectorField, /) → None
assign(self, arg: pybFoam.pybFoam_core.tmp_volVectorField, /) → None
correctBoundaryConditions(self) → None
from_registry = <nanobind.nb_func object>
internalField(self) → pybFoam.pybFoam_core.vectorField
list_objects = <nanobind.nb_func object>
mesh(self) → pybFoam.pybFoam_core.fvMesh
name(self) → str
read_field = <nanobind.nb_func object>
relax(self) → None
relax(self, arg: float, /) → None
select(self, arg: bool, /) → pybFoam.pybFoam_core.Word
class pybFoam.wallDist
New = <nanobind.nb_func object>
n(self) → pybFoam.pybFoam_core.volVectorField
y(self) → pybFoam.pybFoam_core.volScalarField
class pybFoam.wordList(*args, **kwargs)
class iterator
list(self) → list[str]
pybFoam.write(arg: pybFoam.pybFoam_core.volScalarField, /) → None
pybFoam.write(arg: pybFoam.pybFoam_core.volVectorField, /) → None
pybFoam.write(arg: pybFoam.pybFoam_core.volTensorField, /) → None
pybFoam.write(arg: pybFoam.pybFoam_core.volSymmTensorField, /) → None
pybFoam.write(arg: pybFoam.pybFoam_core.surfaceScalarField, /) → None
pybFoam.write(arg: pybFoam.pybFoam_core.surfaceVectorField, /) → None
pybFoam.write(arg: pybFoam.pybFoam_core.surfaceTensorField, /) → None
pybFoam.write(arg: pybFoam.pybFoam_core.surfaceSymmTensorField, /) → None