MeshRefinementRuleCollection

A collection of MeshRefinementRules.

Example

application = cf.Application.GetInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]]})

    -- Add an adaptive refinement rule

project.Contents.MeshRefinementRules:AddPointRefinement(cf.Point(0,0,0),0.01,0.01)

    -- Obtain the 'MeshRefinementRulesCollection'

meshRefinementRules = project.Contents.MeshRefinementRules

    -- Store the number of mesh refinement rules in the collection

meshRefinementRulesCount = meshRefinementRules.Count

Inheritance

The MeshRefinementRuleCollection object is derived from the Object object.

Usage locations

The MeshRefinementRuleCollection object can be accessed from the following locations:

Property List

Count
The number of MeshRefinementRule items in the collection. (Read only number)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

AddPointRefinement (properties table)
Adds a point meshing rule refinement. (Returns a PointRefinement object.)
AddPointRefinement (center Point, radius Expression, size Expression)
Adds a point refinement at a given point. (Returns a PointRefinement object.)
AddPolylineRefinement (properties table)
Adds a new polyline refinement. (Returns a PolylineRefinement object.)
AddPolylineRefinement (points List of Point, radius Expression, size Expression)
Adds a new polyline refinement from a list of points. (Returns a PolylineRefinement object.)
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.)
Item (index number)
Returns the MeshRefinementRule for the given index in the collection. (Returns a MeshRefinementRule object.)
Item (label string)
Returns the MeshRefinementRule for the given label in the collection. (Returns a MeshRefinementRule object.)
Items ()
Returns a table of MeshRefinementRule items. (Returns a UnsupportedType(List of MeshRefinementRule) 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

Count
The number of MeshRefinementRule items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

AddPointRefinement (properties table)
Adds a point meshing rule refinement.
Input Parameters
properties(table)
The properties for the point refinement.
Return
PointRefinement
The new point refinement.
AddPointRefinement (center Point, radius Expression, size Expression)
Adds a point refinement at a given point.
Input Parameters
center(Point)
The location of the point refinement.
radius(Expression)
The radius of the point refinement.
size(Expression)
The mesh size for the refinement.
Return
PointRefinement
The new point refinement.
AddPolylineRefinement (properties table)
Adds a new polyline refinement.
Input Parameters
properties(table)
The settings for the new refinement.
Return
PolylineRefinement
The new refinement.
AddPolylineRefinement (points List of Point, radius Expression, size Expression)
Adds a new polyline refinement from a list of points.
Input Parameters
points(List of Point)
A list of points defining the polyline.
radius(Expression)
The radius of the refinement.
size(Expression)
The mesh size for the refinement.
Return
PolylineRefinement
The new refinement.
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.
Item (index number)
Returns the MeshRefinementRule for the given index in the collection.
Input Parameters
index(number)
The index of the MeshRefinementRule.
Return
MeshRefinementRule
The item in the collection
Item (label string)
Returns the MeshRefinementRule for the given label in the collection.
Input Parameters
label(string)
The label of the MeshRefinementRule.
Return
MeshRefinementRule
The item in the collection
Items ()
Returns a table of MeshRefinementRule items.
Return
UnsupportedType(List of MeshRefinementRule)
The list of items in the collection
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.