ReciprocalExcitationConfiguration
A reciprocal excitation configuration.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add a line, attach a wire port to it, and add a load line = project.Contents.Geometry:AddLine(cf.Point(0,0,0), cf.Point(0,0,1)) wirePort = project.Contents.Ports:AddWirePort(line.Wires[1]) load = project.Contents.SolutionConfigurations.GlobalLoads:AddComplex(wirePort, 50, 0) -- Add a reciprocal excitation configuration ReciprocalExcitationConfiguration = project.Contents.SolutionConfigurations:AddReciprocalExcitationConfigurationOnLoads({load})
Inheritance
The ReciprocalExcitationConfiguration object is derived from the SolutionConfiguration object.
Usage locations
The ReciprocalExcitationConfiguration object can be accessed from the following locations:
- Methods
- SolutionConfigurationCollection collection has method AddReciprocalExcitationConfiguration().
- SolutionConfigurationCollection collection has method AddReciprocalExcitationConfigurationOnLoads(List of Load).
Property List
- Frequency
- The configuration solution frequency. (Read only Frequency)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- Reciprocity
- The configuration solution reciprocity. (Read only Reciprocity)
- Type
- The object type string. (Read only string)
Collection List
- FarFields
- The collection of far field requests in the configuration. (FarFieldCollection of FarField.)
- Loads
- The collection of loads in the configuration. (LoadCollection of Load.)
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
- Frequency
- The configuration solution frequency.
- Type
- Frequency
- Access
- Read only
- Included
- A boolean value defining if an entity is excluded or included.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Reciprocity
- The configuration solution reciprocity.
- Type
- Reciprocity
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- FarFields
- The collection of far field requests in the configuration.
- Loads
- The collection of loads in the configuration.
- Type
- LoadCollection
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.