VolumeMeshingParams

class VolumeMeshingParams

Bases: Flow360BaseModel

Volume meshing parameters.

Attributes

defaults: VolumeMeshingDefaults

refinement_factor: float, optional

All spacings in refinement regionsand first layer thickness will be adjusted to generate r-times finer mesh where r is the refinement_factor value.

Default:

1

refinements: list[UniformRefinement | AxisymmetricRefinement | BoundaryLayer | PassiveSpacing | StructuredBoxRefinement]

Additional fine-tunning for refinements on top of the global settings

Default:

[]

planar_face_tolerance: float

Tolerance used for detecting planar faces in the input surface mesh that need to be remeshed, such as symmetry planes. This tolerance is non-dimensional, and represents a distance relative to the largest dimension of the bounding box of the input surface mesh. This is only supported by the beta mesher and can not be overridden per face.

Default:

1e-06

gap_treatment_strength: float, optional

Narrow gap treatment strength used when two surfaces are in close proximity. Use a value between 0 and 1, where 0 is no treatment and 1 is the most conservative treatment. This parameter has a global impact where the anisotropic transition into the isotropic mesh. However the impact on regions without close proximity is negligible. The beta mesher uses a conservative default value of 1.0.

Default:

None

sliding_interface_tolerance: float

Tolerance used for detecting / creating curves in the input surface mesh / geometry lying on sliding interfaces. This tolerance is non-dimensional, and represents a distance relative to the smallest radius of all sliding interfaces specified in meshing parameters. This cannot be overridden per sliding interface.

Default:

0.01

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