Filter¶

Filter commands are used to create real-time filters of output request data.

Create filters¶

In Mdb¶

class FilterModel( name, description='', stefanBoltzmann=None, absoluteZero=None, waveFormulation=NOT_SET, modelType=STANDARD_EXPLICIT, universalGas=None, copyConstraints=1, copyConnectors=1, copyInteractions=1, )[source]¶

Bases: ModelBase

Abaqus creates a Model object named Model-1 when a session is started.

Note

This object can be accessed by:

mdb.models[name]

Note

Check FilterModel on help.3ds.com/2024.

Public Data Attributes:

Inherited from ModelBase

`name`	A String specifying the repository key.
`stefanBoltzmann`	None or a Float specifying the Stefan-Boltzmann constant.
`absoluteZero`	None or a Float specifying the absolute zero constant.
`waveFormulation`	A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems.
`universalGas`	None or a Float specifying the universal gas constant.
`noPartsInputFile`	A Boolean specifying whether an input file should be written without parts and assemblies.
`endRestartStep`	A Boolean specifying that the step specified by restartStep should be terminated at the increment specified by restartIncrement.
`shellToSolid`	A Boolean specifying that a shell global model drives a solid submodel.
`lastChangedCount`	A Float specifying the time stamp that indicates when the model was last changed.
`description`	A String specifying the purpose and contents of the Model object.
`restartJob`	A String specifying the name of the job that generated the restart data.
`restartStep`	A String specifying the name of the step where the restart analysis will start.
`globalJob`	A String specifying the name of the job that generated the results for the global model.
`copyConstraints`	A boolean specifying the status of constraints created in a model, in the model which instances this model.
`copyConnectors`	A boolean specifying the status of connectors created in a model, in the model which instances this model.
`copyInteractions`	A boolean specifying the status of interactions created in a model, in the model which instances this model.
`keywordBlock`	A KeywordBlock object.
`amplitudes`	A repository of Amplitude objects.
`profiles`	A repository of Profile objects.
`boundaryConditions`	A repository of BoundaryCondition objects.
`constraints`	A repository of ConstrainedSketchConstraint objects.
`analyticalFields`	A repository of AnalyticalField objects.
`discreteFields`	A repository of DiscreteField objects.
`predefinedFields`	A repository of PredefinedField objects.
`interactions`	A repository of Interaction objects.
`interactionProperties`	A repository of InteractionProperty objects.
`contactControls`	A repository of ContactControl objects.
`contactInitializations`	A repository of ContactInitialization objects.
`contactStabilizations`	A repository of ContactStabilization objects.
`linkedInstances`	A tuple of tuples of Strings specifying the linked child PartInstance name in the current model to the corresponding parent PartInstance name in a different model.
`linkedParts`	A tuple of tuples of Strings specifying the linked child Part name in the current model to the corresponding parent Part name in a different model.
`loads`	A repository of Load objects.
`materials`	A repository of Material objects.
`calibrations`	A repository of Calibration objects.
`sections`	A repository of Section objects.
`remeshingRules`	A repository of RemeshingRule objects.
`sketches`	A repository of ConstrainedSketch objects.
`parts`	A repository of Part objects.
`steps`	A repository of Step objects.
`featureOptions`	A FeatureOptions object.
`adaptiveMeshConstraints`	A repository of AdaptiveMeshConstraint objects.
`adaptiveMeshControls`	A repository of AdaptiveMeshControl objects.
`timePoints`	A repository of TimePoint objects.
`filters`	A repository of Filter objects.
`integratedOutputSections`	A repository of IntegratedOutputSection objects.
`fieldOutputRequests`	A repository of FieldOutputRequest objects.
`historyOutputRequests`	A repository of HistoryOutputRequest objects.
`optimizationTasks`	A repository of OptimizationTask objects.
`tableCollections`	A repository of TableCollection objects.
`eventSeriesTypes`	A repository of EventSeriesType objects.
`eventSeriesDatas`	A repository of EventSeriesData objects.
`restartIncrement`	An Int specifying the increment, interval, iteration or cycle where the restart analysis will start.
`rootAssembly`	An Assembly object.

Public Methods:

`ButterworthFilter`(name, cutoffFrequency[, ...])	This method creates a ButterworthFilter object.
`Chebyshev1Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev1Filter object.
`Chebyshev2Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev2Filter object.
`OperatorFilter`(name, cutoffFrequency[, ...])	This method creates an OperatorFilter object.

Inherited from ModelBase

