petsc4py.PETSc.TAOLineSearch

class petsc4py.PETSc.TAOLineSearch

Bases: Object

TAO Line Search.

Enumerations

ConvergedReason

TAO Line Search Termination Reasons.

Type

TAO Line Search Types.

Methods Summary

apply(x, g, s)

Performs a line-search in a given step direction.

create([comm])

Create a TAO linesearch.

destroy()

Destroy the linesearch object.

getOptionsPrefix()

Return the prefix used for searching for options in the database.

getType()

Return the type of the linesearch.

setFromOptions()

Configure the linesearch from the options database.

setGradient(gradient[, args, kargs])

Set the gradient evaluation callback.

setObjective(objective[, args, kargs])

Set the objective function evaluation callback.

setObjectiveGradient(objgrad[, args, kargs])

Set the objective function and gradient evaluation callback.

setOptionsPrefix(prefix)

Set the prefix used for searching for options in the database.

setType(ls_type)

Set the type of the linesearch.

setUp()

Set up the internal data structures for using the linesearch.

useTAORoutine(tao)

Use the objective and gradient evaluation routines from the given Tao object.

view([viewer])

View the linesearch object.

Methods Documentation

apply(x, g, s)

Performs a line-search in a given step direction.

Collective.

See also

petsc.TaoLineSearchApply

Source code at petsc4py/PETSc/TAO.pyx:2144

Parameters:
Return type:

tuple[float, float, str]

create(comm=None)

Create a TAO linesearch.

Collective.

Parameters:

comm – MPI communicator, defaults to Sys.getDefaultComm.

Return type:

Self

See also

Sys.getDefaultComm, petsc.TaoLineSearchCreate

Source code at petsc4py/PETSc/TAO.pyx:1947

destroy()

Destroy the linesearch object.

Collective.

See also

petsc.TaoLineSearchDestroy

Source code at petsc4py/PETSc/TAO.pyx:1934

Return type:

Self

getOptionsPrefix()

Return the prefix used for searching for options in the database.

Not collective.

See also

Working with PETSc options (TODO), setOptionsPrefix, petsc.TaoLineSearchGetOptionsPrefix

Source code at petsc4py/PETSc/TAO.pyx:2039

Return type:

str

getType()

Return the type of the linesearch.

Not collective.

See also

setType, petsc.TaoLineSearchGetType

Source code at petsc4py/PETSc/TAO.pyx:1987

Return type:

str

setFromOptions()

Configure the linesearch from the options database.

Collective.

See also

Working with PETSc options (TODO), petsc.TaoLineSearchSetFromOptions

Source code at petsc4py/PETSc/TAO.pyx:2001

Return type:

None

setGradient(gradient, args=None, kargs=None)

Set the gradient evaluation callback.

Logically collective.

Parameters:
  • gradient (TAOLSGradientFunction) – The gradient callback.

  • g – The vector to store the gradient.

  • args (tuple[Any, ...] | None) – Positional arguments for the callback.

  • kargs (dict[str, Any] | None) – Keyword arguments for the callback.

Return type:

None

See also

setObjective, setObjectiveGradient, setHessian, petsc.TaoLineSearchSetGradientRoutine

Source code at petsc4py/PETSc/TAO.pyx:2078

setObjective(objective, args=None, kargs=None)

Set the objective function evaluation callback.

Logically collective.

Parameters:
Return type:

None

See also

setGradient, setObjectiveGradient, petsc.TaoLineSearchSetObjectiveRoutine

Source code at petsc4py/PETSc/TAO.pyx:2053

setObjectiveGradient(objgrad, args=None, kargs=None)

Set the objective function and gradient evaluation callback.

Logically collective.

Parameters:
Return type:

None

See also

setObjective, setGradient, setHessian, getObjectiveAndGradient, petsc.TaoLineSearchSetObjectiveAndGradientRoutine

Source code at petsc4py/PETSc/TAO.pyx:2105

setOptionsPrefix(prefix)

Set the prefix used for searching for options in the database.

Logically collective.

See also

Working with PETSc options (TODO), petsc.TaoLineSearchSetOptionsPrefix

Source code at petsc4py/PETSc/TAO.pyx:2025

Return type:

None

setType(ls_type)

Set the type of the linesearch.

Logically collective.

Parameters:

ls_type (Type | str) – The type of the solver.

Return type:

None

See also

getType, petsc.TaoLineSearchSetType

Source code at petsc4py/PETSc/TAO.pyx:1968

setUp()

Set up the internal data structures for using the linesearch.

Collective.

See also

petsc.TaoLineSearchSetUp

Source code at petsc4py/PETSc/TAO.pyx:2013

Return type:

None

useTAORoutine(tao)

Use the objective and gradient evaluation routines from the given Tao object.

Logically collective.

See also

petsc.TaoLineSearchUseTaoRoutines

Source code at petsc4py/PETSc/TAO.pyx:2132

Parameters:

tao (TAO) –

Return type:

None

view(viewer=None)

View the linesearch object.

Collective.

Parameters:

viewer (Viewer | None) – A Viewer instance or None for the default viewer.

Return type:

None

See also

petsc.TaoLineSearchView

Source code at petsc4py/PETSc/TAO.pyx:1915