PSCF v1.1
Public Member Functions | Protected Member Functions | List of all members
Pscf::Fd1d::AmIterator Class Reference

Anderson-Mixing iterator. More...

#include <AmIterator.h>

Inheritance diagram for Pscf::Fd1d::AmIterator:
Pscf::AmIteratorTmpl< Iterator, DArray< double > >

Public Member Functions

 AmIterator (System &system)
 Constructor. More...
 
 ~AmIterator ()
 Destructor. More...
 
void readParameters (std::istream &in)
 Read all parameters and initialize. More...
 
- Public Member Functions inherited from Pscf::AmIteratorTmpl< Iterator, DArray< double > >
 AmIteratorTmpl ()
 Constructor. More...
 
 ~AmIteratorTmpl ()
 Destructor. More...
 
void readParameters (std::istream &in)
 Read all parameters and initialize. More...
 
int solve (bool isContinuation=false)
 Iterate to a solution. More...
 

Protected Member Functions

void setup (bool isContinuation)
 Setup iterator just before entering iteration loop. More...
 
- Protected Member Functions inherited from Pscf::AmIteratorTmpl< Iterator, DArray< double > >
void setMaxItr (int maxItr)
 Set value of maxItr. More...
 
void setMaxHist (int maxHist)
 Set value of maxHist (number of retained previous states) More...
 
void setErrorType (std::string errorType)
 Set and validate value of errorType string. More...
 
void readErrorType (std::istream &in)
 Read and validate the optional errorType string parameter. More...
 
virtual bool isValidErrorType ()
 Checks if a string is a valid error type. More...
 
virtual double norm (DArray< double > const &hist)
 Find the L2 norm of a vector. More...
 
void allocateAM ()
 Allocate memory required by AM algorithm, if necessary. More...
 
virtual void clear ()
 Clear information about history. More...
 
virtual void setup (bool isContinuation)
 Initialize just before entry to iterative loop. More...
 
virtual double computeError (int verbose)
 Compute and return error used to test for convergence. More...
 
DArray< double > const & residual () const
 Return the current residual vector by const reference. More...
 
DArray< double > const & field () const
 Return the current field or state vector by const reference. More...
 
int verbose () const
 Verbosity level, allowed values 0, 1, or 2. More...
 
bool isAllocatedAM () const
 Have data structures required by the AM algorithm been allocated? More...
 
ScalarParam< Type > & read (std::istream &in, const char *label, Type &value)
 Add and read a new required ScalarParam < Type > object. More...
 
ScalarParam< Type > & readOptional (std::istream &in, const char *label, Type &value)
 Add and read a new optional ScalarParam < Type > object. More...
 

Additional Inherited Members

- Protected Attributes inherited from Pscf::AmIteratorTmpl< Iterator, DArray< double > >
std::string errorType_
 Type of error criterion used to test convergence. More...
 

Detailed Description

Anderson-Mixing iterator.

Definition at line 29 of file fd1d/iterator/AmIterator.h.

Constructor & Destructor Documentation

◆ AmIterator()

Pscf::Fd1d::AmIterator::AmIterator ( System system)

Constructor.

Parameters
systemSystem object associated with this iterator.

Definition at line 20 of file fd1d/iterator/AmIterator.cpp.

◆ ~AmIterator()

Pscf::Fd1d::AmIterator::~AmIterator ( )

Destructor.

Definition at line 26 of file fd1d/iterator/AmIterator.cpp.

Member Function Documentation

◆ readParameters()

void Pscf::Fd1d::AmIterator::readParameters ( std::istream &  in)

Read all parameters and initialize.

Parameters
ininput filestream

Definition at line 30 of file fd1d/iterator/AmIterator.cpp.

References Pscf::AmIteratorTmpl< Iterator, DArray< double > >::readErrorType(), readParameters(), and Pscf::AmbdInteraction::setNMonomer().

Referenced by readParameters().

◆ setup()

void Pscf::Fd1d::AmIterator::setup ( bool  isContinuation)
protectedvirtual

Setup iterator just before entering iteration loop.

Parameters
isContinuationIs this a continuation within a sweep?

Reimplemented from Pscf::AmIteratorTmpl< Iterator, DArray< double > >.

Definition at line 41 of file fd1d/iterator/AmIterator.cpp.

References setup(), and Pscf::AmbdInteraction::update().

Referenced by setup().


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