Class: Force

Defines a Force.

Implemented types

Methods

Name Description
Activate() Activate the current object.
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Delete() Run the Delete action.
Duplicate() Creates a copy of the current DataModelObject.
GetActivateAtLoadStep(UInt32) Gets whether the force is active at the specified load step.
GetChildren(Boolean, IList<ChildrenType>)
GetComponentActivateAtLoadStep(String, UInt32)
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
PromoteToNamedSelection() Run the PromoteToNamedSelection action.
PropertyByAPIName(String) Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
SetActivateAtLoadStep(UInt32, Boolean) Sets whether the force is active at the specified load step.
SetComponentActivateAtLoadStep(String, UInt32, Boolean)

Properties

Name Description
AppliedBy Gets or sets the AppliedBy.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DefineBy Gets or sets the DefineBy.
Direction Gets or sets the Direction.
DivideLoadByNodes Gets or sets the DivideLoadByNodes.
DynamicRelaxationBehavior Gets or sets the DynamicRelaxationBehavior.
Figures Gets the list of associated figures.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
HarmonicIndex Gets or sets the HarmonicIndex.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject Gets the internal object. For advanced usage only.
LoadVectorAssignment Gets or sets the LoadVectorAssignment.
LoadVectorNumber Gets or sets the load vector number for the force. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer. This property is unsupported when DefineBy is set to Components or ComplexComponents; the component-based properties LoadVectorNumberX, LoadVectorNumberY, and LoadVectorNumberZ should be used instead.
LoadVectorNumberImaginary Gets or sets the load vector number for the imaginary part of the force. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer.
LoadVectorNumberX Gets or sets the load vector number for the real part of the force in the X direction. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer.
LoadVectorNumberXImaginary Gets or sets the load vector number for the imaginary part of the force in the X direction. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer.
LoadVectorNumberY Gets or sets the load vector number for the real part of the force in the Y direction. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer.
LoadVectorNumberYImaginary Gets or sets the load vector number for the imaginary part of the force in the Y direction. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer.
LoadVectorNumberZ Gets or sets the load vector number for the real part of the force in the Z direction. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer.
LoadVectorNumberZImaginary Gets or sets the load vector number for the imaginary part of the force in the Z direction. When Load Vector Assignment is set to Manual, the default value of '0' represents an invalid value that must be changed to a positive integer.
Location Gets or sets the Location.
Magnitude Gets the Magnitude.
MagnitudeImag Gets the MagnitudeImag.
Name Gets the name of the object.
NonCyclicLoadingType Gets or sets the NonCyclicLoadingType.
NumberOfSegments Gets or sets the NumberOfSegments.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
PhaseAngle Gets the PhaseAngle.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
ReadOnly Gets or sets the ReadOnly.
RpmSelection Gets or sets the RPM value at which the load is applied. An exception is thrown if MultiStep is not True, StepVarying is not Yes, or HarmonicMultiStepType is not RPM.
SectorNumber Gets or sets the SectorNumber.
SharedRefBody Gets or sets the SharedRefBody.
StepSelectionRepresentation Gets or sets the string representation of the step numbers at which the load is applied. An exception is thrown if any of the below conditions are met: 1. MultiStep is not True. 2. StepVarying is not Yes. 3. HarmonicMultiStepType is not Load_Step. 4. The input format is invalid.
StepVarying Gets or sets the StepVarying.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XComponent Gets the XComponent.
XComponentImag Gets the XComponentImag.
XPhaseAngle Gets the XPhaseAngle.
YComponent Gets the YComponent.
YComponentImag Gets or sets the YComponentImag.
YPhaseAngle Gets the YPhaseAngle.
ZComponent Gets the ZComponent.
ZComponentImag Gets or sets the ZComponentImag.
ZPhaseAngle Gets the ZPhaseAngle.