applications/sequentialProps/ContactAngle1.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 APPLICATIONS_SEQUENTIALPROPS_CONTACTANGLE1_HPP
#define APPLICATIONS_SEQUENTIALPROPS_CONTACTANGLE1_HPP
#include "selection/SelectionEvaluator.hpp"
#include "selection/SelectionManager.hpp"
#include "applications/sequentialProps/SequentialAnalyzer.hpp"

using namespace std;
namespace OpenMD {

  /// Calculates the contact angle of a droplet with a surface
  /// using a spherical cap approximation for the droplet.

  /**  The position of the spherical cap relative to the surface plane
       is determined by the center-of-mass position of the selection,
       and this method assumes a uniform density in the droplet.  The
       angle of intersection between the surface of the spherical cap
       and the plane defines the contact angle, which is related to
       the center of mass height by:

       \f$ z_\mathrm{cm} = (2)^{-4/3} R_0 \left(
       \frac{1-\cos\theta}{2+\cos\theta}\right)^{1/3)
       \frac{3+\cos\theta}{2+\cos\theta} \f$

       where \f$z_\mathrm{cm}\f$ is measured relative to the planar
       surface, and \f$R_0\f$ is the radius of the free spherical
       droplet.

       This method was first proposed in:

       J. Hautman and M.L. Klein, Phys. Rev. Lett. 67(13), 1763 (1991).
       DOI: 10.1103/PhysRevLett.67.1763

       This Analyzer requires statement of the reference height of the
       solid surface, solidZ, and \f$R_0\f$, the dropletRadius.
 
  */ 
  class ContactAngle1 : public SequentialAnalyzer{
  public:
    ContactAngle1(SimInfo* info, const std::string& filename, 
                  const std::string& sele, RealType solidZ,
                  RealType dropletRadius);

    virtual void doFrame();
    
  private:

    RealType solidZ_;
    RealType dropletRadius_;
    
    std::string selectionScript_;
    SelectionManager seleMan_;
    SelectionEvaluator evaluator_;
    
  };
}

#endif


Revision:	2039
Committed:	Thu Nov 6 14:31:32 2014 UTC (10 years, 5 months ago) by gezelter
File size:	4044 byte(s)
Log Message:	Added a buffer length to ContactAngle2, starting documentation
#	User	Rev	Content
1	gezelter	2029	/*
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			#ifndef APPLICATIONS_SEQUENTIALPROPS_CONTACTANGLE1_HPP
43			#define APPLICATIONS_SEQUENTIALPROPS_CONTACTANGLE1_HPP
44			#include "selection/SelectionEvaluator.hpp"
45			#include "selection/SelectionManager.hpp"
46			#include "applications/sequentialProps/SequentialAnalyzer.hpp"
47
48			using namespace std;
49			namespace OpenMD {
50	gezelter	2039
51			/// Calculates the contact angle of a droplet with a surface
52			/// using a spherical cap approximation for the droplet.
53
54			/** The position of the spherical cap relative to the surface plane
55			is determined by the center-of-mass position of the selection,
56			and this method assumes a uniform density in the droplet. The
57			angle of intersection between the surface of the spherical cap
58			and the plane defines the contact angle, which is related to
59			the center of mass height by:
60
61			\f$ z_\mathrm{cm} = (2)^{-4/3} R_0 \left(
62			\frac{1-\cos\theta}{2+\cos\theta}\right)^{1/3)
63			\frac{3+\cos\theta}{2+\cos\theta} \f$
64
65			where \f$z_\mathrm{cm}\f$ is measured relative to the planar
66			surface, and \f$R_0\f$ is the radius of the free spherical
67			droplet.
68
69			This method was first proposed in:
70
71			J. Hautman and M.L. Klein, Phys. Rev. Lett. 67(13), 1763 (1991).
72			DOI: 10.1103/PhysRevLett.67.1763
73
74			This Analyzer requires statement of the reference height of the
75			solid surface, solidZ, and \f$R_0\f$, the dropletRadius.
76
77			*/
78	gezelter	2029	class ContactAngle1 : public SequentialAnalyzer{
79			public:
80			ContactAngle1(SimInfo* info, const std::string& filename,
81			const std::string& sele, RealType solidZ,
82			RealType dropletRadius);
83
84			virtual void doFrame();
85
86			private:
87
88			RealType solidZ_;
89			RealType dropletRadius_;
90
91			std::string selectionScript_;
92			SelectionManager seleMan_;
93			SelectionEvaluator evaluator_;
94
95			};
96			}
97
98			#endif
99
100
101