MeshRefinementRulesCollection

A collection of MeshRefinementRules.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]])

    -- Add an adaptive refinement rule
    
project.MeshRefinementRules:AddPointRefinement(cf.Point(0,0,0),0.01,0.01)

    -- Obtain the 'MeshRefinementRulesCollection'
    
meshRefinementRules = project.MeshRefinementRules

    -- Store the number of mesh refinement rules in the collection
    
meshRefinementRulesCount = meshRefinementRules.Count

Usage locations (collections)

The following objects contain the MeshRefinementRulesCollection collection:

Property List

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

Method List

AddAdaptiveRefinement (properties table)
Create a adaptive mesh refinement rule from a table defining the properties. (Returns a AdaptiveRefinement object.)
AddAdaptiveRefinement ()
Create an adaptive mesh refinement rule. Prerequisites are a saved project with an error estimate request and a *.bof file. (Returns a AdaptiveRefinement object.)
AddPointRefinement (properties table)
Create a point mesh refinement rule from a table defining the properties. (Returns a PointRefinement object.)
AddPointRefinement (position Coordinate, radius Expression, meshsize Expression)
Create a with the specified position and size. (Returns a PointRefinement object.)
AddPolylineRefinement (properties table)
Create a polyline mesh refinement rule from a table defining the properties. (Returns a PolylineRefinement object.)
AddPolylineRefinement (positionlist List of Coordinate, radius Expression, meshsize Expression)
Create a polyline mesh refinement rule with the specified positions. (Returns a PolylineRefinement object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the MeshRefinementRule at the given index. (Returns a MeshRefinementRule object.)
Item (label string)
Returns the MeshRefinementRule with the given label. (Returns a MeshRefinementRule object.)
Items ()
Returns a table of MeshRefinementRule. (Returns a List of MeshRefinementRule object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the MeshRefinementRule at the given index in the collection. (Read MeshRefinementRule)
[string]
Returns the MeshRefinementRule with the given name in the collection. (Read MeshRefinementRule)

Property Details

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

Method Details

AddAdaptiveRefinement (properties table)
Create a adaptive mesh refinement rule from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new adaptive mesh refinement rule.
Return
AdaptiveRefinement
The adaptive refinement.
AddAdaptiveRefinement ()
Create an adaptive mesh refinement rule. Prerequisites are a saved project with an error estimate request and a *.bof file.
Return
AdaptiveRefinement
The adaptive refinement.
AddPointRefinement (properties table)
Create a point mesh refinement rule from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new point mesh refinement rule.
Return
PointRefinement
The point refinement.
AddPointRefinement (position Coordinate, radius Expression, meshsize Expression)
Create a with the specified position and size.
Input Parameters
position(Coordinate)
The point's position.
radius(Expression)
The refinement radius.
meshsize(Expression)
The target mesh size in the refinement region.
Return
PointRefinement
The point refinement.
AddPolylineRefinement (properties table)
Create a polyline mesh refinement rule from a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the new polyline mesh refinement rule.
Return
PolylineRefinement
The polyline refinement.
AddPolylineRefinement (positionlist List of Coordinate, radius Expression, meshsize Expression)
Create a polyline mesh refinement rule with the specified positions.
Input Parameters
positionlist(List of Coordinate)
The polyline's corner positions.
radius(Expression)
The refinement radius.
meshsize(Expression)
The target mesh size in the refinement region.
Return
PolylineRefinement
The polyline refinement.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the MeshRefinementRule.
Return
boolean
The success of the check.
Item (index number)
Returns the MeshRefinementRule at the given index.
Input Parameters
index(number)
The index of the MeshRefinementRule.
Return
MeshRefinementRule
The MeshRefinementRule at the given index.
Item (label string)
Returns the MeshRefinementRule with the given label.
Input Parameters
label(string)
The label of the MeshRefinementRule.
Return
MeshRefinementRule
The MeshRefinementRule with the given label.
Items ()
Returns a table of MeshRefinementRule.
Return
List of MeshRefinementRule
A table of MeshRefinementRule.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for MeshRefinementRule.