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=abaqusConstants.NOT_SET, modelType=abaqusConstants.STANDARD_EXPLICIT, universalGas=None, copyConstraints=ON, copyConnectors=ON, copyInteractions=ON)[source]#

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/0.1..

ButterworthFilter(name, cutoffFrequency, order=2, operation=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • order (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • rippleFactor (float, default: 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 (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • rippleFactor (float, default: 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 (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • order (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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]#

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/0.1..

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.
ButterworthFilter(name, cutoffFrequency, order=2, operation=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • order (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • rippleFactor (float, default: 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 (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • rippleFactor (float, default: 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 (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.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/0.1..

Parameters:

  • name (str) – A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

  • cutoffFrequency (float) – A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

  • order (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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 –

Object features#

Filter#

class Filter[source]#

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/0.1..

Public Data Attributes:

name

A String specifying the repository key.

cutoffFrequency

A Float specifying the attenuation point of the filter.

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.
cutoffFrequency: Optional[float] = None[source]#

A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

halt: Union[AbaqusBoolean, bool] = OFF[source]#

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant: 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: Optional[float] = 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: str = ''[source]#

A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

operation: SymbolicConstant = NONE[source]#

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order: 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.

ButterworthFilter#

class ButterworthFilter(name, cutoffFrequency, order=2, operation=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.NONE)[source]#

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/0.1..

Public Data Attributes:

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.
Inherited from Filter

name

A String specifying the repository key.

cutoffFrequency

A Float specifying the attenuation point of the filter.

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.

Public Methods:

__init__(name, cutoffFrequency[, order, ...])

This method creates a ButterworthFilter object.

setValues([order, operation, halt, limit, ...])

This method modifies the ButterworthFilter object.
halt: Union[AbaqusBoolean, bool] = OFF[source]#

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant: 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: Optional[float] = 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: SymbolicConstant = NONE[source]#

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.NONE)[source]#

This method modifies the ButterworthFilter object.

Note

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

Parameters:

  • order (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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 –

Chebyshev1Filter#

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

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/0.1..

Public Data Attributes:

rippleFactor

A Float specifying the amount of allowable ripple in the filter.

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.
Inherited from Filter

name

A String specifying the repository key.

cutoffFrequency

A Float specifying the attenuation point of the filter.

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.

Public Methods:

__init__(name, cutoffFrequency[, ...])

This method creates a Chebyshev1Filter object.

setValues([rippleFactor, order, operation, ...])

This method modifies the Chebyshev1Filter object.
halt: Union[AbaqusBoolean, bool] = OFF[source]#

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant: 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: Optional[float] = 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: SymbolicConstant = NONE[source]#

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order: 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: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.NONE)[source]#

This method modifies the Chebyshev1Filter object.

Note

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

Parameters:

  • rippleFactor (float, default: 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 (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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 –

Chebyshev2Filter#

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

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/0.1..

Public Data Attributes:

rippleFactor

A Float specifying the amount of allowable ripple in the filter.

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.
Inherited from Filter

name

A String specifying the repository key.

cutoffFrequency

A Float specifying the attenuation point of the filter.

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.

Public Methods:

__init__(name, cutoffFrequency[, ...])

This method creates a Chebyshev2Filter object.

setValues([rippleFactor, order, operation, ...])

This method modifies the Chebyshev2Filter object.
halt: Union[AbaqusBoolean, bool] = OFF[source]#

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant: 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: Optional[float] = 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: SymbolicConstant = NONE[source]#

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order: 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: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.NONE)[source]#

This method modifies the Chebyshev2Filter object.

Note

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

Parameters:

  • rippleFactor (float, default: 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 (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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 –

OperatorFilter#

class OperatorFilter(name, cutoffFrequency, order=2, operation=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.NONE)[source]#

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/0.1..

Public Data Attributes:

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.
Inherited from Filter

name

A String specifying the repository key.

cutoffFrequency

A Float specifying the attenuation point of the filter.

order

An Int specifying the highest power of the filter transfer function.

operation

A SymbolicConstant specifying the filter operator.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached.

limit

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.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied.

Public Methods:

__init__(name, cutoffFrequency[, order, ...])

This method creates an OperatorFilter object.

setValues([order, operation, halt, limit, ...])

This method modifies the OperatorFilter object.
halt: Union[AbaqusBoolean, bool] = OFF[source]#

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

invariant: 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: Optional[float] = 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: SymbolicConstant = NONE[source]#

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

order: 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=abaqusConstants.NONE, halt=OFF, limit=None, invariant=abaqusConstants.NONE)[source]#

This method modifies the OperatorFilter object.

Note

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

Parameters:

  • order (int, default: 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 (SymbolicConstant, default: NONE) – A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

  • halt (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

  • limit (Optional[float], default: 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 (SymbolicConstant, default: 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 –