ErrorEstimation

Error estimation is an a-posteriori error indicator which gives feedback on the mesh quality.

Example

application = cf.Application.getInstance()
project = application:NewProject()
standardConfiguration = project.Contents.SolutionConfigurations:AddStandardConfiguration()

    -- Create a new 'ErrorEstimation' request

errorEstimation1 = standardConfiguration.ErrorEstimations:Add()

Inheritance

The ErrorEstimation object is derived from the Object object.

Usage locations

The ErrorEstimation object can be accessed from the following locations:

Property List

CalculationScope
Control which type of elements should be considered for error estimate calculation. (Read/Write ErrorEstimationCalculationScopeEnum)
ExportEnabled
Export error estimates to the *.out file. (Read/Write boolean)
Label
The object label. (Read/Write string)
ScopedEntities
The entities that will be considered for the error estimate calculation. (Read/Write ObjectReferenceList)
Type
The object type string. (Read only string)

Method List

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.)
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

CalculationScope
Control which type of elements should be considered for error estimate calculation.
Type
ErrorEstimationCalculationScopeEnum
Access
Read/Write
ExportEnabled
Export error estimates to the *.out file.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
ScopedEntities
The entities that will be considered for the error estimate calculation.
Type
ObjectReferenceList
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

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.
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.