`NumericalGreensFunction`

The numerical Green's function (NGF) applied to the model.

Example

application = cf.Application.GetInstance()
project = application:NewProject()
cuboid = project.Contents.Geometry:AddCuboid(cf.Cuboid.GetDefaultProperties())

    -- Get the 'NumericalGreensFunction' from the 'SolutionSettings'

ngf = project.Contents.SolutionSettings.NumericalGreensFunction

    -- Add the 'Cuboid' to the list of static parts and enable the numerical Green's function

ngf.StaticParts = {cuboid}
ngf.Enabled = true

Inheritance

The NumericalGreensFunction object is derived from the Object object.

Usage locations

The NumericalGreensFunction object can be accessed from the following locations:

Properties
- SolutionSettings object has property NumericalGreensFunction.

Property List

Enabled: Specifies if the numerical Green's function is active. (Read/Write boolean)
Label: The object label. (Read/Write string)
SolutionControl: Specifies the *.ngf file read/write behaviour. (Read/Write NGFControlTypeEnum)
StaticParts: The NGF will only apply to the specified entities. (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

Enabled

Specifies if the numerical Green's function is active.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

SolutionControl

Specifies the *.ngf file read/write behaviour.

Type: NGFControlTypeEnum
Access: Read/Write

StaticParts

The NGF will only apply to the specified entities.

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.