src/hydrodynamics/Ellipsoid.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#ifndef HYDRODYNAMICS_ELLIPSOID_HPP
#define HYDRODYNAMICS_ELLIPSOID_HPP
#include "hydrodynamics/Shape.hpp"
#include "math/SquareMatrix3.hpp"
namespace OpenMD {
  
  /** @class Ellipsoid 
   *
   * An ellipsoid in OpenMD is restricted to having two equal
   * equatorial semi-axes.  OpenMD treats the "special" axis as the
   * z-coordinate in the body fixed reference frame.  That is:
   *
   *   z^2 / a^2  +  (x^2 + y^2) / b^2   = 1
   *
   * If a >= b, the ellipsoid is a prolate spheroid, and if a < b, 
   * the ellipsoid is oblate.  Ellipsoids are specified in the constructor 
   * using an axial length (a), and a equatorial length (b).  A Vector3d 
   * can be used to position the center of the ellipsoid, and a rotation 
   * matrix can also be used to orient the ellipsoid to a preferred lab-fixed
   * coordinate frame.
   */
  class Ellipsoid : public Shape{
  public:
    Ellipsoid(Vector3d origin, RealType rAxial, RealType rEquatorial, Mat3x3d rotMat);
    virtual bool isInterior(Vector3d pos);
    virtual std::pair<Vector3d, Vector3d> getBoundingBox();
    virtual bool hasAnalyticalSolution() {return true;}
    
    virtual HydroProp* getHydroProp(RealType viscosity, RealType temperature);
    
    RealType getRAxial() {return rAxial_;}
    RealType getREquatorial() {return rEquatorial_;}
    RealType getRMajor() {return rMajor_;}
    RealType getRMinor() {return rMinor_;}
    
  private:
    
    Vector3d origin_;
    RealType rAxial_;
    RealType rEquatorial_;
    RealType rMajor_;
    RealType rMinor_;
    Mat3x3d rotMat_;
  };  
}

#endif
Revision:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 2 months ago) by gezelter
File size:	3757 byte(s)
Log Message:	Fixed a widespread typo in the license
#	Content
1	/*
2	* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3	*
4	* The University of Notre Dame grants you ("Licensee") a
5	* non-exclusive, royalty free, license to use, modify and
6	* redistribute this software in source and binary code form, provided
7	* that the following conditions are met:
8	*
9	* 1. Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.
11	*
12	* 2. Redistributions in binary form must reproduce the above copyright
13	* notice, this list of conditions and the following disclaimer in the
14	* documentation and/or other materials provided with the
15	* distribution.
16	*
17	* This software is provided "AS IS," without a warranty of any
18	* kind. All express or implied conditions, representations and
19	* warranties, including any implied warranty of merchantability,
20	* fitness for a particular purpose or non-infringement, are hereby
21	* excluded. The University of Notre Dame and its licensors shall not
22	* be liable for any damages suffered by licensee as a result of
23	* using, modifying or distributing the software or its
24	* derivatives. In no event will the University of Notre Dame or its
25	* licensors be liable for any lost revenue, profit or data, or for
26	* direct, indirect, special, consequential, incidental or punitive
27	* damages, however caused and regardless of the theory of liability,
28	* arising out of the use of or inability to use software, even if the
29	* University of Notre Dame has been advised of the possibility of
30	* such damages.
31	*
32	* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33	* research, please cite the appropriate papers when you publish your
34	* work. Good starting points are:
35	*
36	* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37	* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
39	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40	* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	*/
42
43	#ifndef HYDRODYNAMICS_ELLIPSOID_HPP
44	#define HYDRODYNAMICS_ELLIPSOID_HPP
45	#include "hydrodynamics/Shape.hpp"
46	#include "math/SquareMatrix3.hpp"
47	namespace OpenMD {
48
49	/** @class Ellipsoid
50	*
51	* An ellipsoid in OpenMD is restricted to having two equal
52	* equatorial semi-axes. OpenMD treats the "special" axis as the
53	* z-coordinate in the body fixed reference frame. That is:
54	*
55	* z^2 / a^2 + (x^2 + y^2) / b^2 = 1
56	*
57	* If a >= b, the ellipsoid is a prolate spheroid, and if a < b,
58	* the ellipsoid is oblate. Ellipsoids are specified in the constructor
59	* using an axial length (a), and a equatorial length (b). A Vector3d
60	* can be used to position the center of the ellipsoid, and a rotation
61	* matrix can also be used to orient the ellipsoid to a preferred lab-fixed
62	* coordinate frame.
63	*/
64	class Ellipsoid : public Shape{
65	public:
66	Ellipsoid(Vector3d origin, RealType rAxial, RealType rEquatorial, Mat3x3d rotMat);
67	virtual bool isInterior(Vector3d pos);
68	virtual std::pair<Vector3d, Vector3d> getBoundingBox();
69	virtual bool hasAnalyticalSolution() {return true;}
70
71	virtual HydroProp* getHydroProp(RealType viscosity, RealType temperature);
72
73	RealType getRAxial() {return rAxial_;}
74	RealType getREquatorial() {return rEquatorial_;}
75	RealType getRMajor() {return rMajor_;}
76	RealType getRMinor() {return rMinor_;}
77
78	private:
79
80	Vector3d origin_;
81	RealType rAxial_;
82	RealType rEquatorial_;
83	RealType rMajor_;
84	RealType rMinor_;
85	Mat3x3d rotMat_;
86	};
87	}
88
89	#endif