snappy.CastellatedMeshControls

class CastellatedMeshControls

Bases: Flow360BaseModel

snappyHexMesh castellation controls.

Attributes

resolve_feature_angle: AngleType.Positive

This parameter controls the local curvature refinement. The higher the value, the less features it captures. Applies maximum level of refinement to cells that can see intersections whose angle exceeds this value.

Default:

25 * fl.u.degree

n_cells_between_levels: int

This parameter controls the transition between cell refinement levels. Number of buffer layers of cells between different levels of refinement.

Default:

1

min_refinement_cells: int

The refinement along the surfaces may spend many iterations on refinement of only few cells. Whenever the number of cells to be refined is less than or equal to this value, the refinement will stop. Unless the parameter is set to zero, at least one refining iteration will be performed.

Default:

10

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