pyHarm.Correctors.ABCCorrector

Classes

ABCCorrector

This is the abstract class ruling the corrector class. The system is responsible for adding the correction residual equation to the augmented system.

Module Contents

class pyHarm.Correctors.ABCCorrector.ABCCorrector(**kwargs)

Bases: abc.ABC

This is the abstract class ruling the corrector class. The system is responsible for adding the correction residual equation to the augmented system.

property factory_keyword: str
Abstractmethod:

name of the class to call in the factory in order to create an instance of the class.

Type:

str

abstractmethod ClosureEquation(solx: numpy.ndarray, sol: pyHarm.Solver.SystemSolution, sollist: list[pyHarm.Solver.SystemSolution]) → numpy.ndarray

Computes the residual contribution of the correction equation.

Parameters:

  • solx (np.ndarray) – actual displacement vector.

  • sol (SystemSolution) – actual SystemSolution that contains the starting point.

  • sollist (list[SystemSolution]) – list of SystemSolutions from previous analysis steps.

abstractmethod ClosureJacobian(solx: numpy.ndarray, sol: pyHarm.Solver.SystemSolution, sollist: list[pyHarm.Solver.SystemSolution]) → tuple[numpy.ndarray, numpy.ndarray]

Computes the jacobian contribution of the correction equation.

Parameters:

  • solx (np.ndarray) – actual displacement vector.

  • sol (SystemSolution) – actual SystemSolution that contains the starting point.

  • sollist (list[SystemSolution]) – list of SystemSolutions from previous analysis steps.