Class: ContactDefinition

Represents a reusable collection of shared contact settings for one or more objects. Link ContactRegion objects to this definition to configure common contact behavior once and apply it consistently.

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.
Export(String) Exports this ContactDefinition's settings to a ContactDefinition XML document.
GetChildren(Boolean, IList<ChildrenType>)
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.
Import(String) Imports ContactDefinition settings from the specified ContactDefinition XML document into this object.
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.

Properties

Name Description
AutomaticElectricCapacitance Gets or sets the AutomaticElectricCapacitance.
AutomaticElectricConductance Gets or sets the AutomaticElectricConductance.
AutomaticThermalConductance Gets or sets the AutomaticThermalConductance.
BeamBeamModel Gets or sets the BeamBeamModel.
BeamRadius Gets or sets the BeamRadius.
Behavior Gets or sets the Behavior.
BondedMaximumOffset Gets or sets the BondedMaximumOffset.
Breakable Gets or sets the Breakable.
Comments Gets the list of associated comments.
ConstraintType Gets or sets the ConstraintType.
ContactCenterPoint Gets or sets the ContactCenterPoint.
ContactEndingPoint Gets or sets the ContactEndingPoint.
ContactFormulation Gets or sets the ContactFormulation.
ContactGeometryCorrection Gets or sets the ContactGeometryCorrection.
ContactOrientation Gets or sets the ContactOrientation.
ContactStartingPoint Gets or sets the ContactStartingPoint.
ContactType
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DecayConstant Gets or sets the DecayConstant.
DetectionMethod Gets or sets the DetectionMethod.
DynamicCoefficient Gets or sets the DynamicCoefficient.
EdgeContactType Gets or sets the EdgeContactType.
ElasticSlipTolerance Gets or sets the ElasticSlipTolerance.
ElasticSlipToleranceFactor Gets or sets the ElasticSlipToleranceFactor.
ElasticSlipToleranceValue Gets or sets the ElasticSlipToleranceValue.
ElectricCapacitanceValue Gets or sets the ElectricCapacitanceValue.
ElectricConductanceValue Gets or sets the ElectricConductanceValue.
Figures Gets the list of associated figures.
FrictionCoefficient Gets or sets the FrictionCoefficient.
Handedness Gets or sets the Handedness.
Images Gets the list of associated images.
InitialClearance Gets or sets the InitialClearance.
InitialClearanceFactor Gets or sets the InitialClearanceFactor.
InitialClearanceValue Gets or sets the InitialClearanceValue.
InterfaceTreatment Gets or sets the InterfaceTreatment.
InternalObject Gets the internal object. For advanced usage only.
LineLineDetection Gets or sets the LineLineDetection.
Material Gets or sets the Material.
MeanPitchDiameter Gets or sets the MeanPitchDiameter.
Name Gets the name of the object.
NormalForceExponent Gets or sets the NormalForceExponent.
NormalForceLimit Gets or sets the NormalForceLimit.
NormalStiffnessFactor Gets or sets the NormalStiffnessFactor.
NormalStiffnessValue Gets or sets the NormalStiffnessValue.
NormalStiffnessValueType Gets or sets the NormalStiffnessValueType.
NormalStressExponent Gets or sets the NormalStressExponent.
NormalStressLimit Gets or sets the NormalStressLimit.
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.
PenetrationTolerance Gets or sets the PenetrationTolerance.
PenetrationToleranceFactor Gets or sets the PenetrationToleranceFactor.
PenetrationToleranceValue Gets or sets the PenetrationToleranceValue.
PitchDistance Gets or sets the PitchDistance.
PressureAtZeroPenetration Gets or sets the PressureAtZeroPenetration.
PressureAtZeroPenetrationFactor Gets or sets the PressureAtZeroPenetrationFactor.
PressureAtZeroPenetrationValue Gets or sets the PressureAtZeroPenetrationValue.
Properties Gets the list of properties for this object.
RampingEndTime Gets or sets the end time of the time range during which the contact stiffness will be ramped in the analysis. Default: 0.0 An exception is thrown if RampStiffnessBy is not set to TimeRange.
RampingLoadStep Gets or sets the load step number during which the contact stiffness will be ramped in the analysis. Default: 1 An exception is thrown if RampStiffnessBy is not set to LoadStep.
RampingStartTime Gets or sets the start time of the time range during which the contact stiffness will be ramped in the analysis. Default: 0.0 An exception is thrown if RampStiffnessBy is not set to TimeRange.
RampStiffnessBy Gets or sets the method used to ramp the contact stiffness when performing a static or transient analysis. Default: ProgramControlled An exception is thrown if InterfaceTreatment is not set to AddOffsetRampedEffects or OffsetOnlyRampedEffects.
ReadOnly Gets or sets the ReadOnly.
RestitutionFactor Gets or sets the RestitutionFactor.
ShearForceExponent Gets or sets the ShearForceExponent.
ShearForceLimit Gets or sets the ShearForceLimit.
ShearStressExponent Gets or sets the ShearStressExponent.
ShearStressLimit Gets or sets the ShearStressLimit.
SmallSliding Gets or sets the SmallSliding.
StabilizationDampingFactor Gets or sets the StabilizationDampingFactor.
Suppressed Gets or sets the Suppressed.
TargetCenterPoint Gets or sets the TargetCenterPoint.
TargetEndingPoint Gets or sets the TargetEndingPoint.
TargetGeometryCorrection Gets or sets the TargetGeometryCorrection.
TargetOrientation Gets or sets the TargetOrientation.
TargetStartingPoint Gets or sets the TargetStartingPoint.
ThermalConductanceValue Gets or sets the ThermalConductanceValue.
ThreadAngle Gets or sets the ThreadAngle.
ThreadType Gets or sets the ThreadType.
TimeStepControls Gets or sets the TimeStepControls.
UpdateStiffness Gets or sets the UpdateStiffness.
UserOffset Gets or sets the UserOffset.
VisibleProperties Gets the list of properties that are visible for this object.