SurfaceRefinement

class SurfaceRefinement

Bases: Flow360BaseModel

Setting for refining surface elements for given Surface.

Example

>>> fl.SurfaceRefinement(
...     faces=[geometry["face1"], geometry["face2"]],
...     max_edge_length=0.001*fl.u.m
... )

---

Attributes

name: str, optional

Default:

'Surface refinement'

entities: EntityList[Surface, MirroredSurface, WindTunnelGhostSurface, GhostSurface, GhostCircularPlane]

max_edge_length: LengthType.Positive, optional

Maximum edge length of surface cells.

Default:

None

curvature_resolution_angle: AngleType.Positive, optional

Default maximum angular deviation in degrees. This value will restrict the angle between a cell’s normal and its underlying surface normal.

Default:

None

resolve_face_boundaries: bool, optional

Flag to specify whether boundaries between adjacent faces should be resolved accurately during the surface meshing process using anisotropic mesh refinement.

Default:

None

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