snappy.SurfaceMeshingParams

Contents

snappy.SurfaceMeshingParams#

class SurfaceMeshingParams#

Bases: Flow360BaseModel

Parameters for snappyHexMesh surface meshing.

Attributes

defaults: SurfaceMeshingDefaults#

quality_metrics: QualityMetrics#

Default:: QualityMetrics()

snap_controls: SnapControls#

Default:: SnapControls()

castellated_mesh_controls: CastellatedMeshControls#

Default:: CastellatedMeshControls()

smooth_controls: SmoothControls | Literal[False]#

Default:: SmoothControls()

refinements: list[Annotated[flow360_schema.models.simulation.meshing_param.snappy.snappy_mesh_refinements.BodyRefinement | flow360_schema.models.simulation.meshing_param.snappy.snappy_mesh_refinements.SurfaceEdgeRefinement | flow360_schema.models.simulation.meshing_param.snappy.snappy_mesh_refinements.RegionRefinement | flow360_schema.models.simulation.meshing_param.volume_params.UniformRefinement, FieldInfo(annotation=NoneType, required=True, discriminator='refinement_type')]] | None#

Default:: None

octree_spacing: OctreeSpacing, optional#

Default:: None

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:: filename (str)
Return type:: Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:: methods (bool)
Return type:: None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:

filename (str)
kwargs (Any)

Return type:

None