snappy.SurfaceEdgeRefinement

class SurfaceEdgeRefinement

Bases: Flow360BaseModel

Edge refinement for bodies and regions in snappyHexMesh.

Attributes

spacing: LengthType.PositiveArray | LengthType.Positive, optional

Spacing on and close to the edges. Defaults to default min_spacing.

Default:

None

distances: LengthType.PositiveArray, optional

Distance from the edge where the spacing will be applied.

Default:

None

min_elem: int, optional

Minimum number of elements on the edge to apply the edge refinement.

Default:

None

min_len: LengthType.NonNegative, optional

Minimum length of the edge to apply edge refinement.

Default:

None

included_angle: AngleType.Positive

If the angle between two elements is less than this value, the edge is extracted as a feature.

Default:

150 * degree

entities: EntityList[SnappyBody, Surface]

Default:

None

retain_on_smoothing: bool

Maintain the edge when smoothing is applied.

Default:

True

geometric_test_only: bool

If enabled, only geometric tests are performed on the edge (region edge will be ignored).

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