Source Code for Module prompt.angles

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2003-2005, 2009-2010 Edward d'Auvergne                        # 
 4  #                                                                             # 
 5  # This file is part of the program relax.                                     # 
 6  #                                                                             # 
 7  # relax is free software; you can redistribute it and/or modify               # 
 8  # it under the terms of the GNU General Public License as published by        # 
 9  # the Free Software Foundation; either version 2 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # relax is distributed in the hope that it will be useful,                    # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
15  # GNU General Public License for more details.                                # 
16  #                                                                             # 
17  # You should have received a copy of the GNU General Public License           # 
18  # along with relax; if not, write to the Free Software                        # 
19  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   # 
20  #                                                                             # 
21  ############################################################################### 
22   
23  # Module docstring. 
24  """Module containing the 'angles' user function class.""" 
25  __docformat__ = 'plaintext' 
26   
27  # Python module imports. 
28   
29  # relax module imports. 
30  from base_class import Basic_class 
31  from generic_fns import angles 
32   
33   
34 -class Angles(Basic_class): 
35      """Class containing the function for calculating XH bond angles.""" 
36   
37 -    def angle_diff_frame(self): 
38          """Calculate the angles defining the XH bond vector within the diffusion frame. 
39   
40          Description 
41          ~~~~~~~~~~~ 
42   
43          If the diffusion tensor is isotropic, then nothing will be done. 
44   
45          If the diffusion tensor is axially symmetric, then the angle alpha will be calculated for 
46          each XH bond vector. 
47   
48          If the diffusion tensor is asymmetric, then the three angles will be calculated. 
49          """ 
50   
51          # Function intro text. 
52          if self._exec_info.intro: 
53              text = self._exec_info.ps3 + "angle_diff_frame()" 
54              print(text) 
55   
56          # Execute the functional code. 
57          angles.angle_diff_frame() 
58