MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
X.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 #ifndef X_H
26 #define X_H
27 
28 #include <GeneralDefine.h>
29 #include <iostream>
30 #include "Math/Vector.h"
31 #include "Base_X_Y_Z.h"
32 #include <vector>
33 #include <array>
34 
35 class BaseParticle;
36 
37 class BaseInteraction;
38 
39 class DPMBase;
40 
41 namespace CGCoordinates
42 {
43 
50 class X : public Base_X_Y_Z
51 {
52 public:
53 
57  static void writeNames(std::ostream& os);
58 
62  void write(std::ostream& os) const;
63 
68  static Mdouble getVolumeOfAveragedDimensions(const Vec3D& min, const Vec3D& max);
69 
74  Mdouble getDistanceSquared(const Vec3D& p) const;
75 
79  static Mdouble getLength(const Vec3D& p);
80 
85  void setX(Mdouble x);
86 
87  Mdouble getX() const;
88 
94  Mdouble getINormal(const BaseInteraction& c, const Vec3D& normal) const;
95 
101  Mdouble getPNormal(const BaseInteraction& c, const Vec3D& normal) const;
102 
108  Mdouble getCNormal(const BaseInteraction& c, const Vec3D& normal) const;
109 
110  static bool isResolvedIn(unsigned i) {return i==0?true:false;}
111 
112  static std::string getName();
113 
114 protected:
115 
120 };
121 
125 template<typename T>
126 typename std::enable_if<std::is_base_of<CGCoordinates::X, typename T::CoordinatesType>::value, void>::type
127 spaceEvenly(Vec3D min, Vec3D max, std::vector<std::size_t> nAll, std::vector<T>& points)
128 {
129  std::size_t n = nAll[0];
130  Mdouble delta = (max.X - min.X) / n;
131  Mdouble start = min.X + 0.5 * delta;
132  points.resize(n);
133  for (std::size_t i = 0; i < n; i++)
134  {
135  points[i].coordinates.setX(start + delta * i);
136  }
137 }
138 
139 }
140 #endif
static void writeNames(std::ostream &os)
Writes the coordinate names in human-readable form to an ostream.
Definition: X.cc:32
The DPMBase header includes quite a few header files, defining all the handlers, which are essential...
Definition: DPMBase.h:72
Mdouble X
the vector components
Definition: Vector.h:65
Mdouble getCNormal(const BaseInteraction &c, const Vec3D &normal) const
For the Interaction between particles/walls P and I, this function returns the dot product between th...
Definition: X.cc:85
static Mdouble getVolumeOfAveragedDimensions(const Vec3D &min, const Vec3D &max)
returns the factor the CGFunction has to be divided by, due to integrating the variables over the ave...
Definition: X.cc:44
Mdouble getX() const
Definition: X.cc:54
void write(std::ostream &os) const
Writes the coordinates in human-readable form to an ostream.
Definition: X.cc:37
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getDistanceSquared(const Vec3D &p) const
Returns the square of the distance between the particle p and the current CGPoint, in the non-averaged directions.
Definition: X.cc:60
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
std::enable_if< std::is_base_of< CGCoordinates::O, typename T::CoordinatesType >::value, void >::type spaceEvenly(Vec3D min, Vec3D max, std::vector< std::size_t > nAll, std::vector< T > &points)
Definition: O.h:101
Defines the non-averaged directions on which spatial coarse-graining is applied (the x-direction for ...
Definition: X.h:50
Stores information about interactions between two interactable objects; often particles but could be ...
void setX(Mdouble x)
Returns the position of the current CGPoint, in the non-averaged directions.
Definition: X.cc:49
Contains common member functions of the X, Y, and Z classes.
Definition: Base_X_Y_Z.h:48
static std::string getName()
Definition: X.cc:90
Mdouble getINormal(const BaseInteraction &c, const Vec3D &normal) const
For the Interaction between particles/walls P and I, this function returns the dot product between th...
Definition: X.cc:75
static Mdouble getLength(const Vec3D &p)
Returns the length of the input vector in the non-averaged directions.
Definition: X.cc:69
Definition: Vector.h:49
Mdouble getPNormal(const BaseInteraction &c, const Vec3D &normal) const
For the Interaction between particles/walls P and I, this function returns the dot product between th...
Definition: X.cc:80
Mdouble x_
Definition: X.h:119
static bool isResolvedIn(unsigned i)
Definition: X.h:110