NonlinearVariationalSolver.h

Note

The documentation on this page was automatically extracted from the DOLFIN C++ code and may need to be edited or expanded.

class NonlinearVariationalSolver

Parent class(es)

This class implements a solver for nonlinear variational problems.

NonlinearVariationalSolver(NonlinearVariationalProblem &problem)

Create nonlinear variational solver for given problem

NonlinearVariationalSolver(boost::shared_ptr<NonlinearVariationalProblem> problem)

Create nonlinear variational solver for given problem (shared pointer version)

std::pair<std::size_t, bool> solve(const GenericVector &lb, const GenericVector &ub)

Solve variational problem with bound constraints defined by GenericVectors

Arguments
lb (GenericVector)
The linear solver.
ub (GenericVector)
The factory.
Returns
std::pair<std::size_t, bool>
Pair of number of Newton iterations, and whether iteration converged)
std::pair<std::size_t, bool> solve(boost::shared_ptr<const GenericVector> lb, boost::shared_ptr<const GenericVector> ub)

Solve variational problem with bound constraints defined by GenericVectors (shared pointer version)

Arguments
lb (_boost::shared_ptr<const GenericVector>_)
The linear solver.
ub (_boost::shared_ptr<const GenericVector>_)
The factory.
Returns
std::pair<std::size_t, bool>
Pair of number of Newton iterations, and whether iteration converged)
std::pair<std::size_t, bool> solve(const Function &lb, const Function &ub)

Solve variational problem with bound constraints defined by Functions

Arguments
lb (Function)
The linear solver.
ub (Function)
The factory.
Returns
std::pair<std::size_t, bool>
Pair of number of Newton iterations, and whether iteration converged)
std::pair<std::size_t, bool> solve(boost::shared_ptr<const Function> lb, boost::shared_ptr<const Function> ub)

Solve variational problem with bound constraints defined by Functions (shared pointer version)

Arguments
lb (_boost::shared_ptr<const Function>_)
The linear solver.
ub (_boost::shared_ptr<const Function>_)
The factory.
Returns
std::pair<std::size_t, bool>
Pair of number of Newton iterations, and whether iteration converged)
std::pair<std::size_t, bool> solve()

Solve variational problem

Returns
std::pair<std::size_t, bool>
Pair of number of Newton iterations, and whether iteration converged)
static Parameters default_parameters()

Default parameter values

class NonlinearDiscreteProblem

Parent class(es)