pycatia.abq_automation_interfaces.abq_frequency_step

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.abq_automation_interfaces.abq_frequency_step.ABQFrequencyStep(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

ABQAutomationItf.ABQStep

ABQFrequencyStep

Represents an Abaqus frequency step (ABQFrequencyStep) object.

Role: Access an Abaqus frequency step object or determine its

properties.

add_residual_mode_region(i_product: Product, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub AddResidualModeRegion(Product iProduct,

Reference iSupport)

Adds the Residual Mode Region.

Parameters:

iProduct

The CATIAProduct specifying the positioning

object.

iSupport

The CATIAReference specifying the object that is being pointed

to.

Parameters:

• i_product (Product) –

• i_support (Reference) –

Return type:

None

add_residual_mode_region_dof(i_dof: int, i_index: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub AddResidualModeRegionDOF(short iDOF,

short iIndex)

Adds the Residual Mode Region DOF.

Parameters:

iDOF

The DOF.

iIndex

The index at which the DOF is being set.

Parameters:

• i_dof (int) –

• i_index (int) –

Return type:

None

property boundary_conditions: ABQBoundaryConditions

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property BoundaryConditions() As ABQBoundaryConditions (Read

Only)

Returns the ABQBoundaryConditions container associated with the

step.

Example:

This example retrieves the ABQBoundaryConditions container

abqBCs.

Dim abqFreqStep As ABQFrequencyStep

Dim abqBCs As ABQBoundaryConditions

Set abqBCs = abqFreqStep.BoundaryConditions

Return type:

ABQBoundaryConditions

property description: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Description() As CATBSTR

Returns or sets the description of the Abaqus general static

step.

Returns:

The description of the Abaqus general static step.

Return type:

str

property eigensolver_value: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property EigensolverValue() As short

Returns or sets Eigensolver Value.

Returns:

The Eigensolver Value.

Legal values:

1 - Lanczos.

2 - AMS.

Example:

This example sets eigensolver as Lanczos

abqFreqStep

abqFreqStep.EigensolverValue = 1

Return type:

int

property frequency_shift: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property FrequencyShift() As short

Returns or sets frequency shift value.

Returns:

The frequency shift value.

Example:

This example sets the maximum frequency for

abqFreqStep

abqFreqStep.FrequencyShift = 10

Return type:

int

property loads: ABQLoads

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Loads() As ABQLoads (Read Only)

Returns the ABQLoads container associated with the step.

Example:

The following example retrieves the ABQLoads container

abqLoads:

Dim abqFreqStep As ABQFrequencyStep

Dim abqLoads As ABQLoads

Set abqLoads = abqFreqStep.Loads

Return type:

ABQLoads

property maximum_frequency: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MaximumFrequency() As short

Returns or sets maximum frequency value.

Returns:

The maximum frequency value.

Example:

This example sets the maximum frequency for

abqFreqStep

abqFreqStep.MaximumFrequency = 100

Return type:

int

property minimum_frequency: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property MinimumFrequency() As short

Returns or sets minimum frequency value.

Returns:

The minimum frequency value.

Example:

This example sets the minimum frequency for

abqFreqStep

abqFreqStep.MinimumFrequency = 10

Return type:

int

property normalization_value: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property NormalizationValue() As short

Returns or sets Normalization Value.

Returns:

The Normalization Value.

Legal values:

1 - Displacement.

2 - Mass.

Example:

This example sets Normalization as Displacement

abqFreqStep

abqFreqStep.NormalizationValue = 1

Return type:

int

property requested_modes_option: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property RequestedModesOption() As short

Sets or returns the requested modes option.

Returns:

The option of requested modes.

Legal values:

ABQ_ALL - All modes.

ABQ_VALUE - Specify the no of modes to be requested.

Example:

This example sets the requested modes option for abqFreqStep job to

every increment.

abqFreqStep.RequestedModesOption = ABQ_ALL

Returns:

enum abq_requested_modes_option

Return type:

int

property requested_modes_value: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property RequestedModesValue() As short

Returns or sets requested modes value. This is only valid if

RestartRequestOption is ABQ_VALUE

Returns:

The requested modes value.

Example:

This example sets the requested modes for

abqFreqStep

abqFreqStep.RequestedModesValue = 10

Return type:

int

property residual_mode_req_boolean: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property ResidualModeReqBoolean() As boolean

Returns or sets Residual Mode Request Boolean Value.

Returns:

The Residual Mode Request Boolean Value.

Return type:

bool

property sim_architecture_req_boolean: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property SIMArchitectureReqBoolean() As boolean

Returns or sets SIM Architecture Request Boolean Value.

Returns:

The SIM Architecture Request Boolean Value.

Return type:

bool