NumericalGreensFunction
The numerical Green's function (NGF) applied to the model.
Example
app = cf.GetApplication() project = app:NewProject() cuboid = project.Geometry:AddCuboid(cf.Cuboid.GetDefaultProperties()) -- Get the 'NumericalGreensFunction' from the 'SolutionSettings' ngf = project.SolutionSettings.NumericalGreensFunction -- Add the 'Cuboid' to the list of static parts and enable the numerical Green's function ngf.StaticGeometryParts = {cuboid} ngf.Enabled = true
Usage locations (object properties)
The following objects have properties using the NumericalGreensFunction object:
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)
- StaticGeometryParts
- The NGF will only apply to the specified geometry entities. (Read/Write List of Geometry)
- StaticMeshParts
- The NGF will only apply to the specified mesh entities. (Read/Write List of Mesh)
- Type
- The object type string. (Read only string)
Method List
- 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 table)
- 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.
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
- StaticGeometryParts
- The NGF will only apply to the specified geometry entities.
- Access
- Read/Write
- StaticMeshParts
- The NGF will only apply to the specified mesh entities.
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- 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 properties table.
- SetProperties (properties table)
- 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(table)
- A table of properties defining the new state of the object.