Provided by: libsc-doc_2.3.1-22build2_all
NAME
sc::ReadMolecularHessian - ReadMolecularHessian is an implementation of MolecularHessian that reads the hessian from a file.
SYNOPSIS
#include <hess.h> Inherits sc::MolecularHessian. Public Member Functions ReadMolecularHessian (const Ref< KeyVal > &) The ReadMolecularHessian KeyVal constructor is used to generate a ReadMolecularHessian object from the input. ReadMolecularHessian (StateIn &) 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. RefSymmSCMatrix cartesian_hessian () Return the hessian in cartesian coordinates. Public Member Functions inherited from sc::MolecularHessian MolecularHessian (const Ref< KeyVal > &) The MolecularHessian KeyVal constructor is used to generate a MolecularHessian derivative object from the input. MolecularHessian (StateIn &) RefSCDimension d3natom () Ref< SCMatrixKit > matrixkit () const virtual void set_energy (const Ref< MolecularEnergy > &energy) Some MolecularHessian specializations require a molecular energy object. virtual MolecularEnergy * energy () const This returns a MolecularEnergy object, if used by this specialization. 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. 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 Attributes char * filename_ Protected Attributes inherited from sc::MolecularHessian Ref< Molecule > mol_ RefSCDimension d3natom_ Ref< SCMatrixKit > matrixkit_ Additional Inherited Members Static Public Member Functions inherited from sc::MolecularHessian static RefSCMatrix cartesian_to_symmetry (const Ref< Molecule > &m, Ref< PointGroup > pg=0, Ref< SCMatrixKit > kit=0) Find transformation matrix from cartesian to symmetry coordinates. static void write_cartesian_hessian (const char *filename, const Ref< Molecule > &m, const RefSymmSCMatrix &hess) Write the hessian in a simple text format. static void read_cartesian_hessian (const char *filename, const Ref< Molecule > &m, const RefSymmSCMatrix &hess) Read the hessian from a simple text format. 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 *objectname, const char *keyword=0) 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 &)
Detailed Description
ReadMolecularHessian is an implementation of MolecularHessian that reads the hessian from a file.
Constructor & Destructor Documentation
sc::ReadMolecularHessian::ReadMolecularHessian (const Ref< KeyVal > &) The ReadMolecularHessian KeyVal constructor is used to generate a ReadMolecularHessian object from the input. It reads the keywords below. KeywordTypeDefaultDescription filenamestringbasename .hessThe name of the file from which the hessian is read.
Member Function Documentation
RefSymmSCMatrix sc::ReadMolecularHessian::cartesian_hessian () [virtual] Return the hessian in cartesian coordinates. Implements sc::MolecularHessian. void sc::ReadMolecularHessian::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::MolecularHessian.
Author
Generated automatically by Doxygen for MPQC from the source code.