torque.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
//
//  UnitConversion: A compile-time c++23 unit conversion library with no dependencies
//
//--------------------------------------------------------------------------------------------------
//
// The MIT License (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software
// and associated documentation files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
// BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//--------------------------------------------------------------------------------------------------
//
// Copyright (c) 2016 Nic Holthaus
//
//--------------------------------------------------------------------------------------------------
//
// ATTRIBUTION:
// Parts of this work have been adapted from:
// http://stackoverflow.com/questions/35069778/create-comparison-trait-for-template-classes-whose-parameters-are-in-a-different
// http://stackoverflow.com/questions/28253399/check-traits-for-all-variadic-template-arguments/28253503
// http://stackoverflow.com/questions/36321295/rational-approximation-of-square-root-of-stdratio-at-compile-time?noredirect=1#comment60266601_36321295
// https://github.com/swatanabe/cppnow17-units
//
//--------------------------------------------------------------------------------------------------
//
//
//--------------------------------------------------------------------------------------------------
 
#pragma once
 
#ifndef units_torque_h_
#define units_torque_h_
 
#include <units/energy.h>
#include <units/force.h>
#include <units/length.h>
 
namespace units
{
    UNIT_ADD(torque, newton_meters, Nm, conversion_factor<std::ratio<1>, joules_>)
    // Torque is conventionally named "pound-foot" (lbf*ft) to distinguish it from the "foot-pound" (ft*lbf) energy
    // unit. `pound_feet` is the torque unit; `foot_pounds` is a deprecated alias of it.
    UNIT_ADD(torque, pound_feet, lbf_ft, compound_conversion_factor<feet_, force::pounds_>)
    UNIT_ADD(torque, foot_poundals, ftpdl, compound_conversion_factor<feet_, poundals_>)
    UNIT_ADD(torque, inch_pounds, inlb, compound_conversion_factor<inches_, force::pounds_>)
    UNIT_ADD(torque, meter_kilograms, mkgf, compound_conversion_factor<meters<>, kiloponds<>>)
 
    inline namespace torque
    {
        template<class Underlying = UNIT_LIB_DEFAULT_TYPE>
        using foot_pounds [[deprecated("torque is conventionally 'pound-foot'; use units::torque::pound_feet. "
                                       "(units::energy::foot_pounds remains the energy unit.)")]] = pound_feet<Underlying>;
    }
 
    UNIT_ADD_DIMENSION_TRAIT(torque, Torque)
} // namespace units
 
#endif // units_torque_h_