Force_Thermostat.h

Go to the documentation of this file.

#ifndef SimTK_SIMBODY_FORCE_THERMOSTAT_H_
#define SimTK_SIMBODY_FORCE_THERMOSTAT_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: Chris Bruns                                                  *
 *                                                                            *
 * 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::Thermostat : public Force {
public:
    Thermostat(GeneralForceSubsystem&        forces, 
               const SimbodyMatterSubsystem& matter, 
               Real                          boltzmannsConstant, 
               Real                          bathTemperature, 
               Real                          relaxationTime,
               int                           numExcludedDofs = 6);

    Thermostat& excludeMobilizedBody(MobilizedBodyIndex);

    Thermostat& setDefaultNumChains(int numChains);

    Thermostat& setDefaultBathTemperature(Real bathTemperature);

    Thermostat& setDefaultRelaxationTime(Real relaxationTime);

    Thermostat& setDefaultNumExcludedDofs(int numExcludedDofs);

    int getDefaultNumChains() const;
    Real getDefaultBathTemperature() const;
    Real getDefaultRelaxationTime() const;
    int getDefaultNumExcludedDofs() const;

    Real getBoltzmannsConstant() const;

    const Thermostat& setNumChains(State&, int numChains) const;
    const Thermostat& setBathTemperature(State&, Real Tb) const;
    const Thermostat& setRelaxationTime(State&, Real t) const;
    const Thermostat& setNumExcludedDofs(State&, int numExcludedDofs) const;

    int getNumChains(const State&) const;
    Real getBathTemperature(const State&) const;
    Real getRelaxationTime(const State&) const;
    int getNumExcludedDofs(const State&) const;

    int getNumThermalDofs(const State&) const;

    Real getCurrentTemperature(const State&) const;

    void initializeChainState(State&) const;
    void setChainState(State&, const Vector&) const;

    Vector getChainState(const State&) const;

    Real calcBathEnergy(const State& state) const;

    Real getExternalPower(const State& state) const;

    Real getExternalWork(const State& state) const;

    void setExternalWork(State& state, Real work) const;

    void initializeSystemToBathTemperature(State&) const;

    void setSystemToTemperature(State&, Real T) const;

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

} // namespace SimTK


#endif // SimTK_SIMBODY_FORCE_THERMOSTAT_H_