Package schrodinger :: Package application :: Package qsite :: Module input :: Class QSiteInput
[hide private]
[frames] | no frames]

Class QSiteInput

object --+
         |
        QSiteInput

Instance Methods [hide private]
 
__init__(self, name)
Create a QSite input object, either from a jobname or QSite input file path.
 
__del__(self)
Delete the mmjag handle and clean up the mmlibs.
 
setStructureFile(self, filename)
Set the mae structure file to be used.
 
getStructureFile(self)
Return the mae structure that is used.
 
addQMMolecule(self, index, theory='qm')
Add a QM molecule to the QM region specification.
 
addQMCut(self, **kwargs)
Add a QM cut to the QM region specification.
 
addHydrogenCap(self, qm=None, mm=None, distance=0.0, theory='qm')
Add a hydrogen cap to the QM region specification.
 
_setJobName(self, name)
Set the jobname and filename properties from an input filename or jobname.
 
_getJobName(self)
Return the name of the job.
 
write(self)
Write the input file to <jobname>.in.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]
  gen
Provide dictionary-like access to &gen section
  mmkey
Provide dictionary-like access to the &mmkey section.
  mopac
Provide dictionary-like access to &mopac section
  qmregion
Provide access to the &qmregion section.
  jobname
get/set the jobname; setting the jobname also sets the filename

Inherited from object: __class__

Method Details [hide private]

__init__(self, name)
(Constructor)

 

Create a QSite input object, either from a jobname or QSite input
file path.

Parameters

name (str)
    One of:
      jobname -   Default parameters are used.
    or
      file path - Parameters are read from specified file.
                  File must be in current working directory.

Overrides: object.__init__

setStructureFile(self, filename)

 

Set the mae structure file to be used. If the structure file name doesn't match the current job/file name it will be copied to the current directory and renamed to <jobname>.<ext>.

addQMMolecule(self, index, theory='qm')

 

Add a QM molecule to the QM region specification.

This creates a Cut instance and adds it to the qmregion attribute.

addQMCut(self, **kwargs)

 

Add a QM cut to the QM region specification.

The keywords here are the same as the Cut class constructor. Calling this method is equivalent to creating a Cut instance and adding it to the QSiteInput instance by calling qmregion.append().

addHydrogenCap(self, qm=None, mm=None, distance=0.0, theory='qm')

 

Add a hydrogen cap to the QM region specification.

The keywords here are the same as the HydrogenCap class constructor. Calling this method is equivalent to creating a HydrogenCap instance and adding it to the QSiteInput instance by calling qmregion.append().

_setJobName(self, name)

 

Set the jobname and filename properties from an input filename or jobname.

This method keeps the filename and jobname in sync.

write(self)

 

Write the input file to <jobname>.in. The structure file will also be written to <jobname>.<ext>, where <ext> is the extension of the specified structure file.

Structure file must be specified via setStructureFile() first.

Previous file with this name is overwritten.


Property Details [hide private]

gen

Provide dictionary-like access to &gen section

Get Method:
unreachable.gen(self) - Provide dictionary-like access to &gen section

mmkey

Provide dictionary-like access to the &mmkey section.

Get Method:
unreachable.mmkey(self) - Provide dictionary-like access to the &mmkey section.

mopac

Provide dictionary-like access to &mopac section

Get Method:
unreachable.mopac(self) - Provide dictionary-like access to &mopac section

qmregion

Provide access to the &qmregion section.

Get Method:
unreachable.qmregion(self) - Provide access to the &qmregion section.

jobname

get/set the jobname; setting the jobname also sets the filename

Get Method:
_getJobName(self) - Return the name of the job.
Set Method:
_setJobName(self, name) - Set the jobname and filename properties from an input filename or jobname.