home | help 
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< SCEx-
	 trapError > &error)=0
     virtual void start_extrapolation ()
     virtual void reinitialize ()=0

     Public Member Functions inherited from sc::SavableState
     SavableState & operator= (const SavableState &)
     void save_state (StateOut &)
	 Save the state of the object as specified by the StateOut object.
     void save_object_state (StateOut &)
	 This can be used for saving state when the exact type of the object  is
	 known for both the save and the restore.
     virtual void save_vbase_state (StateOut &)
	 Save the virtual bases for the object.
     virtual 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.

     Public Member Functions inherited from sc::DescribedClass
     DescribedClass (const DescribedClass &)
     DescribedClass & operator= (const DescribedClass &)
     ClassDesc * class_desc () const  throw ()
	 This returns the unique pointer to the ClassDesc corresponding  to  the
	 given type_info object.
     const char * class_name () const
	 Return the name of the object's exact type.
     int class_version () const
	 Return the version of the class.
     virtual void print (std::ostream &=ExEnv::out0()) const
	 Print the object.

     Public Member Functions inherited from sc::RefCount
     int lock_ptr () const
	 Lock this object.
     int unlock_ptr () const
	 Unlock this object.
     void use_locks (bool inVal)
	 start and stop using locks on this object
     refcount_t nreference () const
	 Return the reference count.
     refcount_t reference ()
	 Increment the reference count and return the new count.
     refcount_t dereference ()
	 Decrement the reference count and return the new count.
     int managed () const
     void unmanage ()
	 Turn off the reference counting mechanism for this object.
     int managed () const
	 Return 1 if the object is managed. Otherwise return 0.

     Public Member Functions inherited from sc::Identity
     Identifier identifier ()
	 Return the Identifier for this argument.

   Protected Member Functions
     void set_error (double e)

     Protected Member Functions inherited from sc::SavableState
     SavableState (const SavableState &)
     SavableState (StateIn &)
	 Each  derived	class  StateIn CTOR handles the restore corresponding to
	 calling save_object_state, save_vbase_state, and save_data_state listed
	 above.

     Protected Member Functions inherited from sc::RefCount
     RefCount (const RefCount &)
     RefCount & operator= (const RefCount &)

   Additional Inherited Members
     Static Public Member Functions inherited from sc::SavableState
     static void save_state (SavableState *s, StateOut &)
     static SavableState * restore_state (StateIn &si)
	 Restores objects saved with save_state.
     static SavableState * key_restore_state (StateIn &si, const char *keyword)
	 Like restore_state, but  keyword  is  used  to  override  values  while
	 restoring.
     static  SavableState  * dir_restore_state (StateIn &si, const char *object-
	 name, const char *keyword=0)

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

     = f(]

Constructor & Destructor Documentation
   sc::SelfConsistentExtrapolation::SelfConsistentExtrapolation (const Ref< Key-
     Val > &)
     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			 Thu Sep 3 202sc::SelfConsistentExtrapolation(3)
home | help