SimplePetscNonlinearSolver Class Reference

#include <SimplePetscNonlinearSolver.hpp>

Inheritance diagram for SimplePetscNonlinearSolver:

Collaboration diagram for SimplePetscNonlinearSolver:

List of all members.

Public Member Functions
Vec	Solve (PetscErrorCode(*pComputeResidual)(SNES, Vec, Vec, void *), PetscErrorCode(*pComputeJacobian)(SNES, Vec, Mat *, Mat *, MatStructure *, void *), Vec initialGuess, unsigned fill, void *pContext)

---

Detailed Description

Concrete Simple Nonlinear PDE system solver.

Definition at line 46 of file SimplePetscNonlinearSolver.hpp.

---

Member Function Documentation

Vec SimplePetscNonlinearSolver::Solve	(	PetscErrorCode(*)(SNES, Vec, Vec, void *)	pComputeResidual,
		PetscErrorCode(*)(SNES, Vec, Mat *, Mat *, MatStructure *, void *)	pComputeJacobian,
		Vec	initialGuess,
		unsigned	fill,
		void *	pContext
	)		[virtual]

Simple Nonlinear PDE system solver, uses the PETSc SNES Solver, which uses Newton's method.

Parameters:

pComputeResidual	points to the function which computes the residual, it must take arguments SNES (a PETSc nonlinear solver object), Vec (current guess - a vector of the correct size), Vec (a Vec of the correct size in which the residual is returned), void* (a pointer to anything you may need to refer to when calculating the residual)
pComputeJacobian	points to the function which computes the Jacobian, it must take arguments SNES (a PETSc nonlinear solver * object), Mat* (a pointer to the Jacobian matrix) ,Mat* (a pointer to a preconditioner matrix), MatStructure* (points to the PETSc matrix type e.g. AIJ), void* (a pointer to anything you may need to refer to when calculating the residual).
initialGuess	A PETSc Vec of the correct size, containing initial guesses for the nonlinear solver.
pContext	[optional] A pointer to a class that may have to be used in the ComputeResidual and ComputeJacobian functions
fill	the expected maximum number of nonzeros in a row of the Jacobian matrix

Returns:

Returns a PETSc Vec of the solution.

To be used in the form: Vec answer=solver->Solve(&ComputeResidual, &ComputeJacobian, initialGuess, NULL);

In the same file, but outside this class the functions ComputeResidual and ComputeJacobian must sit, using the input arguments specified above.

Concrete Simple Nonlinear PDE system solver.

Implements AbstractNonlinearSolver.

Definition at line 46 of file SimplePetscNonlinearSolver.cpp.

References PetscTools::Destroy(), EXCEPTION, PETSC_DESTROY_PARAM, and PetscTools::SetupMat().

---

The documentation for this class was generated from the following files:

• linalg/src/SimplePetscNonlinearSolver.hpp
• linalg/src/SimplePetscNonlinearSolver.cpp