# user_defined.py¶

Define the LinearUserDefined class.

class`openmdao.solvers.linear.user_defined.`

`LinearUserDefined`

(solve_function=None,**kwargs)[source]Bases:

`openmdao.solvers.solver.LinearSolver`

LinearUserDefined solver.

This is a solver that wraps a user-written linear solve function.

- Attributes

solve_functionfunctionCustom function containing the solve_linear function. The default is None, which means the name defaults to “solve_linear”.

`SOLVER`

= 'LN: USER'

`__init__`

(solve_function=None,**kwargs)[source]Initialize all attributes.

- Parameters

solve_functionfunctionCustom function containing the solve_linear function. The default is None, which means the name defaults to “solve_linear”.

**kwargsdictOptions dictionary.

`add_recorder`

(recorder)Add a recorder to the solver’s RecordingManager.

- Parameters

recorder<CaseRecorder>A recorder instance to be added to RecManager.

`cleanup`

()Clean up resources prior to exit.

property`msginfo`

Return info to prepend to messages.

- Returns

- str
Info to prepend to messages.

`record_iteration`

(**kwargs)Record an iteration of the current Solver.

- Parameters

**kwargsdictKeyword arguments (used for abs and rel error).

`solve`

(mode,rel_systems=None)[source]Solve the linear system for the problem in self._system().

The full solution vector is returned.

- Parameters

modestringDerivative mode, can be ‘fwd’ or ‘rev’.

rel_systemsset of strSet of names of relevant systems based on the current linear solve.