snappy.SnapControls

class SnapControls

Bases: Flow360BaseModel

snappyHexMesh snap controls.

Attributes

n_smooth_patch: int

Number of patch smoothing iterations before finding correspondence to surface.

Default:

3

tolerance: float

Ratio of distance for points to be attracted by surface feature point or edge, to local maximum edge length.

Default:

2

n_solve_iterations: int

Number of mesh displacement relaxation iterations.

Default:

30

n_relax_iterations: int

Number of relaxation iterations during the snapping. If the mesh does not conform the geometry and all the iterations are spend, user may try to increase the number of iterations.

Default:

5

n_feature_snap_iterations: int

Number of relaxation iterations used for snapping onto the features. If not specified, feature snapping will be disabled.

Default:

15

multi_region_feature_snap: bool

When using explicitFeatureSnap and this switch is on, features between multiple surfaces will be captured. This is useful for multi-region meshing where the internal mesh must conform the region geometrical boundaries.

Default:

True

strict_region_snap: bool

Attract points only to the surface they originate from. This can improve snapping of intersecting surfaces.

Default:

False

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