DeformationParameters Class¶

class NXOpen.CAE.DeformationParameters¶

Bases: NXOpen.TaggedObject

This class is worked as a packet of information that can be be used to deform NXOpen.CAE.Post objects.

<br/>Use NXOpen.CAE.ResultManager to create an NXOpen.CAE.DeformationParameters

<br/>You can modifiy these values but validation of correctness will only be performed when this object is set to a NXOpen.CAE.Post object

To obtain an instance of this class use NXOpen.Session.ResultManager().

New in version NX7.5.0.

Properties¶

Property	Description
ComplexCriterion	Returns or sets the complexity criterion.
Component	Returns or sets the result component that is used for deforming the model.
DeformationType	Returns or sets the type of scale used for deforming the model
GenericType	Returns or sets the result type that will be used for deforming the model
InitialDeformationScale	Returns or sets the initial deformation scale to be applied to the deformation value
InitialDeformationScaleType	Returns or sets the type of initial deformation scale used for deforming the model
InitialDeformationUserDefinedResultType	Returns or sets the initial deformation result type that will be used for deforming the model
InitialDeformationUserselectionType	Returns or sets the initial deformation section type that will be used for deforming the model
IsReferenceNode	Returns or sets a value of true means the reference node will be used
PhaseAngle	Returns or sets the phase angle at which result will be evaluated and used for deformation.
ReferenceNodeLabel	Returns or sets the node label which identifies the reference node used when deforming the model if `NXOpen.CAE.DeformationParameters.IsReferenceNode()` is set to true
Scale	Returns or sets the scale to be applied to the deformation value
Tag	Returns the Tag for this object.

Methods¶

Property Detail¶

ComplexCriterion¶

DeformationParameters.ComplexCriterion¶

Returns or sets the complexity criterion.

If the result type is complex NXOpen.CAE.BaseResultType.Complex() the complexity criterion defines which value is used for deformation(like NXOpen.CAE.ResultComplex.Real or NXOpen.CAE.ResultComplex.Imaginary)

-------------------------------------

Getter Method

Signature ComplexCriterion()

Returns:
Return type:	`NXOpen.CAE.ResultComplex`

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature ComplexCriterion(complex)

Parameters:	complex (`NXOpen.CAE.ResultComplex`) –

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Component¶

DeformationParameters.Component¶

Returns or sets the result component that is used for deforming the model.

-------------------------------------

Getter Method

Signature Component()

Returns:
Return type:	`NXOpen.CAE.ResultComponent`

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature Component(component)

Parameters:	component (`NXOpen.CAE.ResultComponent`) –

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

DeformationType¶

DeformationParameters.DeformationType¶

Returns or sets the type of scale used for deforming the model

-------------------------------------

Getter Method

Signature DeformationType()

Returns:
Return type:	`NXOpen.CAE.ResultDeformationScale`

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature DeformationType(unit)

Parameters:	unit (`NXOpen.CAE.ResultDeformationScale`) –

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

GenericType¶

DeformationParameters.GenericType¶

Returns or sets the result type that will be used for deforming the model

-------------------------------------

Getter Method

Signature GenericType()

Returns:
Return type:	`NXOpen.CAE.BaseResultType`

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature GenericType(type)

Parameters:	type (`NXOpen.CAE.BaseResultType`) –

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

InitialDeformationScale¶

DeformationParameters.InitialDeformationScale¶

Returns or sets the initial deformation scale to be applied to the deformation value

-------------------------------------

Getter Method

Signature InitialDeformationScale()

Returns:
Return type:	float

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature InitialDeformationScale(initdefscale)

Parameters:	initdefscale (float) –

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

InitialDeformationScaleType¶

DeformationParameters.InitialDeformationScaleType¶

Returns or sets the type of initial deformation scale used for deforming the model

-------------------------------------

Getter Method

Signature InitialDeformationScaleType()

Returns:
Return type:	`NXOpen.CAE.ResultDeformationScale`

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature InitialDeformationScaleType(unit)

Parameters:	unit (`NXOpen.CAE.ResultDeformationScale`) –

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

InitialDeformationUserDefinedResultType¶

DeformationParameters.InitialDeformationUserDefinedResultType¶

Returns or sets the initial deformation result type that will be used for deforming the model

-------------------------------------

Getter Method

Signature InitialDeformationUserDefinedResultType()

Returns:
Return type:	`NXOpen.CAE.BaseResultType`

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature InitialDeformationUserDefinedResultType(type)

Parameters:	type (`NXOpen.CAE.BaseResultType`) –

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

InitialDeformationUserselectionType¶

DeformationParameters.InitialDeformationUserselectionType¶

Returns or sets the initial deformation section type that will be used for deforming the model

-------------------------------------

Getter Method

Signature InitialDeformationUserselectionType()

Returns:
Return type:	`NXOpen.CAE.ResultInitialDeformationSelection`

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature InitialDeformationUserselectionType(initdefseltype)

Parameters:	initdefseltype (`NXOpen.CAE.ResultInitialDeformationSelection`) –

New in version NX11.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

IsReferenceNode¶

DeformationParameters.IsReferenceNode¶

Returns or sets a value of true means the reference node will be used

-------------------------------------

Getter Method

Signature IsReferenceNode()

Returns:
Return type:	bool

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature IsReferenceNode(isReferenceNode)

Parameters:	isReferenceNode (bool) –

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

PhaseAngle¶

DeformationParameters.PhaseAngle¶

Returns or sets the phase angle at which result will be evaluated and used for deformation.

If the result type is complex NXOpen.CAE.BaseResultType.Complex() and the NXOpen.CAE.DeformationParameters.ComplexCriterion`() is set to NXOpen.CAE.ResultComplex.PhaseAngle , the Phaseangle will be used to evaluate the value of the complex result

-------------------------------------

Getter Method

Signature PhaseAngle()

Returns:
Return type:	float

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature PhaseAngle(angle)

Parameters:	angle (float) –

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

ReferenceNodeLabel¶

DeformationParameters.ReferenceNodeLabel¶

Returns or sets the node label which identifies the reference node used when deforming the model if NXOpen.CAE.DeformationParameters.IsReferenceNode() is set to true

-------------------------------------

Getter Method

Signature ReferenceNodeLabel()

Returns:
Return type:	int

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature ReferenceNodeLabel(referenceNodeLabel)

Parameters:	referenceNodeLabel (int) –

New in version NX7.5.2.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Scale¶

DeformationParameters.Scale¶

Returns or sets the scale to be applied to the deformation value

-------------------------------------

Getter Method

Signature Scale()

Returns:
Return type:	float

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

-------------------------------------

Setter Method

Signature Scale(scale)

Parameters:	scale (float) –

New in version NX7.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)