NewtonSolver Class Reference

#include <newton_solver.h>

Public Member Functions
	NewtonSolver (NewtonArgument &solver)
	Constructor for the NewtonSolver class. More...
	~NewtonSolver ()
	House cleaning. More...
void	parse_parameters (ParameterHandler &prm)
	Parse a parameter handler. More...
unsigned int	solve (Vector< double > &solution, const unsigned int max_steps)
	Solve. More...

Static Public Member Functions
static void	declare_parameters (ParameterHandler &prm)
	Declare parameters for this class to function properly. More...

Private Attributes
NewtonArgument &	solver
	The bubble membrane poperties. More...
Vector< double >	y
Epetra_SerialComm	comm
Epetra_Map	map
PreconditionerOperator *	preconditioner_operator
JacobianOperator *	jacobian_operator
std::string	linear_solver_name
bool	provide_jac
bool	provide_jac_prec
double	rel_tol
double	linear_rel_tol
SolverControl	solver_control

Detailed Description

Definition at line 404 of file newton_solver.h.

Constructor & Destructor Documentation

NewtonSolver::NewtonSolver

(

NewtonArgument &

solver

)

Constructor for the NewtonSolver class.

The Solver class is required to have a Solver.solve(Vector<double> &dst, const Vector<double> &src) method that will be called by the time integrator to find out about the solution to a given src.

Definition at line 15 of file newton_solver.cc.

NewtonSolver::~NewtonSolver

(

)

House cleaning.

Definition at line 35 of file newton_solver.cc.

Member Function Documentation

void NewtonSolver::declare_parameters ( ParameterHandler &  prm )

static

Declare parameters for this class to function properly.

Definition at line 40 of file newton_solver.cc.

void NewtonSolver::parse_parameters

(

ParameterHandler &

prm

)

Parse a parameter handler.

Definition at line 57 of file newton_solver.cc.

unsigned int NewtonSolver::solve	(	Vector< double > &	solution,
		const unsigned int	max_steps
	)

Solve.

This function returns the final number of steps.

Definition at line 73 of file newton_solver.cc.

Member Data Documentation

Epetra_SerialComm NewtonSolver::comm

private

Definition at line 437 of file newton_solver.h.

JacobianOperator* NewtonSolver::jacobian_operator

private

Definition at line 441 of file newton_solver.h.

double NewtonSolver::linear_rel_tol

private

Definition at line 446 of file newton_solver.h.

std::string NewtonSolver::linear_solver_name

private

Definition at line 442 of file newton_solver.h.

Epetra_Map NewtonSolver::map

private

Definition at line 439 of file newton_solver.h.

PreconditionerOperator* NewtonSolver::preconditioner_operator

private

Definition at line 440 of file newton_solver.h.

bool NewtonSolver::provide_jac

private

Definition at line 443 of file newton_solver.h.

bool NewtonSolver::provide_jac_prec

private

Definition at line 444 of file newton_solver.h.

double NewtonSolver::rel_tol

private

Definition at line 445 of file newton_solver.h.

NewtonArgument& NewtonSolver::solver

private

The bubble membrane poperties.

Definition at line 432 of file newton_solver.h.

SolverControl NewtonSolver::solver_control

private

Definition at line 447 of file newton_solver.h.

Vector<double> NewtonSolver::y

private

Definition at line 433 of file newton_solver.h.

---

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

• include/newton_solver.h
• source/newton_solver.cc