luminarycloud.meshing

Submodules

Classes

BoundaryLayerParams

Boundary layer meshing parameters.

MeshAdaptationParams

Parameters used to create a new mesh with mesh adaptation.

MeshGenerationParams

Mesh generation parameters.

ModelMeshingParams

Model meshing parameters.

RefinementRegion

Refinement region parameters.

VolumeMeshingParams

Volume meshing parameters.

Package Contents

class luminarycloud.meshing.BoundaryLayerParams

Boundary layer meshing parameters.

growth_rate: float = 1.2

Ratio of size between 2 successive boundary mesh layers; should be >= 1.0.

initial_size: float = 1e-06

Size of the mesh layer nearest the boundary surface in meters; should be > 0.0

n_layers: int = 40

Maximum number of layers within a boundary layer mesh; should be > 0.

surfaces: list[luminarycloud.params.geometry.Surface | str]

The surfaces to mesh

class luminarycloud.meshing.MeshAdaptationParams(source_simulation_id: str, target_cv_count: int, h_ratio: float, aspect_ratio: float = 0.0)

Parameters used to create a new mesh with mesh adaptation.

Attributes:
source_simulation_idstr

(Required) The simluation ID of a previously completed simulation. The source simulation will be used to extract the input mesh and mesh adaptation sensor from the solution.

target_cv_countint

(Required) Target count of mesh CVs.

h_ratiofloat

(Required) Boundary layer scaling.

aspect_ratiofloat

(Optional) Cell aspect ratio limit.

aspect_ratio: float
h_ratio: float
source_simulation_id: luminarycloud.types.SimulationID
target_cv_count: int
class luminarycloud.meshing.MeshGenerationParams

Mesh generation parameters.

add_refinement: bool = False

If true, automatically adds a refinement region around the body

body_x_axis: luminarycloud.types.Vector3

The x-axis of the body

body_y_axis: luminarycloud.types.Vector3

The y-axis of the body

boundary_layer_params: list[BoundaryLayerParams] = []

Custom meshing parameters for boundary layers. Overrides default meshing parameters.

geometry_id: str

The ID of the geometry to generate a mesh for

max_size: float = 512

The default maximum mesh element size in meters; should be > 0.0

min_size: float = 0.0001

The default minimum mesh element size in meters; should be > 0.0

model_meshing_params: list[ModelMeshingParams] = []

Custom meshing parameters for models. Overrides default meshing parameters.

proximity_layers: int = 1

The number of proximity layers

refinement_regions: list[RefinementRegion] = []

Refinement regions

sizing_strategy: luminarycloud.meshing.sizing_strategy.SizingStrategy

The sizing strategy to use

volume_meshing_params: list[VolumeMeshingParams] = []

Custom meshing parameters for volumes. Overrides default meshing parameters.

class luminarycloud.meshing.ModelMeshingParams

Model meshing parameters.

curvature: float = 8

Geometric control of the CAD edges and faces in degrees; should be > 0.0.

max_size: float = 4.5

The maximum mesh element size in meters for elements that are part of the model; should be > 0.0.

surfaces: list[luminarycloud.params.geometry.Surface | str]

The surfaces to mesh

class luminarycloud.meshing.RefinementRegion

Refinement region parameters.

h_limit: float

length scale limit in refinement region in meters

name: str

The name of the refinement region

shape: luminarycloud.params.geometry.Shape | None = None

The shape of the refinement region

class luminarycloud.meshing.VolumeMeshingParams

Volume meshing parameters.

max_size: float

The maximum mesh element size in meters; should be > 0.0

min_size: float

The minimum mesh element size in meters; should be > 0.0

volumes: list[luminarycloud.params.geometry.Volume]

The volumes to mesh