Functions
void	chi_lua::chiVolumeMesherSetupOrthogonalBoundaries ()

void	chi_lua::chiVolumeMesherCreate (int Type, varying OtherArgs)

void	chi_lua::chiVolumeMesherSetProperty (int PropertyIndex, varying PropertyValue)

void	chi_lua::chiVolumeMesherSetKBAPartitioningPxPyPz (int Px, int Py, int Pz)

void	chi_lua::chiVolumeMesherSetKBACutsX ()

void	chi_lua::chiVolumeMesherSetKBACutsY ()

void	chi_lua::chiVolumeMesherSetKBACutsZ ()

void	chi_lua::chiVolumeMesherSetMatIDToAll (int material_id)

void	chi_lua::chiVolumeMesherExecute ()

Detailed Description

General Concepts

A volume mesher generates cells (chi_mesh::Cell) which can be either 2D polygons (chi_mesh::CellPolygon) or 3D polyhedrons (chi_mesh::CellPolyhedron). All cell objects are pushed into a vector located in a chi_mesh::MeshContinuum after creation. Right now only a single continuum can be operated on and this is normally by means of attaching a region to a solver.

Right now 2D meshes can be partitioned but the full 2D cell geometry exists on each processor. This is mostly because of the way the extruder works. This means that for a 2D problem a continuum will have ALL of the cells (as fully defined cells), in every process, in the member vector "cells" of the continuum. The same can not be said for 3D extruded meshes where each process has all the nodes but if cells are not local then only placeholders are uploaded. Placeholders are basically the base class chi_mesh::Cell and contains only the cell's partition_id and its centroid. The concept that these placeholders are uploaded allows a sweeping order to figure out dependencies. A similar strategy would have to be devised for using third-party meshes.

Global mesh references are maintained in chi_mesh::MeshContinuum::cells. This contains the actual mesh object. Local indices are stored in chi_mesh::MeshContinuum::local_cell_glob_indices and are the global indices of local cells. Conversely the local indices, given a global index, are stored in chi_mesh::MeshContinuum::glob_cell_local_indices.

Extruder Mesher

Function Documentation

◆ chiVolumeMesherCreate()

void chi_lua::chiVolumeMesherCreate	(	int	Type,
		varying	OtherArgs
	)

Creates a new volume mesher.

Parameters

Type	int Volume Remesher type.
OtherArgs	varying Additional arguments depending on `Type`.

Remesher types:
VOLUMEMESHER_EXTRUDER = Creates an extruded mesh from a 2D template mesh. Requires two additional arguments. TemplateType and handle. See below.
VOLUMEMESHER_UNPARTITIONED = Create the mesh from the latest UnpartitionedMesh. Requires a single additional argument, handle, which is a handle to a valid unpartitioned mesh.

_

Extruder parameters

When the mesher type is specified to be VOLUMEMESHER_EXTRUDER then two additional arguments are required. TemplateType and handle.

TemplateType can for now only be ExtruderTemplateType.UNPARTITIONED_MESH.
handle is a handle to the template mesh. When TemplateType is set to ExtruderTemplateType.UNPARTITIONED_MESH then the handle must point to a valid unpartitioned mesh.

Author: Jan

Definition at line 1646 of file lua_functions.c.

◆ chiVolumeMesherExecute()

void chi_lua::chiVolumeMesherExecute ( )

Executes the volume meshing pipeline.

Author: Jan

Definition at line 1848 of file lua_functions.c.

◆ chiVolumeMesherSetKBACutsX()

void chi_lua::chiVolumeMesherSetKBACutsX ( )

Sets the x-cuts for KBA type partitioning with a lua array.

Definition at line 1784 of file lua_functions.c.

◆ chiVolumeMesherSetKBACutsY()

void chi_lua::chiVolumeMesherSetKBACutsY ( )

Sets the y-cuts for KBA type partitioning with a lua array.

Definition at line 1788 of file lua_functions.c.

◆ chiVolumeMesherSetKBACutsZ()

void chi_lua::chiVolumeMesherSetKBACutsZ ( )

Sets the z-cuts for KBA type partitioning with a lua array.

Definition at line 1792 of file lua_functions.c.

◆ chiVolumeMesherSetKBAPartitioningPxPyPz()

void chi_lua::chiVolumeMesherSetKBAPartitioningPxPyPz	(	int	Px,
		int	Py,
		int	Pz
	)

Sets the Px, Py and Pz partititioning parameters for a KBA-type partitioning. This also fixes the process count required to a total of Px*Py*Pz.

Parameters

Px	int Number partitions in x.
Py	int Number partitions in y.
Pz	int Number partitions in z.

