Math/Helpers.h
Go to the documentation of this file.
1 // This file is part of the MercuryDPM project (https://www.mercurydpm.org).
2 // Copyright (c), The MercuryDPM Developers Team. All rights reserved.
3 // License: BSD 3-Clause License; see the LICENSE file in the root directory.
4 
5 #ifndef MECURYDPM_HELPERS_H
6 #define MECURYDPM_HELPERS_H
7 
14 #include "Helpers/Helpers.h"
15 
19 // /*!
20 // * \brief Set disp and k such that is matches a given collision time tc and restitution coefficient r
21 // * for a collision of effective/reduced mass m.
22 // * \deprecated use species->setCollisionTimeAndRestitutionCoefficient
23 // * (collisionTime, dissipationTimeScale, 2.0*effectiveMass) instead
24 // */
25 // MERCURYDPM_DEPRECATED
26 // KAndDisp computeKAndDispFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);
27 //
28 // /*!
29 // * \brief Calculates the collision time for a given stiffness, dissipation, and effective mass
30 // * \deprecated use species->computeCollisionTime(2.0*effectiveMass) instead
31 // * \todo This does not result in the same value as the given alternative.
32 // */
33 // MERCURYDPM_DEPRECATED
34 // Mdouble computeCollisionTimeFromKAndDispAndEffectiveMass(Mdouble k, Mdouble disp, Mdouble mass);
35 //
36 // /*!
37 // * \brief Calculates the restitution coefficient time for a given stiffness, dissipation, and effective mass
38 // * \deprecated use species->computeRestitutionCoefficient(2.0*effectiveMass) instead
39 // */
40 // MERCURYDPM_DEPRECATED
41 // Mdouble computeRestitutionCoefficientFromKAndDispAndEffectiveMass(Mdouble k, Mdouble disp, Mdouble mass);
42 //
43 // /*!
44 // * \brief Calculates the dissipation for a given stiffness, restitution coefficient, and effective mass
45 // */
46 // MERCURYDPM_DEPRECATED
47 // Mdouble computeDispFromKAndRestitutionCoefficientAndEffectiveMass(Mdouble k, Mdouble r, Mdouble mass);
48 //
49 // /*!
50 // * \brief Calculates the collision time for a given stiffness, restitution coefficient, and effective mass
51 // * \deprecated use species->computeCollisionTime(2.0*effectiveMass) instead
52 // */
53 // MERCURYDPM_DEPRECATED
54 // Mdouble computeCollisionTimeFromKAndRestitutionCoefficientAndEffectiveMass(Mdouble k, Mdouble r, Mdouble mass);
55 //
56 // /*!
57 // * \brief Calculates the dissipation for a given stiffness, collision time, and effective mass
58 // * \deprecated use species->setStiffnessAndRestitutionCoefficient(2.0*effectiveMass) instead
59 // */
60 // MERCURYDPM_DEPRECATED
61 // Mdouble computeDispFromKAndCollisionTimeAndEffectiveMass(Mdouble k, Mdouble tc, Mdouble mass);
62 //
63 // /*!
64 // * \brief Calculates the restitution coefficient for a given stiffness, collision time, and effective mass
65 // * \deprecated use species->computeRestitutionCoefficient(2.0*effectiveMass) instead
66 // */
67 // MERCURYDPM_DEPRECATED
68 // Mdouble computeRestitutionCoefficientFromKAndCollisionTimeAndEffectiveMass(Mdouble k, Mdouble tc, Mdouble mass);
69 //
70 // /*!
71 // * \brief Calculates the dissipation for a given collision time, restitution coefficient, and effective mass
72 // * \deprecated use species->setCollisionTimeAndRestitutionCoefficient(2.0*effectiveMass) instead
73 // */
74 // MERCURYDPM_DEPRECATED
75 // Mdouble computeDispFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);
76 //
77 // /*!
78 // * \brief Calculates the stiffness for a given collision time, restitution coefficient, and effective mass
79 // * \deprecated use species->setCollisionTimeAndRestitutionCoefficient(2.0*effectiveMass) instead
80 // */
81 // MERCURYDPM_DEPRECATED
82 // Mdouble computeKFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);
83 //
84 // /*!
85 // * \brief Calculates the stiffness for a given collision time, dissipation, and effective mass
86 // */
87 // MERCURYDPM_DEPRECATED
88 // Mdouble computeKFromCollisionTimeAndDispAndEffectiveMass(Mdouble tc, Mdouble disp, Mdouble mass);
89 //
90 // /*!
91 // * \brief Calculates the resitution coefficient for a given collision time, dissipation, and effective mass
92 // * \deprecated use species->computeRestitutionCoefficient(2.0*effectiveMass) instead
93 // */
94 // MERCURYDPM_DEPRECATED
95 // Mdouble computeRestitutionCoefficientFromCollisionTimeAndDispAndEffectiveMass(Mdouble tc, Mdouble disp, Mdouble mass);
96 //
97 // /*!
98 // * \brief Calculates the stiffness for a given dissipation, restitution coefficient, and effective mass
99 // */
100 // MERCURYDPM_DEPRECATED
101 // Mdouble computeKFromDispAndRestitutionCoefficientAndEffectiveMass(Mdouble disp, Mdouble r, Mdouble mass);
102 //
103 // /*!
104 // * \brief Calculates the collision time for a given dissipation, restitution coefficient, and effective mass
105 // * \deprecated use species->computeCollisionTime(2.0*effectiveMass) instead
106 // */
107 // MERCURYDPM_DEPRECATED
108 // Mdouble computeCollisionTimeFromDispAndRestitutionCoefficientAndEffectiveMass(Mdouble disp, Mdouble r, Mdouble mass);
109 
110 #endif