All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
damping_functions.h
1 /* Copyright (C) 2004-2012 MBSim Development Team
2  *
3  * This library is free software; you can redistribute it and/or
4  * modify it under the terms of the GNU Lesser General Public
5  * License as published by the Free Software Foundation; either
6  * version 2.1 of the License, or (at your option) any later version.
7  *
8  * This library is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11  * Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public
14  * License along with this library; if not, write to the Free Software
15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16  *
17  * Contact: martin.o.foerg@googlemail.com
18  */
19 
20 #ifndef NUMERICS_DAMPINGFUNCITONS_H_
21 #define NUMERICS_DAMPINGFUNCITONS_H_
22 
23 #include <mbsim/numerics/functions/criteria_functions.h>
24 
25 namespace MBSim {
26 
27  class DampingFunction : public Function<double(fmatvec::Vec,fmatvec::Vec)> {
28  public:
33 
34  /*
35  * \brief destructor
36  */
37  virtual ~DampingFunction() {
38  }
39 
40  /* GETTER / SETTER*/
41  void setFunction(Function<fmatvec::Vec(fmatvec::Vec)> * function_) {
42  function = function_;
43  }
44  void setCriteriaFunction(CriteriaFunction * criteria_) {
45  criteria = criteria_;
46  }
47  /******************/
48 
49  virtual double operator ()(const fmatvec::Vec & x, const fmatvec::Vec & dx) = 0;
50 
51  protected:
56 
61 
62  };
63 
65 
66  public:
70  StandardDampingFunction(unsigned int kmax_ = 10, double d_ = 0.5);
71 
72  /*
73  * \brief destructor
74  */
75  virtual ~StandardDampingFunction() {
76  }
77 
78  virtual double operator ()(const fmatvec::Vec &x, const fmatvec::Vec &dx);
79 
80  void setMaximalDampingSteps(unsigned int k_) {
81  kmax = k_;
82  }
83 
84  void setDampingNumber(double d_) {
85  d = d_;
86  }
87 
88  protected:
92  unsigned int kmax;
93 
97  double d;
98  };
99 }
100 #endif //NUMERICS_DAMPINGFUNCITONS_H_
double d
damping number
Definition: damping_functions.h:97
StandardDampingFunction(unsigned int kmax_=10, double d_=0.5)
constructor
Definition: damping_functions.cc:33
unsigned int kmax
maximal damping steps
Definition: damping_functions.h:92
CriteriaFunction * criteria
criteria that defines if a solution gets better
Definition: damping_functions.h:60
Mother class for different criterias that are fulfilled or not.
Definition: criteria_functions.h:33
Definition: planar_contour.h:31
Definition: damping_functions.h:27
Definition: damping_functions.h:64
DampingFunction()
constructor
Definition: damping_functions.cc:28

Impressum / Disclaimer / Datenschutz Generated by doxygen 1.8.5 Valid HTML