`MeshRefinementRuleCollection`

A collection of MeshRefinementRules.

Example

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

corner = cf.Point(-0.25, -0.25, 0)
cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25)

-- Add an 'EdgeMeshRefinement' to the edge of the cube on edge 0

port = project.Contents.MeshRefinementRules:AddEdgeRefinement(0.1, cube.Edges[1])

Inheritance

The MeshRefinementRuleCollection object is derived from the CollectionOf_MeshRefinementRule 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)
Locked: A boolean that indicates whether the entity or it's ancestor is locked or not. (Read/Write boolean)
Type: The object type string. (Read only string)

Method List

AddEdgeRefinement (properties table): Adds a refinement on an edge. (Returns a EdgeMeshRefinement object.)
AddEdgeRefinement (size Expression, edge Object): Adds a edge refinement on the specified edge. (Returns a EdgeMeshRefinement object.)
AddErrorEstimateRefinement (table table): Create an adaptive mesh refinement rule from a table defining the properties. (Returns a ErrorEstimateRefinement object.)
AddErrorEstimateRefinement (): Create an adaptive mesh refinement rule. Prerequisites are a saved project with an error estimate request and a *.bof and *.fek file. (Returns a ErrorEstimateRefinement object.)
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.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean 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.
UniqueName (label string): Generates a unique name base 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 string object.)

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

Locked

A boolean that indicates whether the entity or it's ancestor is locked or not.

Type: boolean
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

AddEdgeRefinement (properties table)

Adds a refinement on an edge.

Input Parameters

properties(table): The settigs for the refinement.

Return

EdgeMeshRefinement: The new edge refinement.

AddEdgeRefinement (size Expression, edge Object)

Adds a edge refinement on the specified edge.

Input Parameters

size(Expression): The mesh size for the refinement.
edge(Object): The edge where the refinement must be applied.

Return

EdgeMeshRefinement: The new refinement.

AddErrorEstimateRefinement (table table)

Create an 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

ErrorEstimateRefinement: The adaptive refinement.

AddErrorEstimateRefinement ()

Create an adaptive mesh refinement rule. Prerequisites are a saved project with an error estimate request and a *.bof and *.fek file.

Return

ErrorEstimateRefinement: The adaptive refinement.

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.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the item.

Return

boolean: The success of the check.

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.

UniqueName (label string)

Generates a unique name base 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

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.