Force_LinearBushing.h

Go to the documentation of this file.

#ifndef SimTK_SIMBODY_FORCE_LINEAR_BUSHING_H_
#define SimTK_SIMBODY_FORCE_LINEAR_BUSHING_H_
/* -------------------------------------------------------------------------- *
 *                      SimTK Core: SimTK Simbody(tm)                         *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK Core biosimulation toolkit originating from      *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org.               *
 *                                                                            *
 * Portions copyright (c) 2009 Stanford University and the Authors.           *
 * Authors: Michael Sherman                                                   *
 * Contributors:                                                              *
 *                                                                            *
 * 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, CONTRIBUTORS 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.                                     *
 * -------------------------------------------------------------------------- */

#include "SimTKcommon.h"
#include "simbody/internal/Force.h"

namespace SimTK {
class SimTK_SIMBODY_EXPORT Force::LinearBushing : public Force {
public:
    LinearBushing(GeneralForceSubsystem& forces, 
                  const MobilizedBody& body1, const Transform& frameFOnB1, 
                  const MobilizedBody& body2, const Transform& frameMOnB2, 
                  const Vec6& stiffness, const Vec6& damping);

    LinearBushing(GeneralForceSubsystem& forces, 
                  const MobilizedBody& body1, 
                  const MobilizedBody& body2, 
                  const Vec6& stiffness, const Vec6& damping);



    //--------------------------------------------------------------------------










    LinearBushing& setDefaultFrameOnBody1(const Transform& X_B1F);
    LinearBushing& setDefaultFrameOnBody2(const Transform& X_B2M);
    LinearBushing& setDefaultStiffness(const Vec6& stiffness);
    LinearBushing& setDefaultDamping(const Vec6& damping);

    const Transform& getDefaultFrameOnBody1() const;
    const Transform& getDefaultFrameOnBody2() const;
    const Vec6& getDefaultStiffness() const;
    const Vec6& getDefaultDamping()   const;



    //--------------------------------------------------------------------------













    const LinearBushing& setFrameOnBody1(State&             state, 
                                         const Transform&   X_B1F) const;
    const LinearBushing& setFrameOnBody2(State&             state, 
                                         const Transform&   X_B2M) const;
    const LinearBushing& setStiffness(State&        state, 
                                      const Vec6&   stiffness) const;
    const LinearBushing& setDamping(State&      state, 
                                    const Vec6& damping) const;

    const Transform& getFrameOnBody1(const State& state) const;
    const Transform& getFrameOnBody2(const State& state) const;
    const Vec6& getStiffness(const State& state) const;
    const Vec6& getDamping(const State& state)   const;



    //--------------------------------------------------------------------------













    const Vec6& getQ(const State& state) const;

    const Transform& getX_GF(const State& state) const;

    const Transform& getX_GM(const State& state) const;

    const Transform& getX_FM(const State& state) const;



    //--------------------------------------------------------------------------













    const Vec6& getQDot(const State& state) const;

    const SpatialVec& getV_GF(const State& state) const;

    const SpatialVec& getV_GM(const State& state) const;

    const SpatialVec& getV_FM(const State& state) const;



    //--------------------------------------------------------------------------














    const Vec6& getF(const State& state) const;

    const SpatialVec& getF_GM(const State& state) const;

    const SpatialVec& getF_GF(const State& state) const;



    //--------------------------------------------------------------------------









    Real getPotentialEnergy(const State& state) const;

    Real getPowerDissipation(const State& state) const;

    Real getDissipatedEnergy(const State& state) const;

    void setDissipatedEnergy(State& state, Real energy) const;

    // Don't show this in Doxygen.
    SimTK_INSERT_DERIVED_HANDLE_DECLARATIONS
       (LinearBushing, LinearBushingImpl, Force);
};

} // namespace SimTK

#endif // SimTK_SIMBODY_FORCE_LINEAR_BUSHING_H_