Definition at line 1780 of file lua_functions.c.

◆ chiVolumeMesherSetMatIDToAll()

void chi_lua::chiVolumeMesherSetMatIDToAll ( int material_id )

Sets all cell-material id's to the supplied value.

Parameters

material_id int The id.

Usage Examples:

Definition at line 1842 of file lua_functions.c.

◆ chiVolumeMesherSetProperty()

void chi_lua::chiVolumeMesherSetProperty	(	int	PropertyIndex,
		varying	PropertyValue
	)

Sets a volume mesher property.

Parameters

PropertyIndex	int Index of the property to change. See below
PropertyValue	varying Value of the property.

_

PropertyIndex:

FORCE_POLYGONS = PropertyValue:[bool] Forces the 2D Meshing to use polygon cells even if the underlying surface mesh is triangles. Expects a boolean value.
MESH_GLOBAL = PropertyValue:[bool] Generate/Read the full mesh at each location. Expects a boolean value [Default=true].
PARTITION_TYPE = PartitionType. See below.
EXTRUSION_LAYER = PropertyValue:[double,(int),(char)] Adds a layer to the extruder volume mesher if it exists. Expects 1 required parameter, the layer height, followed by 2 optional parameters: number of subdivisions (defaults to 1), and layer id (char)(defaults to nothing). Only supported if partition-type is KBA_STYLE_XY or KBA_STYLE_XYZ.
CUTS_X = Adds a cut at the given x-value. Only supported if partition-type is KBA_STYLE_XY or KBA_STYLE_XYZ.
CUTS_Y = Adds a cut at the given y-value. Only supported if partition-type is KBA_STYLE_XY or KBA_STYLE_XYZ.
CUTS_Z = Adds a cut at the given z-value. Only supported if partition-type is KBA_STYLE_XY or KBA_STYLE_XYZ.
PARTITION_X = PropertyValue:[int] Number of partitions in X. Only supported if partition-type is KBA_STYLE_XY or KBA_STYLE_XYZ.
PARTITION_Y = PropertyValue:[int] Number of partitions in Y. Only supported if partition-type is KBA_STYLE_XY or KBA_STYLE_XYZ.
PARTITION_Z = PropertyValue:[int] Number of partitions in Z. Only supported if partition-type is KBA_STYLE_XY or KBA_STYLE_XYZ.
MATID_FROMLOGICAL = LogicalVolumeHandle:[int],Mat_id:[int], Sense:[bool](Optional, default:true) Sets the material id of cells that meet the sense requirement for the given logical volume.
BNDRYID_FROMLOGICAL = LogicalVolumeHandle:[int],Bndry_name:[string], Sense:[bool](Optional, default:true) Sets the cell boundary id to the specified value for cells that meet the sense requirement for the given logical volume.
MATID_FROM_LUA_FUNCTION = LuaFunctionName:[string]. For each cell, will call a lua function that can change the material id. The lua function must have 4 parameters, the cell's centroid x,y,z values (doubles) and the current cell-material id (int). The function must return a material id. BNDRYID_FROM_LUA_FUNCTION = LuaFunctionName:[string]. For each boundary face, will call a lua function that can change the boundary id. The lua function must have 7 parameters, the face's centroid x,y,z values (doubles), the face's normal x,y,z values (double), and the current face-boundary id (int). The function must return a boundary id.

_

PartitionType

Can be any of the following:

KBA_STYLE_XYZ
PARMETIS

Usage Examples:

Author: Jan

Definition at line 1770 of file lua_functions.c.

◆ chiVolumeMesherSetupOrthogonalBoundaries()

void chi_lua::chiVolumeMesherSetupOrthogonalBoundaries ( )

Sets boundary numbers on boundaries orthogonal to the cardinal directions as xmax=0, xmin=1, ymax=2, ymin=3, zmax=4, zmin=5.

Usage Examples:

Definition at line 1617 of file lua_functions.c.

Functions

Detailed Description

General Concepts

Extruder Mesher

Function Documentation

◆ chiVolumeMesherCreate()

_

Extruder parameters

◆ chiVolumeMesherExecute()

◆ chiVolumeMesherSetKBACutsX()

◆ chiVolumeMesherSetKBACutsY()

◆ chiVolumeMesherSetKBACutsZ()

◆ chiVolumeMesherSetKBAPartitioningPxPyPz()

◆ chiVolumeMesherSetMatIDToAll()

Usage Examples:

◆ chiVolumeMesherSetProperty()

_

PropertyIndex:

_

PartitionType

Usage Examples:

◆ chiVolumeMesherSetupOrthogonalBoundaries()

Usage Examples: