UserDefinedFarfield

class UserDefinedFarfield

Bases: _FarfieldBase

Setting for user defined farfield zone generation. This means the “farfield” boundaries are coming from the supplied geometry file and meshing will take place inside this “geometry”.

Important: By default, the volume mesher will grow boundary layers on UserDefinedFarfield. Use PassiveSpacing to project or disable boundary layer growth.

Example

>>> fl.UserDefinedFarfield(name="InnerChannel")

---

Attributes

domain_type: Literal['half_body_positive_y', 'half_body_negative_y', 'full_body'], optional

- half_body_positive_y: Trim to a half-model by slicing with the global Y=0 plane; keep the ‘+y’ side for meshing and simulation. - half_body_negative_y: Trim to a half-model by slicing with the global Y=0 plane; keep the ‘-y’ side for meshing and simulation. - full_body: Keep the full body for meshing and simulation without attempting to add symmetry planes. Warning: When using AutomatedFarfield or UserDefinedFarfield, setting domain_type overrides automatic symmetry plane detection.

Default:

None

name: str, optional

Default:

None

Properties

symmetry_plane: GhostSurface

Returns the symmetry plane boundary surface.

Warning: This should only be used when using GAI and beta mesher.

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')