dune-pdelab  2.5-dev
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::PDELab::NewtonBase< GOS, TrlV, TstV > Class Template Referenceabstract

#include <dune/pdelab/newton/newton.hh>

Inheritance diagram for Dune::PDELab::NewtonBase< GOS, TrlV, TstV >:
Inheritance graph

Public Types

typedef NewtonResult< RFType > Result
 

Public Member Functions

void setVerbosityLevel (unsigned int verbosity_level)
 
void setKeepMatrix (bool b)
 Set whether the jacobian matrix should be kept across calls to apply(). More...
 
bool keepMatrix () const
 Return whether the jacobian matrix is kept across calls to apply(). More...
 
void discardMatrix ()
 Discard the stored Jacobian matrix. More...
 

Protected Member Functions

 NewtonBase (const GridOperator &go, TrialVector &u)
 
 NewtonBase (const GridOperator &go)
 
virtual ~NewtonBase ()
 
virtual bool terminate ()=0
 
virtual void prepare_step (Matrix &A, TestVector &r)=0
 
virtual void line_search (TrialVector &z, TestVector &r)=0
 
virtual void defect (TestVector &r)=0
 

Protected Attributes

const GridOperator & gridoperator_
 
TrialVector * u_
 
std::shared_ptr< TrialVector > z_
 
std::shared_ptr< TestVector > r_
 
std::shared_ptr< Matrix > A_
 
Result res_
 
unsigned int verbosity_level_
 
RFType prev_defect_
 
RFType linear_reduction_
 
bool reassembled_
 
RFType reduction_
 
RFType abs_limit_
 
bool keep_matrix_
 

Member Typedef Documentation

§ Result

template<class GOS , class TrlV , class TstV >
typedef NewtonResult<RFType> Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::Result

Constructor & Destructor Documentation

§ NewtonBase() [1/2]

template<class GOS , class TrlV , class TstV >
Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::NewtonBase ( const GridOperator &  go,
TrialVector &  u 
)
inlineprotected

§ NewtonBase() [2/2]

template<class GOS , class TrlV , class TstV >
Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::NewtonBase ( const GridOperator &  go)
inlineprotected

§ ~NewtonBase()

template<class GOS , class TrlV , class TstV >
virtual Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::~NewtonBase ( )
inlineprotectedvirtual

Member Function Documentation

§ defect()

template<class GOS , class TrlV , class TstV >
virtual void Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::defect ( TestVector &  r)
protectedpure virtual

§ discardMatrix()

template<class GOS , class TrlV , class TstV >
void Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::discardMatrix ( )
inline

Discard the stored Jacobian matrix.

§ keepMatrix()

template<class GOS , class TrlV , class TstV >
bool Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::keepMatrix ( ) const
inline

Return whether the jacobian matrix is kept across calls to apply().

§ line_search()

template<class GOS , class TrlV , class TstV >
virtual void Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::line_search ( TrialVector &  z,
TestVector &  r 
)
protectedpure virtual

§ prepare_step()

template<class GOS , class TrlV , class TstV >
virtual void Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::prepare_step ( Matrix &  A,
TestVector &  r 
)
protectedpure virtual

§ setKeepMatrix()

template<class GOS , class TrlV , class TstV >
void Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::setKeepMatrix ( bool  b)
inline

Set whether the jacobian matrix should be kept across calls to apply().

§ setVerbosityLevel()

template<class GOS , class TrlV , class TstV >
void Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::setVerbosityLevel ( unsigned int  verbosity_level)
inline

§ terminate()

template<class GOS , class TrlV , class TstV >
virtual bool Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::terminate ( )
protectedpure virtual

Member Data Documentation

§ A_

template<class GOS , class TrlV , class TstV >
std::shared_ptr<Matrix> Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::A_
protected

§ abs_limit_

template<class GOS , class TrlV , class TstV >
RFType Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::abs_limit_
protected

§ gridoperator_

template<class GOS , class TrlV , class TstV >
const GridOperator& Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::gridoperator_
protected

§ keep_matrix_

template<class GOS , class TrlV , class TstV >
bool Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::keep_matrix_
protected

§ linear_reduction_

template<class GOS , class TrlV , class TstV >
RFType Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::linear_reduction_
protected

§ prev_defect_

template<class GOS , class TrlV , class TstV >
RFType Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::prev_defect_
protected

§ r_

template<class GOS , class TrlV , class TstV >
std::shared_ptr<TestVector> Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::r_
protected

§ reassembled_

template<class GOS , class TrlV , class TstV >
bool Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::reassembled_
protected

§ reduction_

template<class GOS , class TrlV , class TstV >
RFType Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::reduction_
protected

§ res_

template<class GOS , class TrlV , class TstV >
Result Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::res_
protected

§ u_

template<class GOS , class TrlV , class TstV >
TrialVector* Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::u_
protected

§ verbosity_level_

template<class GOS , class TrlV , class TstV >
unsigned int Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::verbosity_level_
protected

§ z_

template<class GOS , class TrlV , class TstV >
std::shared_ptr<TrialVector> Dune::PDELab::NewtonBase< GOS, TrlV, TstV >::z_
protected

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