Reference documentation for deal.II version Git 9c5841c5ee 2019-11-11 14:05:52 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Public Attributes | Private Attributes | List of all members
Algorithms::Newton< VectorType > Class Template Reference

#include <deal.II/algorithms/newton.h>

Inheritance diagram for Algorithms::Newton< VectorType >:
[legend]

Public Member Functions

 Newton (OperatorBase &residual, OperatorBase &inverse_derivative)
 
void parse_parameters (ParameterHandler &param)
 
void initialize (OutputOperator< VectorType > &output)
 
virtual void operator() (AnyData &out, const AnyData &in) override
 
virtual void notify (const Event &) override
 
double threshold (double new_value)
 
- Public Member Functions inherited from Algorithms::OperatorBase
virtual ~OperatorBase () override=default
 
void clear_events ()
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &param)
 
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Public Attributes

ReductionControl control
 
bool debug_vectors
 
unsigned int debug
 

Private Attributes

SmartPointer< OperatorBase, Newton< VectorType > > residual
 
SmartPointer< OperatorBase, Newton< VectorType > > inverse_derivative
 
SmartPointer< OutputOperator< VectorType >, Newton< VectorType > > data_out
 
bool assemble_now
 
unsigned int n_stepsize_iterations
 
double assemble_threshold
 

Additional Inherited Members

- Protected Attributes inherited from Algorithms::OperatorBase
Event notifications
 

Detailed Description

template<typename VectorType>
class Algorithms::Newton< VectorType >

Operator class performing Newton's iteration with standard step size control and adaptive matrix generation.

This class performs a Newton iteration up to convergence determined by control. If after an update the norm of the residual has become larger, then step size control is activated and the update is subsequently divided by two until the residual actually becomes smaller (or the minimal scaling factor determined by n_stepsize_iterations is reached).

Since assembling matrices, depending on the implementation, tends to be costly, this method applies an adaptive reassembling strategy. Only if the reduction factor for the residual is more than threshold, the event Algorithms::bad_derivative is submitted to inverse_derivative. It is up to this object to implement reassembling accordingly.

Contents of the AnyData objects

The only value used by the Newton method is the first vector in the parameter out of operator()(). It serves as the start vector of Newton's method and in the end contains the solution. All other vectors of out are ignored by Newton's method and its inner Operator objects. All vectors of in are forwarded to the inner Operator objects, with additional information added as follows.

When calling (*residual)(), the AnyData in given to the Newton iteration is prepended by a vector "Newton iterate", the current value of the Newton iterate, which can be used to evaluate the residual at this point.

For the call to (*inverse_derivative), the vector "Newton residual" is inserted before "Newton iterate".

Author
Guido Kanschat, 2006, 2010

Definition at line 72 of file newton.h.

Constructor & Destructor Documentation

◆ Newton()

template<typename VectorType >
Algorithms::Newton< VectorType >::Newton ( OperatorBase residual,
OperatorBase inverse_derivative 
)

Constructor, receiving the applications computing the residual and solving the linear problem, respectively.

Member Function Documentation

◆ declare_parameters()

template<typename VectorType >
static void Algorithms::Newton< VectorType >::declare_parameters ( ParameterHandler param)
static

Declare the parameters applicable to Newton's method.

◆ parse_parameters()

template<typename VectorType >
void Algorithms::Newton< VectorType >::parse_parameters ( ParameterHandler param)

Read the parameters in the ParameterHandler.

◆ initialize()

template<typename VectorType >
void Algorithms::Newton< VectorType >::initialize ( OutputOperator< VectorType > &  output)

Initialize the pointer data_out for debugging.

◆ operator()()

template<typename VectorType >
virtual void Algorithms::Newton< VectorType >::operator() ( AnyData out,
const AnyData in 
)
overridevirtual

The actual Newton iteration. The initial value is in out(0), which also contains the result after convergence. Values in in are not used by Newton, but will be handed down to the objects residual and inverse_derivative.

Implements Algorithms::OperatorBase.

◆ notify()

template<typename VectorType >
virtual void Algorithms::Newton< VectorType >::notify ( const Event e)
overridevirtual

Register an event triggered by an outer iteration.

Reimplemented from Algorithms::OperatorBase.

◆ threshold()

template<typename VectorType >
double Algorithms::Newton< VectorType >::threshold ( double  new_value)

Set the maximal residual reduction allowed without triggering assembling in the next step. Return the previous value.

Member Data Documentation

◆ control

template<typename VectorType >
ReductionControl Algorithms::Newton< VectorType >::control

Control object for the Newton iteration.

Definition at line 121 of file newton.h.

◆ residual

template<typename VectorType >
SmartPointer<OperatorBase, Newton<VectorType> > Algorithms::Newton< VectorType >::residual
private

The operator computing the residual.

Definition at line 127 of file newton.h.

◆ inverse_derivative

template<typename VectorType >
SmartPointer<OperatorBase, Newton<VectorType> > Algorithms::Newton< VectorType >::inverse_derivative
private

The operator applying the inverse derivative to the residual.

Definition at line 132 of file newton.h.

◆ data_out

template<typename VectorType >
SmartPointer<OutputOperator<VectorType>, Newton<VectorType> > Algorithms::Newton< VectorType >::data_out
private

The operator handling the output in case the debug_vectors is true. Call the initialize function first.

Definition at line 138 of file newton.h.

◆ assemble_now

template<typename VectorType >
bool Algorithms::Newton< VectorType >::assemble_now
private

This flag is set by the function assemble(), indicating that the matrix must be assembled anew upon start.

Definition at line 144 of file newton.h.

◆ n_stepsize_iterations

template<typename VectorType >
unsigned int Algorithms::Newton< VectorType >::n_stepsize_iterations
private

A flag used to decide how many stepsize iteration should be made. Default is the original value of 21.

Enter zero here to turn off stepsize control.

Note
Controlled by Stepsize iterations in parameter file

Definition at line 154 of file newton.h.

◆ assemble_threshold

template<typename VectorType >
double Algorithms::Newton< VectorType >::assemble_threshold
private

Threshold for re-assembling matrix.

If the quotient of two consecutive residuals is smaller than this threshold, the system matrix is not assembled in this step.

Note
This parameter should be adjusted to the residual gain of the inner solver.

The default values is zero, resulting in reassembling in every Newton step.

Definition at line 168 of file newton.h.

◆ debug_vectors

template<typename VectorType >
bool Algorithms::Newton< VectorType >::debug_vectors

Print residual, update and updated solution after each step into file Newton_NNN?

Definition at line 175 of file newton.h.

◆ debug

template<typename VectorType >
unsigned int Algorithms::Newton< VectorType >::debug

Write debug output to deallog; the higher the number, the more output.

Definition at line 180 of file newton.h.


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