Force_Thermostat.h

Go to the documentation of this file.

#ifndef SimTK_SIMBODY_FORCE_THERMOSTAT_H_
#define SimTK_SIMBODY_FORCE_THERMOSTAT_H_

/* -------------------------------------------------------------------------- *
 *                               Simbody(tm)                                  *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK 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/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2009-12 Stanford University and the Authors.        *
 * Authors: Michael Sherman                                                   *
 * Contributors: Christopher Bruns                                            *
 *                                                                            *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may    *
 * not use this file except in compliance with the License. You may obtain a  *
 * copy of the License at http://www.apache.org/licenses/LICENSE-2.0.         *
 *                                                                            *
 * Unless required by applicable law or agreed to in writing, software        *
 * distributed under the License is distributed on an "AS IS" BASIS,          *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
 * See the License for the specific language governing permissions and        *
 * limitations under the License.                                             *
 * -------------------------------------------------------------------------- */

#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() {}

    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_