PorousJump

PorousJump#

class PorousJump[source]#

Bases: Flow360BaseModel

PorousJump defines the Porous Jump boundary condition.

Provide a flat list of every face that should be a porous-jump boundary via surfaces. Each face must belong to a multizone interface; the donor/receiver pairing is recovered from the mesh metadata downstream.

Example

>>> fl.PorousJump(
...     surfaces=[
...         volume_mesh["blk-1/Interface-blk-2"],
...         volume_mesh["blk-2/Interface-blk-1"],
...         volume_mesh["blk-1/Interface-blk-3"],
...         volume_mesh["blk-3/Interface-blk-1"],
...     ],
...    darcy_coefficient = 1e6 / fl.u.m **2,
...    forchheimer_coefficient = 1 / fl.u.m,
...    thickness = 1 * fl.u.m,
... )

Deprecated since version The: surface_pairs=[(A, B), ...] pair form is accepted for one more minor release and is rewritten internally into the flat surfaces form. New code should use surfaces= directly.

Attributes

name: str, optional#

Name of the PorousJump boundary condition.

Default:

'PorousJump'

entities: EntityList[Surface, MirroredSurface]#

Flat list of boundaries that form porous-jump interfaces. Each face must belong to a multizone interface; the donor/receiver pairing is recovered from mesh metadata downstream.

darcy_coefficient: Any#

Darcy coefficient of the porous media model which determines the scaling of the viscous loss term. The value defines the coefficient for the axis normal to the surface.

forchheimer_coefficient: Any#

Forchheimer coefficient of the porous media model which determines the scaling of the inertial loss term.

thickness: Any#

Thickness of the thin porous media on the surface

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None