Package schrodinger :: Package application :: Package matsci :: Module cgforcefield :: Class CGFFIOStructure
[hide private]
[frames] | no frames]

Class CGFFIOStructure

object --+
         |
        CGFFIOStructure

Manage building a coarse grain structure.

Instance Methods [hide private]
 
__init__(self, st)
Create an instance.
 
createFFIOBlock(self)
Create a ffio block in the structure.
 
setName(self, name='general')
Set the name.
 
setCombiningRule(self, combining_rule='geometric')
Set the combining rule.
 
setDescription(self, description=None)
Set the description.
 
writeCMS(self, st, file_name)
Write *cms file.

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, st)
(Constructor)

 

Create an instance.

Parameters:
  • st (structure.Structure) - the structure for which the coarse grain structure is needed
Overrides: object.__init__

setName(self, name='general')

 

Set the name.

Parameters:
  • name (str) - the name

setCombiningRule(self, combining_rule='geometric')

 

Set the combining rule.

Parameters:
  • combining_rule (str) - the combining rule

setDescription(self, description=None)

 

Set the description.

Parameters:
  • description (str or None) - the description or None if there isn't one

writeCMS(self, st, file_name)

 

Write *cms file.

Parameters:
  • st (structure.Structure) - the full system structure
  • file_name (str) - the file name