petsc4py.PETSc.SNES
===================

.. autoclass:: petsc4py.PETSc.SNES
   :show-inheritance:

   
   .. rubric:: Enumerations
   .. autosummary::
      :toctree:
   
      ~petsc4py.PETSc.SNES.ConvergedReason
      ~petsc4py.PETSc.SNES.NormSchedule
      ~petsc4py.PETSc.SNES.Type

   
   .. rubric:: Methods Summary
   .. autosummary::
   
      ~petsc4py.PETSc.SNES.appendOptionsPrefix
      ~petsc4py.PETSc.SNES.callConvergenceTest
      ~petsc4py.PETSc.SNES.computeFunction
      ~petsc4py.PETSc.SNES.computeJacobian
      ~petsc4py.PETSc.SNES.computeNGS
      ~petsc4py.PETSc.SNES.computeObjective
      ~petsc4py.PETSc.SNES.converged
      ~petsc4py.PETSc.SNES.create
      ~petsc4py.PETSc.SNES.createPython
      ~petsc4py.PETSc.SNES.destroy
      ~petsc4py.PETSc.SNES.getApplicationContext
      ~petsc4py.PETSc.SNES.getCompositeNumber
      ~petsc4py.PETSc.SNES.getCompositeSNES
      ~petsc4py.PETSc.SNES.getConvergedReason
      ~petsc4py.PETSc.SNES.getConvergenceHistory
      ~petsc4py.PETSc.SNES.getConvergenceTest
      ~petsc4py.PETSc.SNES.getDM
      ~petsc4py.PETSc.SNES.getDivergenceTolerance
      ~petsc4py.PETSc.SNES.getErrorIfNotConverged
      ~petsc4py.PETSc.SNES.getFASCoarseSolve
      ~petsc4py.PETSc.SNES.getFASCycleSNES
      ~petsc4py.PETSc.SNES.getFASInjection
      ~petsc4py.PETSc.SNES.getFASInterpolation
      ~petsc4py.PETSc.SNES.getFASLevels
      ~petsc4py.PETSc.SNES.getFASRestriction
      ~petsc4py.PETSc.SNES.getFASSmoother
      ~petsc4py.PETSc.SNES.getFASSmootherDown
      ~petsc4py.PETSc.SNES.getFASSmootherUp
      ~petsc4py.PETSc.SNES.getFunction
      ~petsc4py.PETSc.SNES.getFunctionEvaluations
      ~petsc4py.PETSc.SNES.getFunctionNorm
      ~petsc4py.PETSc.SNES.getInitialGuess
      ~petsc4py.PETSc.SNES.getIterationNumber
      ~petsc4py.PETSc.SNES.getJacobian
      ~petsc4py.PETSc.SNES.getKSP
      ~petsc4py.PETSc.SNES.getKSPFailures
      ~petsc4py.PETSc.SNES.getLinearSolveIterations
      ~petsc4py.PETSc.SNES.getMaxFunctionEvaluations
      ~petsc4py.PETSc.SNES.getMaxKSPFailures
      ~petsc4py.PETSc.SNES.getMaxStepFailures
      ~petsc4py.PETSc.SNES.getMonitor
      ~petsc4py.PETSc.SNES.getNASMNumber
      ~petsc4py.PETSc.SNES.getNASMSNES
      ~petsc4py.PETSc.SNES.getNGS
      ~petsc4py.PETSc.SNES.getNPC
      ~petsc4py.PETSc.SNES.getNPCSide
      ~petsc4py.PETSc.SNES.getNormSchedule
      ~petsc4py.PETSc.SNES.getObjective
      ~petsc4py.PETSc.SNES.getOptionsPrefix
      ~petsc4py.PETSc.SNES.getParamsEW
      ~petsc4py.PETSc.SNES.getPythonContext
      ~petsc4py.PETSc.SNES.getPythonType
      ~petsc4py.PETSc.SNES.getRhs
      ~petsc4py.PETSc.SNES.getSolution
      ~petsc4py.PETSc.SNES.getSolutionUpdate
      ~petsc4py.PETSc.SNES.getStepFailures
      ~petsc4py.PETSc.SNES.getTRTolerances
      ~petsc4py.PETSc.SNES.getTRUpdateParameters
      ~petsc4py.PETSc.SNES.getTolerances
      ~petsc4py.PETSc.SNES.getType
      ~petsc4py.PETSc.SNES.getUpdate
      ~petsc4py.PETSc.SNES.getUseEW
      ~petsc4py.PETSc.SNES.getUseFD
      ~petsc4py.PETSc.SNES.getUseKSP
      ~petsc4py.PETSc.SNES.getUseMF
      ~petsc4py.PETSc.SNES.getVIInactiveSet
      ~petsc4py.PETSc.SNES.hasNPC
      ~petsc4py.PETSc.SNES.logConvergenceHistory
      ~petsc4py.PETSc.SNES.monitor
      ~petsc4py.PETSc.SNES.monitorCancel
      ~petsc4py.PETSc.SNES.reset
      ~petsc4py.PETSc.SNES.setApplicationContext
      ~petsc4py.PETSc.SNES.setConvergedReason
      ~petsc4py.PETSc.SNES.setConvergenceHistory
      ~petsc4py.PETSc.SNES.setConvergenceTest
      ~petsc4py.PETSc.SNES.setDM
      ~petsc4py.PETSc.SNES.setDivergenceTolerance
      ~petsc4py.PETSc.SNES.setErrorIfNotConverged
      ~petsc4py.PETSc.SNES.setFASInjection
      ~petsc4py.PETSc.SNES.setFASInterpolation
      ~petsc4py.PETSc.SNES.setFASLevels
      ~petsc4py.PETSc.SNES.setFASRScale
      ~petsc4py.PETSc.SNES.setFASRestriction
      ~petsc4py.PETSc.SNES.setForceIteration
      ~petsc4py.PETSc.SNES.setFromOptions
      ~petsc4py.PETSc.SNES.setFunction
      ~petsc4py.PETSc.SNES.setFunctionNorm
      ~petsc4py.PETSc.SNES.setInitialGuess
      ~petsc4py.PETSc.SNES.setIterationNumber
      ~petsc4py.PETSc.SNES.setJacobian
      ~petsc4py.PETSc.SNES.setKSP
      ~petsc4py.PETSc.SNES.setLineSearchPreCheck
      ~petsc4py.PETSc.SNES.setMaxFunctionEvaluations
      ~petsc4py.PETSc.SNES.setMaxKSPFailures
      ~petsc4py.PETSc.SNES.setMaxStepFailures
      ~petsc4py.PETSc.SNES.setMonitor
      ~petsc4py.PETSc.SNES.setNGS
      ~petsc4py.PETSc.SNES.setNPC
      ~petsc4py.PETSc.SNES.setNPCSide
      ~petsc4py.PETSc.SNES.setNormSchedule
      ~petsc4py.PETSc.SNES.setObjective
      ~petsc4py.PETSc.SNES.setOptionsPrefix
      ~petsc4py.PETSc.SNES.setParamsEW
      ~petsc4py.PETSc.SNES.setPatchCellNumbering
      ~petsc4py.PETSc.SNES.setPatchComputeFunction
      ~petsc4py.PETSc.SNES.setPatchComputeOperator
      ~petsc4py.PETSc.SNES.setPatchConstructType
      ~petsc4py.PETSc.SNES.setPatchDiscretisationInfo
      ~petsc4py.PETSc.SNES.setPythonContext
      ~petsc4py.PETSc.SNES.setPythonType
      ~petsc4py.PETSc.SNES.setResetCounters
      ~petsc4py.PETSc.SNES.setSolution
      ~petsc4py.PETSc.SNES.setTRTolerances
      ~petsc4py.PETSc.SNES.setTRUpdateParameters
      ~petsc4py.PETSc.SNES.setTolerances
      ~petsc4py.PETSc.SNES.setType
      ~petsc4py.PETSc.SNES.setUp
      ~petsc4py.PETSc.SNES.setUpMatrices
      ~petsc4py.PETSc.SNES.setUpdate
      ~petsc4py.PETSc.SNES.setUseEW
      ~petsc4py.PETSc.SNES.setUseFD
      ~petsc4py.PETSc.SNES.setUseKSP
      ~petsc4py.PETSc.SNES.setUseMF
      ~petsc4py.PETSc.SNES.setVariableBounds
      ~petsc4py.PETSc.SNES.solve
      ~petsc4py.PETSc.SNES.view

   
   .. rubric:: Attributes Summary
   .. autosummary::
   
      ~petsc4py.PETSc.SNES.appctx
      ~petsc4py.PETSc.SNES.atol
      ~petsc4py.PETSc.SNES.dm
      ~petsc4py.PETSc.SNES.history
      ~petsc4py.PETSc.SNES.is_converged
      ~petsc4py.PETSc.SNES.is_diverged
      ~petsc4py.PETSc.SNES.is_iterating
      ~petsc4py.PETSc.SNES.its
      ~petsc4py.PETSc.SNES.ksp
      ~petsc4py.PETSc.SNES.max_funcs
      ~petsc4py.PETSc.SNES.max_it
      ~petsc4py.PETSc.SNES.norm
      ~petsc4py.PETSc.SNES.npc
      ~petsc4py.PETSc.SNES.reason
      ~petsc4py.PETSc.SNES.rtol
      ~petsc4py.PETSc.SNES.stol
      ~petsc4py.PETSc.SNES.use_ew
      ~petsc4py.PETSc.SNES.use_fd
      ~petsc4py.PETSc.SNES.use_ksp
      ~petsc4py.PETSc.SNES.use_mf
      ~petsc4py.PETSc.SNES.vec_rhs
      ~petsc4py.PETSc.SNES.vec_sol
      ~petsc4py.PETSc.SNES.vec_upd

   
   .. rubric:: Methods Documentation
   
   .. automethod:: appendOptionsPrefix
   .. automethod:: callConvergenceTest
   .. automethod:: computeFunction
   .. automethod:: computeJacobian
   .. automethod:: computeNGS
   .. automethod:: computeObjective
   .. automethod:: converged
   .. automethod:: create
   .. automethod:: createPython
   .. automethod:: destroy
   .. automethod:: getApplicationContext
   .. automethod:: getCompositeNumber
   .. automethod:: getCompositeSNES
   .. automethod:: getConvergedReason
   .. automethod:: getConvergenceHistory
   .. automethod:: getConvergenceTest
   .. automethod:: getDM
   .. automethod:: getDivergenceTolerance
   .. automethod:: getErrorIfNotConverged
   .. automethod:: getFASCoarseSolve
   .. automethod:: getFASCycleSNES
   .. automethod:: getFASInjection
   .. automethod:: getFASInterpolation
   .. automethod:: getFASLevels
   .. automethod:: getFASRestriction
   .. automethod:: getFASSmoother
   .. automethod:: getFASSmootherDown
   .. automethod:: getFASSmootherUp
   .. automethod:: getFunction
   .. automethod:: getFunctionEvaluations
   .. automethod:: getFunctionNorm
   .. automethod:: getInitialGuess
   .. automethod:: getIterationNumber
   .. automethod:: getJacobian
   .. automethod:: getKSP
   .. automethod:: getKSPFailures
   .. automethod:: getLinearSolveIterations
   .. automethod:: getMaxFunctionEvaluations
   .. automethod:: getMaxKSPFailures
   .. automethod:: getMaxStepFailures
   .. automethod:: getMonitor
   .. automethod:: getNASMNumber
   .. automethod:: getNASMSNES
   .. automethod:: getNGS
   .. automethod:: getNPC
   .. automethod:: getNPCSide
   .. automethod:: getNormSchedule
   .. automethod:: getObjective
   .. automethod:: getOptionsPrefix
   .. automethod:: getParamsEW
   .. automethod:: getPythonContext
   .. automethod:: getPythonType
   .. automethod:: getRhs
   .. automethod:: getSolution
   .. automethod:: getSolutionUpdate
   .. automethod:: getStepFailures
   .. automethod:: getTRTolerances
   .. automethod:: getTRUpdateParameters
   .. automethod:: getTolerances
   .. automethod:: getType
   .. automethod:: getUpdate
   .. automethod:: getUseEW
   .. automethod:: getUseFD
   .. automethod:: getUseKSP
   .. automethod:: getUseMF
   .. automethod:: getVIInactiveSet
   .. automethod:: hasNPC
   .. automethod:: logConvergenceHistory
   .. automethod:: monitor
   .. automethod:: monitorCancel
   .. automethod:: reset
   .. automethod:: setApplicationContext
   .. automethod:: setConvergedReason
   .. automethod:: setConvergenceHistory
   .. automethod:: setConvergenceTest
   .. automethod:: setDM
   .. automethod:: setDivergenceTolerance
   .. automethod:: setErrorIfNotConverged
   .. automethod:: setFASInjection
   .. automethod:: setFASInterpolation
   .. automethod:: setFASLevels
   .. automethod:: setFASRScale
   .. automethod:: setFASRestriction
   .. automethod:: setForceIteration
   .. automethod:: setFromOptions
   .. automethod:: setFunction
   .. automethod:: setFunctionNorm
   .. automethod:: setInitialGuess
   .. automethod:: setIterationNumber
   .. automethod:: setJacobian
   .. automethod:: setKSP
   .. automethod:: setLineSearchPreCheck
   .. automethod:: setMaxFunctionEvaluations
   .. automethod:: setMaxKSPFailures
   .. automethod:: setMaxStepFailures
   .. automethod:: setMonitor
   .. automethod:: setNGS
   .. automethod:: setNPC
   .. automethod:: setNPCSide
   .. automethod:: setNormSchedule
   .. automethod:: setObjective
   .. automethod:: setOptionsPrefix
   .. automethod:: setParamsEW
   .. automethod:: setPatchCellNumbering
   .. automethod:: setPatchComputeFunction
   .. automethod:: setPatchComputeOperator
   .. automethod:: setPatchConstructType
   .. automethod:: setPatchDiscretisationInfo
   .. automethod:: setPythonContext
   .. automethod:: setPythonType
   .. automethod:: setResetCounters
   .. automethod:: setSolution
   .. automethod:: setTRTolerances
   .. automethod:: setTRUpdateParameters
   .. automethod:: setTolerances
   .. automethod:: setType
   .. automethod:: setUp
   .. automethod:: setUpMatrices
   .. automethod:: setUpdate
   .. automethod:: setUseEW
   .. automethod:: setUseFD
   .. automethod:: setUseKSP
   .. automethod:: setUseMF
   .. automethod:: setVariableBounds
   .. automethod:: solve
   .. automethod:: view

   
   .. rubric:: Attributes Documentation
   
   .. autoattribute:: appctx
   .. autoattribute:: atol
   .. autoattribute:: dm
   .. autoattribute:: history
   .. autoattribute:: is_converged
   .. autoattribute:: is_diverged
   .. autoattribute:: is_iterating
   .. autoattribute:: its
   .. autoattribute:: ksp
   .. autoattribute:: max_funcs
   .. autoattribute:: max_it
   .. autoattribute:: norm
   .. autoattribute:: npc
   .. autoattribute:: reason
   .. autoattribute:: rtol
   .. autoattribute:: stol
   .. autoattribute:: use_ew
   .. autoattribute:: use_fd
   .. autoattribute:: use_ksp
   .. autoattribute:: use_mf
   .. autoattribute:: vec_rhs
   .. autoattribute:: vec_sol
   .. autoattribute:: vec_upd
