UniformRefinement

class UniformRefinement

Bases: Flow360BaseModel

Uniform spacing refinement inside specified region of mesh.

Example

>>> fl.UniformRefinement(
...     entities=[cylinder, box, axisymmetric_body],
...     spacing=1*fl.u.cm
... )

---

Attributes

name: str, optional

Default:

'Uniform refinement'

entities: EntityList[Box, Cylinder, AxisymmetricBody]

UniformRefinement can be applied to Box, Cylinder, and AxisymmetricBody regions.

spacing: LengthType.Positive

The required refinement spacing.

project_to_surface: bool, optional

Whether to include the refinement in the surface mesh. Defaults to True when using snappy.

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