`__init__`(name[, description, ...])	This method creates a Model object.
`ModelFromInputFile`(name, inputFileName)	This method creates a Model object by reading the keywords in an input file and creating the corresponding Abaqus/CAE objects.
`ModelFromOdbFile`(name, odbFileName)	This method creates a Model object by reading an output database and creating any corresponding Abaqus/CAE objects.
`ModelFromNastranFile`(modelName, inputFileName)	This method creates a Model object by reading the keywords in a Nastran bulk data file or Nastran input file and creating any corresponding Abaqus/CAE objects.
`setValues`([description, noPartsInputFile, ...])	This method modifies the Model object.

Member Details:

ButterworthFilter( name, cutoffFrequency, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates a ButterworthFilter object.

Note

This function can be accessed by:

mdb.models[name].ButterworthFilter
session.odbs[name].ButterworthFilter

Note

Check ButterworthFilter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

A ButterworthFilter object.

Return type:¶

ButterworthFilter

Raises:¶

InvalidNameError –
RangeError –

Chebyshev1Filter( name, cutoffFrequency, rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates a Chebyshev1Filter object.

Note

This function can be accessed by:

mdb.models[name].Chebyshev1Filter
session.odbs[name].Chebyshev1Filter

Note

Check Chebyshev1Filter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
rippleFactor=0¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers. The default value is 0.225.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

A Chebyshev1Filter object.

Return type:¶

Chebyshev1Filter

Raises:¶

InvalidNameError –
RangeError –

Chebyshev2Filter( name, cutoffFrequency, rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates a Chebyshev2Filter object.

Note

This function can be accessed by:

mdb.models[name].Chebyshev2Filter
session.odbs[name].Chebyshev2Filter

Note

Check Chebyshev2Filter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
rippleFactor=0¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

A Chebyshev2Filter object.

Return type:¶

Chebyshev2Filter

Raises:¶

InvalidNameError –
RangeError –

OperatorFilter( name, cutoffFrequency, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates an OperatorFilter object.

Note

This function can be accessed by:

mdb.models[name].OperatorFilter
session.odbs[name].OperatorFilter

Note

Check OperatorFilter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

An OperatorFilter object.

Return type:¶

OperatorFilter

Raises:¶

InvalidNameError –
RangeError –

In Odb¶

class FilterOdb(name, analysisTitle='', description='', path='')[source]¶

Bases: OdbBase

The Odb object is the in-memory representation of an output database (ODB) file.

Note

This object can be accessed by:

import odbAccess
session.odbs[name]

Note

Check FilterOdb on help.3ds.com/2024.

Public Data Attributes:

Inherited from OdbBase

`isReadOnly`	A Boolean specifying whether the output database was opened with read-only access.
`amplitudes`	A repository of Amplitude objects.
`filters`	A repository of Filter objects.
`rootAssembly`	An OdbAssembly object.
`jobData`	A JobData object.
`parts`	A repository of OdbPart objects.
`materials`	A repository of Material objects.
`steps`	A repository of OdbStep objects.
`sections`	A repository of Section objects.
`sectionCategories`	A repository of SectionCategory objects.
`sectorDefinition`	A SectorDefinition object.
`userData`	A UserData object.
`customData`	A RepositorySupport object.
`profiles`	A repository of Profile objects.

Public Methods:

`ButterworthFilter`(name, cutoffFrequency[, ...])	This method creates a ButterworthFilter object.
`Chebyshev1Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev1Filter object.
`Chebyshev2Filter`(name, cutoffFrequency[, ...])	This method creates a Chebyshev2Filter object.
`OperatorFilter`(name, cutoffFrequency[, ...])	This method creates an OperatorFilter object.

Inherited from OdbBase

`__init__`(name[, analysisTitle, description, ...])	This method creates a new Odb object.
`close`()	This method closes an output database.
`getFrame`(frameValue[, match])	This method returns the frame at the specified time, frequency, or mode.
`save`()	This method saves output to an output database (.odb ) file.
`update`()	This method is used to update an Odb object in memory while an Abaqus analysis writes data to the associated output database.

Member Details:

ButterworthFilter( name, cutoffFrequency, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates a ButterworthFilter object.

Note

This function can be accessed by:

mdb.models[name].ButterworthFilter
session.odbs[name].ButterworthFilter

Note

Check ButterworthFilter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

A ButterworthFilter object.

Return type:¶

ButterworthFilter

Raises:¶

InvalidNameError –
RangeError –

Chebyshev1Filter( name, cutoffFrequency, rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates a Chebyshev1Filter object.

Note

This function can be accessed by:

mdb.models[name].Chebyshev1Filter
session.odbs[name].Chebyshev1Filter

Note

Check Chebyshev1Filter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
rippleFactor=0¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers. The default value is 0.225.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

A Chebyshev1Filter object.

Return type:¶

Chebyshev1Filter

Raises:¶

InvalidNameError –
RangeError –

Chebyshev2Filter( name, cutoffFrequency, rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates a Chebyshev2Filter object.

Note

This function can be accessed by:

mdb.models[name].Chebyshev2Filter
session.odbs[name].Chebyshev2Filter

Note

Check Chebyshev2Filter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
rippleFactor=0¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

A Chebyshev2Filter object.

Return type:¶

Chebyshev2Filter

Raises:¶

InvalidNameError –
RangeError –

OperatorFilter( name, cutoffFrequency, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method creates an OperatorFilter object.

Note

This function can be accessed by:

mdb.models[name].OperatorFilter
session.odbs[name].OperatorFilter

Note

Check OperatorFilter on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
cutoffFrequency¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:¶

An OperatorFilter object.

Return type:¶

OperatorFilter

Raises:¶

InvalidNameError –
RangeError –

Other Classes¶

class ButterworthFilter( name, cutoffFrequency, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

Bases: Filter

The ButterworthFilter object defines a Butterworth type filter. The ButterworthFilter object is derived from the Filter object.

Note

This object can be accessed by:

import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

The corresponding analysis keywords are:

FILTER

Note

Check ButterworthFilter on help.3ds.com/2024.

Member Details:

halt : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

limit : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

operation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order : --is-rst--:py:class:`int` = 2[source]¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

setValues(order=2, operation=NONE, halt=0, limit=None, invariant=NONE)[source]¶

This method modifies the ButterworthFilter object.

Note

Check ButterworthFilter.setValues on help.3ds.com/2024.

Parameters:¶

order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Raises:¶

RangeError –

class Filter[source]¶

Bases: object

The Filter object is the abstract base type for other Filter objects. The Filter object has no explicit constructor. The methods and members of the Filter object are common to all objects derived from the Filter.

Note

This object can be accessed by:

import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

Note

Check Filter on help.3ds.com/2024.

Member Details:

cutoffFrequency : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

halt : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

limit : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

operation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order : --is-rst--:py:class:`int` = 2[source]¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

class Chebyshev1Filter( name, cutoffFrequency, rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

Bases: Filter

The Chebyshev1Filter object defines a Chebyshev type 1 filter. The Chebyshev1Filter object is derived from the Filter object.

Note

This object can be accessed by:

import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

The corresponding analysis keywords are:

FILTER

Note

Check Chebyshev1Filter on help.3ds.com/2024.

Member Details:

halt : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

limit : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

operation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order : --is-rst--:py:class:`int` = 2[source]¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

rippleFactor : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers. The default value is 0.225.

setValues( rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method modifies the Chebyshev1Filter object.

Note

Check Chebyshev1Filter.setValues on help.3ds.com/2024.

Parameters:¶

rippleFactor=0¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers. The default value is 0.225.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Raises:¶

RangeError –

class Chebyshev2Filter( name, cutoffFrequency, rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

Bases: Filter

The Chebyshev2Filter object defines a Chebyshev type 2 filter. The Chebyshev2Filter object is derived from the Filter object.

Note

This object can be accessed by:

import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

The corresponding analysis keywords are:

FILTER

Note

Check Chebyshev2Filter on help.3ds.com/2024.

Member Details:

halt : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

limit : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

operation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order : --is-rst--:py:class:`int` = 2[source]¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

rippleFactor : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.

setValues( rippleFactor=0, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

This method modifies the Chebyshev2Filter object.

Note

Check Chebyshev2Filter.setValues on help.3ds.com/2024.

Parameters:¶

rippleFactor=0¶: A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.
order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Raises:¶

RangeError –

class OperatorFilter( name, cutoffFrequency, order=2, operation=NONE, halt=0, limit=None, invariant=NONE, )[source]¶

Bases: Filter

The OperatorFilter object defines an operator filter. The OperatorFilter object is derived from the Filter object.

Note

This object can be accessed by:

import filter
mdb.models[name].filters[name]
import odbFilter
session.odbs[name].filters[name]

The corresponding analysis keywords are:

FILTER

Note

Check OperatorFilter on help.3ds.com/2024.

Member Details:

halt : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

limit : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

operation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order : --is-rst--:py:class:`int` = 2[source]¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

setValues(order=2, operation=NONE, halt=0, limit=None, invariant=NONE)[source]¶

This method modifies the OperatorFilter object.

Note

Check OperatorFilter.setValues on help.3ds.com/2024.

Parameters:¶

order=2¶: An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
operation=NONE¶: A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.
halt=0¶: A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.
limit=None¶: None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.
invariant=NONE¶: A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Raises:¶

RangeError –