petsc4py.PETSc.SNESLineSearch#
- class petsc4py.PETSc.SNESLineSearch#
Bases:
Object
Linesearch object used by SNES solvers.
See also
Enumerations
SNES linesearch type.
Methods Summary
create
([comm])Create a new linesearch object.
destroy
()Destroy the linesearch object.
getOrder
()Return the order of the linesearch.
Return the tolerance parameters used in the linesearch.
getType
()Return the type of the linesearch.
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 toSys.getDefaultComm
.- Return type:
See also
- destroy()#
Destroy the linesearch object.
Collective.
See also
Source code at petsc4py/PETSc/SNES.pyx:2908
- Return type:
- getOrder()#
Return the order of the linesearch.
Not collective.
See also
Source code at petsc4py/PETSc/SNES.pyx:2881
- Return type:
- getTolerances()#
Return the tolerance parameters used in the linesearch.
Not collective.
- Returns:
- Return type:
See also
- getType()#
Return the type of the linesearch.
Not collective.
See also
Source code at petsc4py/PETSc/SNES.pyx:2786
- Return type:
- setFromOptions()#
Configure the linesearch from the options database.
Collective.
See also
Source code at petsc4py/PETSc/SNES.pyx:2755
- Return type:
- setOrder(order)#
Set the order of the linesearch.
Logically collective.
See also
- 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:
- Return type:
See also
- setType(ls_type)#
Set the type of the linesearch.
Logically collective.
See also