petsc4py.PETSc.TAO
==================

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

   
   .. rubric:: Enumerations
   .. autosummary::
      :toctree:
   
      ~petsc4py.PETSc.TAO.BNCGType
      ~petsc4py.PETSc.TAO.ConvergedReason
      ~petsc4py.PETSc.TAO.Type

   
   .. rubric:: Methods Summary
   .. autosummary::
   
      ~petsc4py.PETSc.TAO.appendOptionsPrefix
      ~petsc4py.PETSc.TAO.cancelMonitor
      ~petsc4py.PETSc.TAO.computeConstraints
      ~petsc4py.PETSc.TAO.computeDualVariables
      ~petsc4py.PETSc.TAO.computeGradient
      ~petsc4py.PETSc.TAO.computeHessian
      ~petsc4py.PETSc.TAO.computeJacobian
      ~petsc4py.PETSc.TAO.computeObjective
      ~petsc4py.PETSc.TAO.computeObjectiveGradient
      ~petsc4py.PETSc.TAO.computeResidual
      ~petsc4py.PETSc.TAO.computeVariableBounds
      ~petsc4py.PETSc.TAO.create
      ~petsc4py.PETSc.TAO.createPython
      ~petsc4py.PETSc.TAO.destroy
      ~petsc4py.PETSc.TAO.getAppCtx
      ~petsc4py.PETSc.TAO.getBNCGType
      ~petsc4py.PETSc.TAO.getBRGNDampingVector
      ~petsc4py.PETSc.TAO.getBRGNSubsolver
      ~petsc4py.PETSc.TAO.getConstraintTolerances
      ~petsc4py.PETSc.TAO.getConvergedReason
      ~petsc4py.PETSc.TAO.getConvergenceTest
      ~petsc4py.PETSc.TAO.getGradient
      ~petsc4py.PETSc.TAO.getGradientNorm
      ~petsc4py.PETSc.TAO.getHessian
      ~petsc4py.PETSc.TAO.getIterationNumber
      ~petsc4py.PETSc.TAO.getKSP
      ~petsc4py.PETSc.TAO.getLMVMH0
      ~petsc4py.PETSc.TAO.getLMVMH0KSP
      ~petsc4py.PETSc.TAO.getLineSearch
      ~petsc4py.PETSc.TAO.getMaximumFunctionEvaluations
      ~petsc4py.PETSc.TAO.getMaximumIterations
      ~petsc4py.PETSc.TAO.getMonitor
      ~petsc4py.PETSc.TAO.getObjectiveAndGradient
      ~petsc4py.PETSc.TAO.getObjectiveValue
      ~petsc4py.PETSc.TAO.getOptionsPrefix
      ~petsc4py.PETSc.TAO.getPythonContext
      ~petsc4py.PETSc.TAO.getPythonType
      ~petsc4py.PETSc.TAO.getSolution
      ~petsc4py.PETSc.TAO.getSolutionNorm
      ~petsc4py.PETSc.TAO.getSolutionStatus
      ~petsc4py.PETSc.TAO.getTolerances
      ~petsc4py.PETSc.TAO.getType
      ~petsc4py.PETSc.TAO.getUpdate
      ~petsc4py.PETSc.TAO.getVariableBounds
      ~petsc4py.PETSc.TAO.monitor
      ~petsc4py.PETSc.TAO.setAppCtx
      ~petsc4py.PETSc.TAO.setBNCGType
      ~petsc4py.PETSc.TAO.setBRGNDictionaryMatrix
      ~petsc4py.PETSc.TAO.setBRGNRegularizerHessian
      ~petsc4py.PETSc.TAO.setBRGNRegularizerObjectiveGradient
      ~petsc4py.PETSc.TAO.setBRGNRegularizerWeight
      ~petsc4py.PETSc.TAO.setBRGNSmoothL1Epsilon
      ~petsc4py.PETSc.TAO.setConstraintTolerances
      ~petsc4py.PETSc.TAO.setConstraints
      ~petsc4py.PETSc.TAO.setConvergedReason
      ~petsc4py.PETSc.TAO.setConvergenceTest
      ~petsc4py.PETSc.TAO.setEqualityConstraints
      ~petsc4py.PETSc.TAO.setFromOptions
      ~petsc4py.PETSc.TAO.setGradient
      ~petsc4py.PETSc.TAO.setGradientNorm
      ~petsc4py.PETSc.TAO.setHessian
      ~petsc4py.PETSc.TAO.setInitialTrustRegionRadius
      ~petsc4py.PETSc.TAO.setIterationNumber
      ~petsc4py.PETSc.TAO.setJacobian
      ~petsc4py.PETSc.TAO.setJacobianDesign
      ~petsc4py.PETSc.TAO.setJacobianEquality
      ~petsc4py.PETSc.TAO.setJacobianResidual
      ~petsc4py.PETSc.TAO.setJacobianState
      ~petsc4py.PETSc.TAO.setLMVMH0
      ~petsc4py.PETSc.TAO.setMaximumFunctionEvaluations
      ~petsc4py.PETSc.TAO.setMaximumIterations
      ~petsc4py.PETSc.TAO.setMonitor
      ~petsc4py.PETSc.TAO.setObjective
      ~petsc4py.PETSc.TAO.setObjectiveGradient
      ~petsc4py.PETSc.TAO.setOptionsPrefix
      ~petsc4py.PETSc.TAO.setPythonContext
      ~petsc4py.PETSc.TAO.setPythonType
      ~petsc4py.PETSc.TAO.setResidual
      ~petsc4py.PETSc.TAO.setSolution
      ~petsc4py.PETSc.TAO.setStateDesignIS
      ~petsc4py.PETSc.TAO.setTolerances
      ~petsc4py.PETSc.TAO.setType
      ~petsc4py.PETSc.TAO.setUp
      ~petsc4py.PETSc.TAO.setUpdate
      ~petsc4py.PETSc.TAO.setVariableBounds
      ~petsc4py.PETSc.TAO.solve
      ~petsc4py.PETSc.TAO.view

   
   .. rubric:: Attributes Summary
   .. autosummary::
   
      ~petsc4py.PETSc.TAO.appctx
      ~petsc4py.PETSc.TAO.cnorm
      ~petsc4py.PETSc.TAO.converged
      ~petsc4py.PETSc.TAO.ctol
      ~petsc4py.PETSc.TAO.diverged
      ~petsc4py.PETSc.TAO.ftol
      ~petsc4py.PETSc.TAO.function
      ~petsc4py.PETSc.TAO.gnorm
      ~petsc4py.PETSc.TAO.gradient
      ~petsc4py.PETSc.TAO.gtol
      ~petsc4py.PETSc.TAO.iterating
      ~petsc4py.PETSc.TAO.its
      ~petsc4py.PETSc.TAO.ksp
      ~petsc4py.PETSc.TAO.objective
      ~petsc4py.PETSc.TAO.reason
      ~petsc4py.PETSc.TAO.solution

   
   .. rubric:: Methods Documentation
   
   .. automethod:: appendOptionsPrefix
   .. automethod:: cancelMonitor
   .. automethod:: computeConstraints
   .. automethod:: computeDualVariables
   .. automethod:: computeGradient
   .. automethod:: computeHessian
   .. automethod:: computeJacobian
   .. automethod:: computeObjective
   .. automethod:: computeObjectiveGradient
   .. automethod:: computeResidual
   .. automethod:: computeVariableBounds
   .. automethod:: create
   .. automethod:: createPython
   .. automethod:: destroy
   .. automethod:: getAppCtx
   .. automethod:: getBNCGType
   .. automethod:: getBRGNDampingVector
   .. automethod:: getBRGNSubsolver
   .. automethod:: getConstraintTolerances
   .. automethod:: getConvergedReason
   .. automethod:: getConvergenceTest
   .. automethod:: getGradient
   .. automethod:: getGradientNorm
   .. automethod:: getHessian
   .. automethod:: getIterationNumber
   .. automethod:: getKSP
   .. automethod:: getLMVMH0
   .. automethod:: getLMVMH0KSP
   .. automethod:: getLineSearch
   .. automethod:: getMaximumFunctionEvaluations
   .. automethod:: getMaximumIterations
   .. automethod:: getMonitor
   .. automethod:: getObjectiveAndGradient
   .. automethod:: getObjectiveValue
   .. automethod:: getOptionsPrefix
   .. automethod:: getPythonContext
   .. automethod:: getPythonType
   .. automethod:: getSolution
   .. automethod:: getSolutionNorm
   .. automethod:: getSolutionStatus
   .. automethod:: getTolerances
   .. automethod:: getType
   .. automethod:: getUpdate
   .. automethod:: getVariableBounds
   .. automethod:: monitor
   .. automethod:: setAppCtx
   .. automethod:: setBNCGType
   .. automethod:: setBRGNDictionaryMatrix
   .. automethod:: setBRGNRegularizerHessian
   .. automethod:: setBRGNRegularizerObjectiveGradient
   .. automethod:: setBRGNRegularizerWeight
   .. automethod:: setBRGNSmoothL1Epsilon
   .. automethod:: setConstraintTolerances
   .. automethod:: setConstraints
   .. automethod:: setConvergedReason
   .. automethod:: setConvergenceTest
   .. automethod:: setEqualityConstraints
   .. automethod:: setFromOptions
   .. automethod:: setGradient
   .. automethod:: setGradientNorm
   .. automethod:: setHessian
   .. automethod:: setInitialTrustRegionRadius
   .. automethod:: setIterationNumber
   .. automethod:: setJacobian
   .. automethod:: setJacobianDesign
   .. automethod:: setJacobianEquality
   .. automethod:: setJacobianResidual
   .. automethod:: setJacobianState
   .. automethod:: setLMVMH0
   .. automethod:: setMaximumFunctionEvaluations
   .. automethod:: setMaximumIterations
   .. automethod:: setMonitor
   .. automethod:: setObjective
   .. automethod:: setObjectiveGradient
   .. automethod:: setOptionsPrefix
   .. automethod:: setPythonContext
   .. automethod:: setPythonType
   .. automethod:: setResidual
   .. automethod:: setSolution
   .. automethod:: setStateDesignIS
   .. automethod:: setTolerances
   .. automethod:: setType
   .. automethod:: setUp
   .. automethod:: setUpdate
   .. automethod:: setVariableBounds
   .. automethod:: solve
   .. automethod:: view

   
   .. rubric:: Attributes Documentation
   
   .. autoattribute:: appctx
   .. autoattribute:: cnorm
   .. autoattribute:: converged
   .. autoattribute:: ctol
   .. autoattribute:: diverged
   .. autoattribute:: ftol
   .. autoattribute:: function
   .. autoattribute:: gnorm
   .. autoattribute:: gradient
   .. autoattribute:: gtol
   .. autoattribute:: iterating
   .. autoattribute:: its
   .. autoattribute:: ksp
   .. autoattribute:: objective
   .. autoattribute:: reason
   .. autoattribute:: solution