Region

A geometry region entity.

Example

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

    -- Create geometry which contains regions

project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)
project.Contents.Geometry:AddSphere(cf.Point(0.5, 0.5, 0.5), 1)
union = project.Contents.Geometry:Union()

    -- Set the local mesh size of first region of the union

union.Regions[1].LocalMeshSize = 0.1

Inheritance

The Region object is derived from the TopologyEntity object.

Usage locations

The Region object can be accessed from the following locations:

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)
CentreOfGravity
A point indicating the centre of gravity of this entity. (Read only Point)
DefinitionMethod
The definition method for the 3D anisotropic reference direction. (Read/Write RegionDefinitionMethodEnum)
Faulty
Indicates whether the geometry entity has faults. (Read only boolean)
Geometry
The geometry operator that the region belongs to. (Read only Geometry)
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)
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
CentreOfGravity
A point indicating the centre of gravity of this entity.
Type
Point
Access
Read only
DefinitionMethod
The definition method for the 3D anisotropic reference direction.
Type
RegionDefinitionMethodEnum
Access
Read/Write
Faulty
Indicates whether the geometry entity has faults.
Type
boolean
Access
Read only
Geometry
The geometry operator that the region belongs to.
Type
Geometry
Access
Read only
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
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.