Skip to content

Test

Test

Test(test_type: str)

Bases: AnalysisComponent

Base class for all OpenSees convergence tests.

Convergence tests define the mathematical criteria used by solution algorithms to determine if equilibrium has been reached at each iteration.

Create a convergence test base instance.

Parameters:

Name Type Description Default
test_type str

The type name of the convergence test.

required

Attributes

_tests class-attribute instance-attribute

_tests: Dict[str, Type['Test']] = {}

test_type instance-attribute

test_type = test_type

Methods:

register_test staticmethod

register_test(name: str, test_class: Type['Test']) -> None

Register a new convergence test class.

Parameters:

Name Type Description Default
name str

Lowercase registry name.

required
test_class Type['Test']

The Test class type to register.

required