revision: v0.14
helpers::KAndDispAndKtAndDispt Class Reference

Calculates the collision time for a given stiffness, dissipation, and effective mass. More...

#include <Helpers.h>

Public Attributes

Mdouble k
 
Mdouble disp
 
Mdouble kt
 
Mdouble dispt
 

Detailed Description

Calculates the collision time for a given stiffness, dissipation, and effective mass.

     \brief Set disp and k such that is matches a given collision time tc and restitution coefficient r
     for a collision of effective/reduced mass m.
     \deprecated use species->setCollisionTimeAndRestitutionCoefficient
       (collisionTime, dissipationTimeScale, 2.0*effectiveMass) instead
    &zwj;/

MERCURY_DEPRECATED KAndDisp computeKAndDispFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);

/*!

Deprecated:
use species->computeCollisionTime(2.0*effectiveMass) instead
Todo:
This does not result in the same value as the given alternative. ‍/ MERCURY_DEPRECATED Mdouble computeCollisionTimeFromKAndDispAndEffectiveMass(Mdouble k, Mdouble disp, Mdouble mass);

/*!

Calculates the restitution coefficient time for a given stiffness, dissipation, and effective mass

Deprecated:
use species->computeRestitutionCoefficient(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeRestitutionCoefficientFromKAndDispAndEffectiveMass(Mdouble k, Mdouble disp, Mdouble mass);

/*!

Calculates the dissipation for a given stiffness, restitution coefficient, and effective mass ‍/ MERCURY_DEPRECATED Mdouble computeDispFromKAndRestitutionCoefficientAndEffectiveMass(Mdouble k, Mdouble r, Mdouble mass);

/*!

Calculates the collision time for a given stiffness, restitution coefficient, and effective mass

Deprecated:
use species->computeCollisionTime(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeCollisionTimeFromKAndRestitutionCoefficientAndEffectiveMass(Mdouble k, Mdouble r, Mdouble mass);

/*!

Calculates the dissipation for a given stiffness, collision time, and effective mass

Deprecated:
use species->setStiffnessAndRestitutionCoefficient(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeDispFromKAndCollisionTimeAndEffectiveMass(Mdouble k, Mdouble tc, Mdouble mass);

/*!

Calculates the restitution coefficient for a given stiffness, collision time, and effective mass

Deprecated:
use species->computeRestitutionCoefficient(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeRestitutionCoefficientFromKAndCollisionTimeAndEffectiveMass(Mdouble k, Mdouble tc, Mdouble mass);

/*!

Calculates the dissipation for a given collision time, restitution coefficient, and effective mass

Deprecated:
use species->setCollisionTimeAndRestitutionCoefficient(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeDispFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);

/*!

Calculates the stiffness for a given collision time, restitution coefficient, and effective mass

Deprecated:
use species->setCollisionTimeAndRestitutionCoefficient(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeKFromCollisionTimeAndRestitutionCoefficientAndEffectiveMass(Mdouble tc, Mdouble r, Mdouble mass);

/*!

Calculates the stiffness for a given collision time, dissipation, and effective mass ‍/ MERCURY_DEPRECATED Mdouble computeKFromCollisionTimeAndDispAndEffectiveMass(Mdouble tc, Mdouble disp, Mdouble mass);

/*!

Calculates the resitution coefficient for a given collision time, dissipation, and effective mass

Deprecated:
use species->computeRestitutionCoefficient(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeRestitutionCoefficientFromCollisionTimeAndDispAndEffectiveMass(Mdouble tc, Mdouble disp, Mdouble mass);

/*!

Calculates the stiffness for a given dissipation, restitution coefficient, and effective mass ‍/ MERCURY_DEPRECATED Mdouble computeKFromDispAndRestitutionCoefficientAndEffectiveMass(Mdouble disp, Mdouble r, Mdouble mass);

/*!

Calculates the collision time for a given dissipation, restitution coefficient, and effective mass

Deprecated:
use species->computeCollisionTime(2.0*effectiveMass) instead ‍/ MERCURY_DEPRECATED Mdouble computeCollisionTimeFromDispAndRestitutionCoefficientAndEffectiveMass(Mdouble disp, Mdouble r, Mdouble mass);

/return type specifically for fuctions returning k, disp, kt, dispt at once

/*!

return type specifically for fuctions returning k, disp, kt, dispt at once

Member Data Documentation

◆ disp

◆ dispt

◆ k

◆ kt


The documentation for this class was generated from the following file: