petsc4py.PETSc.SNESLineSearch#

class petsc4py.PETSc.SNESLineSearch#

Bases: Object

Linesearch object used by SNES solvers.

See also

SNESLineSearch

Enumerations

Type

SNES linesearch type.

Methods Summary

`create`([comm])	Create a new linesearch object.
`destroy`()	Destroy the linesearch object.
`getOrder`()	Return the order of the linesearch.
`getTolerances`()	Return the tolerance parameters used in the linesearch.
`getType`()	Return the type of the linesearch.
`setFromOptions`()	Configure the linesearch from the options database.
`setOrder`(order)	Set the order of the linesearch.
`setTolerances`([minstep, maxstep, rtol, ...])	Set the tolerance parameters used in the linesearch.
`setType`(ls_type)	Set the type of the linesearch.
`view`([viewer])	View the linesearch object.

Methods Documentation

create(comm=None)#

Create a new linesearch object.

Collective.

Parameters:: comm (Comm, optional) – MPI communicator, defaults to Sys.getDefaultComm.
Return type:: Self

See also

destroy, SNESLineSearchCreate

Source code at petsc4py/PETSc/SNES.pyx:2749

destroy()#

Destroy the linesearch object.

Collective.

See also

SNESLineSearchDestroy

Source code at petsc4py/PETSc/SNES.pyx:2923

Return type:: None

getOrder()#

Return the order of the linesearch.

Not collective.

See also

setOrder, SNESLineSearchGetOrder

Source code at petsc4py/PETSc/SNES.pyx:2896

Return type:: int

getTolerances()#

Return the tolerance parameters used in the linesearch.

Not collective.

Returns:

minstep (float) – Minimum step length.
maxstep (float, optional) – Maximum step length.
rtol (float) – Relative tolerance.
atol (float) – Absolute tolerance.
ltol (float) – Lambda tolerance.
max_its (int) – Maximum number of iterations for the linesearch.

Return type:

tuple[float, float, float, float, float, int]

Source code at petsc4py/PETSc/SNES.pyx:2829

getType()#

Return the type of the linesearch.

Not collective.

See also

setType, SNESLineSearchGetType

Source code at petsc4py/PETSc/SNES.pyx:2801

Return type:: str

setFromOptions()#

Configure the linesearch from the options database.

Collective.

See also

SNESLineSearchSetFromOptions

Source code at petsc4py/PETSc/SNES.pyx:2770

Return type:: None

setOrder(order)#

Set the order of the linesearch.

Logically collective.

See also

getOrder, SNESLineSearchSetOrder

Source code at petsc4py/PETSc/SNES.pyx:2910

Parameters:: order (int)
Return type:: None

setTolerances(minstep=None, maxstep=None, rtol=None, atol=None, ltol=None, max_its=None)#

Set the tolerance parameters used in the linesearch.

Logically collective.

Parameters:

minstep (float) – Minimum step length.
maxstep (float, optional) – Maximum step length.
rtol (float, optional) – Relative tolerance.
atol (float, optional) – Absolute tolerance.
ltol (float, optional) – Lambda tolerance.
max_its (int, optional) – Maximum number of iterations for the linesearch.

Return type: