Page 37 out of 81 total pages , Page 10 out of 15 pages in this chapter

3.16 I/O Functions

3.16.1 read

Usage:


void IntQuad::read(const String& filename, const spin_sys) const
void IntQuad::read(const String& filename, const spin_sys) const
void IntQuad::read(const String& filename, const spin_sys) const
void IntQuad::read(const String& filename, const spin_sys) const

Description:

The function delzz is used to either obtain or set the interaction quadrupolar coupling constant. With no arguments the function returns the coupling in Hz. If an argument, dz, is specified then the coupling constant for the interaction is set. It is assumed that the input value of dz is in units of Hz. The function is overloaded with the name delz for convenience. Note that setting of delzz will alter the (equivalent) value of the quadrupolar coupling QCC/NQCC as well as the quadrupolar frequency.

Return Value:

Either void or a floating point number, double precision.

Example(s):


#include <IntQuad.h>
IntQuad Q(); // Empty quadrupolar interaction.
Q.delzz(100000.0); // Set QCC to 100 KHz.
cout << Q.delz (); // Write coupling constant to std output.

See Also: QCC, NQCC, wQ

3.16.2 ask

Usage:


#include <IntQuad.h>
double IntQuad:: () const
double IntQuad::delz () const
double IntQuad::delzz (double dz) const
double IntQuad::delz (double dz) const

Description:

The function delzz is used to either obtain or set the interaction quadrupolar coupling constant. With no arguments the function returns the coupling in Hz. If an argument, dz, is specified then the coupling constant for the interaction is set. It is assumed that the input value of dz is in units of Hz. The function is overloaded with the name delz for convenience. Note that setting of delzz will alter the (equivalent) value of the quadrupolar coupling QCC/NQCC as well as the quadrupolar frequency.

Return Value:

Either void or a floating point number, double precision.

Example(s):


#include <IntQuad.h>
IntQuad Q(); // Empty quadrupolar interaction.
Q.delzz(100000.0); // Set QCC to 100 KHz.
cout << Q.delz (); // Write coupling constant to std output.

See Also: QCC, NQCC, wQ

3.16.3 askset

Usage:


#include <IntQuad.h>
double IntQuad:: () const
double IntQuad::delz () const
double IntQuad::delzz (double dz) const
double IntQuad::delz (double dz) const

Description:

The function delzz is used to either obtain or set the interaction quadrupolar coupling constant. With no arguments the function returns the coupling in Hz. If an argument, dz, is specified then the coupling constant for the interaction is set. It is assumed that the input value of dz is in units of Hz. The function is overloaded with the name delz for convenience. Note that setting of delzz will alter the (equivalent) value of the quadrupolar coupling QCC/NQCC as well as the quadrupolar frequency.

Return Value:

Either void or a floating point number, double precision.

Example(s):


#include <IntQuad.h>
IntQuad Q(); // Empty quadrupolar interaction.
Q.delzz(100000.0); // Set QCC to 100 KHz.
cout << Q.delz (); // Write coupling constant to std output.

See Also: QCC, NQCC, wQ

3.16.4 print

Usage:


#include <IntQuad.h>
ostream& IntQuad::print (ostream& ostr, int fflag=-1)

Description:

The function print is used to write the interaction quadrupolar coupling constant to an output stream ostr. An additional flag fflag is set to allow some control over how much information is output. The default (fflag !=0) prints all information concerning the interaction. If fflag is set to zero only the basis parameters are printed.

Return Value:

The ostream is returned.

Example:


#include <IntQuad.h>
IntQuad Q(2.5, 2.e6, 0.2, 45.7, 15.0); // Make a quadrupolar interaction.
cout << Q; // Write the interaction to standard output.

See Also: <<

3.16.5 <<

Usage:


#include <IntQuad.h>
friend ostream& operator << (ostream& out, IntQuad& Q)

Description:

The operator << defines standard output for the interaction quadrupolar coupling constant.

Return Value:

The ostream is returned.

Example:


#include <IntQuad.h>
IntQuad Q(1.5, 3.e5, 0.2); // Make a quadrupolar interaction.
cout << Q; // Write the interaction to standard output.

See Also: print

3.16.6 printSpherical

Usage:


#include <IntQuad.h>
ostream& IntQuad::print (ostream& ostr, int fflag=-1)

Description:

The function print is used to write the interaction quadrupolar coupling constant to an output stream ostr. An additional flag fflag is set to allow some control over how much information is output. The default (fflag !=0) prints all information concerning the interaction. If fflag is set to zero only the basis parameters are printed.

Return Value:

The ostream is returned.

Example:


#include <IntQuad.h>
IntQuad Q(2.5, 2.e6, 0.2, 45.7, 15.0); // Make a quadrupolar interaction.
cout << Q; // Write the interaction to standard output.

See Also: <<

3.16.7 printCartesian

Usage:


#include <IntQuad.h>
ostream& IntQuad::print (ostream& ostr, int fflag=-1)

Description:

The function print is used to write the interaction quadrupolar coupling constant to an output stream ostr. An additional flag fflag is set to allow some control over how much information is output. The default (fflag !=0) prints all information concerning the interaction. If fflag is set to zero only the basis parameters are printed.

Return Value:

The ostream is returned.

Example:


#include <IntQuad.h>
IntQuad Q(2.5, 2.e6, 0.2, 45.7, 15.0); // Make a quadrupolar interaction.
cout << Q; // Write the interaction to standard output.

See Also: <<



Page 37 out of 81 total pages , Page 10 out of 15 pages in this chapter

GAMMA Support Provided by the National High Magnetic Field Laboratory
© 1996 Scott A. Smith, The NHMFL, and The Florida State University.
All Rights Reserved.
No GAMMA WWW pages or GAMMA specific images therein may be reproduced or used in any manner outside of personal Web Browsers without permission from the copyright holders.
Send problems & suggestions to gamma@magnet.fsu.edu
Additonal GAMMA information can be found at http://gamma.magnet.fsu.edu