API Reference

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

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

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)

class pybFoam.argList(*args, **kwargs)

class pybFoam.boolList(*args, **kwargs)

list(self) → list[bool]

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

class pybFoam.dynamicFvMesh

New = <nanobind.nb_func object>

controlledUpdateMesh(self) → bool

dynamic(self) → bool

updateMesh(self) → bool

class pybFoam.entry

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

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

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

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

class pybFoam.instant

class pybFoam.instantList

class pybFoam.keyType(*args, **kwargs)

class pybFoam.labelList(*args, **kwargs)

list(self) → list[int]

class pybFoam.nearWallDist(*args, **kwargs)

correct(self) → None

class pybFoam.nearWallDistNoSearch(*args, **kwargs)

correct(self) → None

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

class pybFoam.scalarField(*args, **kwargs)

class pybFoam.simpleControl(*args, **kwargs)

correctNonOrthogonal(self) → bool

finalNonOrthogonalIter(self) → bool

loop(self) → bool

momentumPredictor(self) → bool

nNonOrthCorr(self) → int

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

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

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

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

read_field = <nanobind.nb_func object>

relax(self) → None

relax(self, arg: float, /) → None

select(self, arg: bool, /) → pybFoam.pybFoam_core.Word

class pybFoam.symmTensor(*args, **kwargs)

class pybFoam.symmTensorField(*args, **kwargs)

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 pybFoam.tmp_surfaceScalarField

class pybFoam.tmp_surfaceSymmTensorField

class pybFoam.tmp_surfaceTensorField

class pybFoam.tmp_surfaceVectorField

class pybFoam.tmp_symmTensorField

class pybFoam.tmp_tensorField

class pybFoam.tmp_vectorField

class pybFoam.tmp_volScalarField

class pybFoam.tmp_volSymmTensorField

class pybFoam.tmp_volTensorField

class pybFoam.tmp_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

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

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

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

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)

list(self) → list[str]