sc::WriteElectrostaticPotential Class Reference

The WriteElectrostaticPotential class writes the electrostatic potential at user defined grid points to the standard output or to a separate file. More...

#include <esp.h>

Inheritance diagram for sc::WriteElectrostaticPotential:

Inheritance graph
[legend]
Collaboration diagram for sc::WriteElectrostaticPotential:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 WriteElectrostaticPotential (const Ref< KeyVal > &)
 The KeyVal constructor.

Protected Member Functions

void initialize ()
 Prepares some pre-caculated values before the repetitive grid calculations are perfomed.
void label (char *buffer)
 A label that identifies the scalar function evaluated at the grid points, is written to the buffer argument.
Ref< Moleculeget_molecule ()
 Returns the molecule around which the grid values are calculated.
double calculate_value (SCVector3 point)
 Returns the value of the scalar function at the given coordinate.

Protected Attributes

Ref< Wavefunctionwfn_
Ref< SymmSCMatrixao_density_
Ref< SymmSCMatrixpc_mat_
bool electronic_
bool nuclear_

Detailed Description

The WriteElectrostaticPotential class writes the electrostatic potential at user defined grid points to the standard output or to a separate file.


Constructor & Destructor Documentation

sc::WriteElectrostaticPotential::WriteElectrostaticPotential ( const Ref< KeyVal > &   ) 

The KeyVal constructor.

wfn
The Wavefunction of which the electrostatic potential is calculated. There is no default for this option.

nuclear
Wether the nuclear terms should be included in the electrostatic potential. The default is yes.

electronic
Wether the electronic terms should be included in the electrostatic potential. The default is yes.


Member Function Documentation

void sc::WriteElectrostaticPotential::initialize (  )  [protected, virtual]

Prepares some pre-caculated values before the repetitive grid calculations are perfomed.

Implements sc::WriteGrid.

void sc::WriteElectrostaticPotential::label ( char *  buffer  )  [protected, virtual]

A label that identifies the scalar function evaluated at the grid points, is written to the buffer argument.

The classname, concatenated with some important properties should be sufficient. No whitespace allowed, length of the string is limited to 256 characters.

Implements sc::WriteGrid.


The documentation for this class was generated from the following file:
Generated at Wed Sep 5 14:03:22 2007 for MPQC 3.0.0-alpha using the documentation package Doxygen 1.5.2.
These pages are hosted on SourceForge.net