`MeshTetrahedronRegion`

A mesh entity representing a region meshed with tetrahedra.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Set the frequency

project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08"

    -- Create geometry, set the solution method to FEM

cuboid = project.Contents.Geometry:AddCuboidAtCentre(cf.Point(0,0,0), 1.0, 1.0, 1.0)
dielectric = project.Definitions.Media.Dielectric:AddDielectric(0.01,0.01,0.01)
cuboid.Regions["Region1"].Medium = dielectric
cuboid.Regions["Region1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM

	-- Mesh

project.Mesher:Mesh()
project.Contents.Geometry["Cuboid1"]:UnlinkMesh()

tetrahedronRegions = project.Contents.Meshes["Cuboid1_1"].Regions

for i in ipairs(tetrahedronRegions) do

    -- Obtain the 'MeshTetrahedronRegion' and set its local size

    meshTetrahedronRegion = tetrahedronRegions[i]
    meshTetrahedronRegion.LocalMeshSize = 0.01;
    meshTetrahedronRegion.LocalMeshSizeEnabled = true;
end

Inheritance

The MeshTetrahedronRegion object is derived from the MeshRegion object.

Property List

BasisFunctionSettings: Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP. (Read/Write BasisFunctionLocalSolverSettings)
BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
DefinitionMethod: The definition method for the 3D anisotropic reference direction. (Read/Write RegionDefinitionMethodEnum)
Label: The object label. (Read/Write string)
LocalMeshSize: The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true. (Read/Write ParametricExpression)
LocalMeshSizeEnabled: Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean)
Medium: The region medium. (Read/Write Medium)
Part: The mesh part that this entity belongs to. (Read only Mesh)
ReferenceWorkplane: The workplane for the 3D anisotropic reference direction. (Read/Write Workplane)
SolutionMedium: The local solution method used for the region. (Read only Medium)
SolutionMethod: The local solution method used for the region. (Read/Write RegionSolutionMethodEnum)
Type: The object type string. (Read only string)
UTDCylinder: The cylinder region's uniform theory of diffraction (UTD) solution settings. Only applies if the SolutionMethod is set to UTD. (Read/Write UTDCylinderTerminationType)
Visible: Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BasisFunctionSettings

Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP.

Type: BasisFunctionLocalSolverSettings
Access: Read/Write

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

DefinitionMethod

The definition method for the 3D anisotropic reference direction.

Type: RegionDefinitionMethodEnum
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

LocalMeshSize

The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true.

Type: ParametricExpression
Access: Read/Write

LocalMeshSizeEnabled

Specifies if the local mesh size should be used for the wire/edge.

Type: boolean
Access: Read/Write

Medium

The region medium.

Type: Medium
Access: Read/Write

Part

The mesh part that this entity belongs to.

Type: Mesh
Access: Read only

ReferenceWorkplane

The workplane for the 3D anisotropic reference direction.

Type: Workplane
Access: Read/Write

SolutionMedium

The local solution method used for the region.

Type: Medium
Access: Read only

SolutionMethod

The local solution method used for the region.

Type: RegionSolutionMethodEnum
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

UTDCylinder

The cylinder region's uniform theory of diffraction (UTD) solution settings. Only applies if the SolutionMethod is set to UTD.

Type: UTDCylinderTerminationType
Access: Read/Write

Visible

Specifies whether the geometry must be shown or hidden.

Type: boolean
Access: Read/Write

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.