Region

A geometry region entity.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create geometry which contains regions 
    
project.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)
project.Geometry:AddSphere(cf.Point(0.5, 0.5, 0.5), 1)
union = project.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 GeometryEntity object.

Property List

BasisFunctionSettings
Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP. (Read only BasisFunctionLocalSolverSettings)
BoundingBox
A box indicating the bounding box of this entity. (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)
Label
The object label. (Read/Write string)
LocalMeshSize
The local mesh size for the region. Changing this property will set LocalMeshSizeEnabled to true. (Read/Write Expression)
LocalMeshSizeEnabled
Specifies if the local mesh size should be used for the region. (Read/Write boolean)
Medium
The region medium. (Read/Write Medium)
Part
The geometry operator that the region belongs to. (Read only Geometry)
ReferenceWorkplane
The workplane for the 3D anisotropic reference direction. (Read/Write Workplane)
SolutionMethod
The local solution method used for the region. (Read/Write RegionSolutionMethodEnum)
Suspect
Indicates whether the geometry entity is suspect. (Read only boolean)
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 only UTDCylinderTerminationType)

Method List

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.)
SetNotSuspect ()
Reset the suspect setting on the geometry entity.
SetProperties (properties table)
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.

Property Details

BasisFunctionSettings
Local basis function solver settings for the region. Only applies if the SolutionMethod is set to SEP.
Type
BasisFunctionLocalSolverSettings
Access
Read only
BoundingBox
A box indicating the bounding box of this entity.
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
Label
The object label.
Type
string
Access
Read/Write
LocalMeshSize
The local mesh size for the region. Changing this property will set LocalMeshSizeEnabled to true.
Type
Expression
Access
Read/Write
LocalMeshSizeEnabled
Specifies if the local mesh size should be used for the region.
Type
boolean
Access
Read/Write
Medium
The region medium.
Type
Medium
Access
Read/Write
Part
The geometry operator that the region belongs to.
Type
Geometry
Access
Read only
ReferenceWorkplane
The workplane for the 3D anisotropic reference direction.
Type
Workplane
Access
Read/Write
SolutionMethod
The local solution method used for the region.
Type
RegionSolutionMethodEnum
Access
Read/Write
Suspect
Indicates whether the geometry entity is suspect.
Type
boolean
Access
Read only
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 only

Method Details

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 properties table.
SetNotSuspect ()
Reset the suspect setting on the geometry entity.
SetProperties (properties table)
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(table)
A table of properties defining the new state of the object.