DragonFly On-Line Manual Pages

Search: Section:  

sc::SelfConsistentExtrapolation(3)   MPQC   sc::SelfConsistentExtrapolation(3)


NAME

       sc::SelfConsistentExtrapolation - The SelfConsistentExtrapolation
       abstract class is used to iteratively solve equations requiring a self
       consistent solution, such as,.


SYNOPSIS

       #include <scextrap.h>

       Inherits sc::SavableState.

       Inherited by sc::DIIS.

   Public Member Functions
       SelfConsistentExtrapolation (StateIn &)
       SelfConsistentExtrapolation (const Ref< KeyVal > &)
           The only keyword read is #tolerance#, which is usually not needed
           since the objects using SelfConsistentExtrapolation should set the
           tolerances as needed.
       void save_data_state (StateOut &)
           Save the base classes (with save_data_state) and the members in the
           same order that the StateIn CTOR initializes them.
       void set_tolerance (double t)
       double tolerance ()
       double error ()
       int converged ()
       virtual int extrapolate (const Ref< SCExtrapData > &data, const Ref<
           SCExtrapError > &error)=0
       virtual void start_extrapolation ()
       virtual void reinitialize ()=0

   Protected Member Functions
       void set_error (double e)

   Additional Inherited Members

Detailed Description
       The SelfConsistentExtrapolation abstract class is used to iteratively
       solve equations requiring a self consistent solution, such as,.

Constructor & Destructor Documentation
   sc::SelfConsistentExtrapolation::SelfConsistentExtrapolation (const Ref<
       KeyVal > &)
       The only keyword read is #tolerance#, which is usually not needed since
       the objects using SelfConsistentExtrapolation should set the tolerances
       as needed.

Member Function Documentation
   void sc::SelfConsistentExtrapolation::save_data_state (StateOut &)
       [virtual]
       Save the base classes (with save_data_state) and the members in the
       same order that the StateIn CTOR initializes them. This must be
       implemented by the derived class if the class has data.

       Reimplemented from sc::SavableState.

Author
       Generated automatically by Doxygen for MPQC from the source code.

Version 2.3.1                   Fri Feb 19 2016
                                            sc::SelfConsistentExtrapolation(3)

Search: Section: