`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:

Collection lists
- ModelContents object has collection MeshRefinementRules.

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

AddAdaptiveRefinement (table 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 and *.fek file. (Returns a AdaptiveRefinement object.)
Delete (): Deletes the entity.
DeleteEntities ( List of Object): Delete the given list of entities from the collection.
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

AddAdaptiveRefinement (table table)

Create a adaptive mesh refinement rule from a table defining the properties.

Input Parameters

table(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 and *.fek file.

Return

AdaptiveRefinement: The adaptive refinement.

Delete ()

Deletes the entity.

DeleteEntities ( List of Object)

Delete the given list of entities from the collection.

Input Parameters

(List of Object)

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.