Package schrodinger :: Package application :: Package matsci :: Module order_parameter_mod :: Class OrderParameter
[hide private]
[frames] | no frames]

Class OrderParameter

object --+
         |
        OrderParameter

Manage order parameter analysis.

Instance Methods [hide private]
 
__init__(self, cms_file, director_abc_coeffs, descriptors_file, logger=None)
Create an instance.
list
_getResults(self)
Return the order parameter results.
list
_writeResultFiles(self)
Write the result files.
 
_writeOutputCMS(self, files)
Write the output cms file.
 
run(self)
Run the order parameter analysis.

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

Static Methods [hide private]
Director
getDirector(cms_obj, director_abc_coeffs)
Return the unit director vector object for the given cms (in Angstrom).
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, cms_file, director_abc_coeffs, descriptors_file, logger=None)
(Constructor)

 

Create an instance.

Parameters:
  • cms_file (str) - the .cms file for the simulation on which to run the order parameter analysis (can be a path)
  • director_abc_coeffs (tuple) - coefficients of the static reference director vector in the lattice vector basis, for example (0, 0, 1) for the c-lattice vector or z-axis of a cubic cell
  • descriptors_file (str) - .json file containing specifications for descriptors, i.e. ways to determine vectors used in computing the order parameters with respect to the director, a specification includes information like name, group, ASL, type, and SMARTS (can be a path) (see get_descriptors_from_file for more information)
  • logger (logging.Logger or None) - output logger or None if there isn't one
Overrides: object.__init__

getDirector(cms_obj, director_abc_coeffs)
Static Method

 

Return the unit director vector object for the given cms (in Angstrom).

Parameters:
  • cms_obj (schrodinger.application.desmond.cms.Cms) - the cms object
  • director_abc_coeffs (tuple) - coefficients of the static reference director vector in the lattice vector basis, for example (0, 0, 1) for the c-lattice vector or z-axis of a cubic cell
Returns: Director
the unit director vector object

_getResults(self)

 

Return the order parameter results.

Returns: list
contains lists of order parameters for each descriptor, each sublist has an order parameter value for each frame of the simulation

_writeResultFiles(self)

 

Write the result files.

Returns: list
contains the file names of the written files

_writeOutputCMS(self, files)

 

Write the output cms file.

Parameters:
  • files (list) - contains the file names of the order parameter result files