DART  6.10.1
Integrator.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_INTEGRATION_INTEGRATOR_HPP_
34 #define DART_INTEGRATION_INTEGRATOR_HPP_
35 
36 #include <vector>
37 
38 #include <Eigen/Dense>
39 
40 namespace dart {
41 namespace integration {
42 
45 {
46 public:
49 
51  virtual ~IntegrableSystem();
52 
53 public:
55  virtual void setConfigs(const Eigen::VectorXd& _configs) = 0;
56 
58  virtual void setGenVels(const Eigen::VectorXd& _genVels) = 0;
59 
61  virtual Eigen::VectorXd getConfigs() const = 0;
62 
64  virtual Eigen::VectorXd getGenVels() const = 0;
65 
67  virtual Eigen::VectorXd evalGenAccs() = 0;
68 
70  virtual void integrateConfigs(const Eigen::VectorXd& _genVels, double _dt)
71  = 0;
72 
74  virtual void integrateGenVels(const Eigen::VectorXd& _genVels, double _dt)
75  = 0;
76 };
77 
78 // TODO(kasiu): Consider templating the class (which currently only works on
79 // arbitrarily-sized vectors of doubles)
82 {
83 public:
86 
88  virtual ~Integrator();
89 
90 public:
92  virtual void integrate(IntegrableSystem* _system, double _dt) = 0;
93 
95  virtual void integratePos(IntegrableSystem* _system, double _dt) = 0;
96 
98  virtual void integrateVel(IntegrableSystem* _system, double _dt) = 0;
99 };
100 
101 } // namespace integration
102 } // namespace dart
103 
104 #endif // DART_INTEGRATION_INTEGRATOR_HPP_
Any class that uses an integrator should implement this interface.
Definition: Integrator.hpp:45
virtual Eigen::VectorXd getConfigs() const =0
Get configurations.
virtual void integrateConfigs(const Eigen::VectorXd &_genVels, double _dt)=0
Integrate configruations and store them in the system.
virtual void setGenVels(const Eigen::VectorXd &_genVels)=0
Set generalized velocities.
virtual Eigen::VectorXd getGenVels() const =0
Get generalized velocities.
virtual Eigen::VectorXd evalGenAccs()=0
Evaulate generalized accelerations.
IntegrableSystem()
Constructor.
Definition: Integrator.cpp:39
virtual void setConfigs(const Eigen::VectorXd &_configs)=0
Set configurations.
virtual void integrateGenVels(const Eigen::VectorXd &_genVels, double _dt)=0
Integrate generalized velocities and store them in the system.
virtual ~IntegrableSystem()
Destructor.
Definition: Integrator.cpp:44
class Integrator
Definition: Integrator.hpp:82
virtual ~Integrator()
Destructor.
virtual void integrate(IntegrableSystem *_system, double _dt)=0
Integrate the system with time step dt.
virtual void integratePos(IntegrableSystem *_system, double _dt)=0
Integrate velocity of the system with time step dt.
virtual void integrateVel(IntegrableSystem *_system, double _dt)=0
Integrate velocity of the system with time step dt.
Definition: BulletCollisionDetector.cpp:65