PorousJump

class PorousJump

Bases: Flow360BaseModel

PorousJump defines the Porous Jump boundary condition.

Example

Define a porous jump condition:

>>> fl.PorousJump(
...     surface_pairs=[
...         (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,
... )

---

Attributes

name: str, optional

Name of the PorousJump boundary condition.

Default:

'PorousJump'

entity_pairs: UniqueItemList[SurfacePair]

List of matching pairs of Surface.

darcy_coefficient: InverseAreaType

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: InverseLengthType

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

thickness: LengthType

Thickness of the thin porous media on the surface

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')