Reference documentation for deal.II version 9.1.1
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
incremental_function.h
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 2018 by the deal.II authors
4 //
5 // This file is part of the deal.II library.
6 //
7 // The deal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 2.1 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE.md at
12 // the top level directory of deal.II.
13 //
14 // ---------------------------------------------------------------------
15 
16 #ifndef dealii_incremental_function_h
17 #define dealii_incremental_function_h
18 
19 
20 #include <deal.II/base/function.h>
21 #include <deal.II/base/thread_management.h>
22 
23 DEAL_II_NAMESPACE_OPEN
24 
25 template <typename number>
26 class Vector;
27 
28 namespace Functions
29 {
44  template <int dim, typename RangeNumberType = double>
45  class IncrementalFunction : public Function<dim, RangeNumberType>
46  {
47  public:
52  static const unsigned int dimension = dim;
53 
58 
70 
78  virtual RangeNumberType
79  value(const Point<dim> &p, const unsigned int component = 0) const override;
80 
87  virtual void
88  vector_value(const Point<dim> & p,
89  Vector<RangeNumberType> &values) const override;
90 
96  void
98 
99  private:
104 
109 
114 
119  };
120 
121 } // namespace Functions
122 
123 
124 DEAL_II_NAMESPACE_CLOSE
125 
126 #endif
Functions::IncrementalFunction::value
virtual RangeNumberType value(const Point< dim > &p, const unsigned int component=0) const override
Definition: incremental_function.cc:50
Functions::IncrementalFunction::time_type
typename Function< dim, RangeNumberType >::time_type time_type
Definition: incremental_function.h:57
Functions
Definition: flow_function.h:28
Threads::Mutex
Definition: thread_management.h:88
Functions::IncrementalFunction::dimension
static const unsigned int dimension
Definition: incremental_function.h:52
Functions::IncrementalFunction
Definition: incremental_function.h:45
Functions::IncrementalFunction::set_decrement
void set_decrement(const time_type delta_t)
Definition: incremental_function.cc:38
Function::time_type
typename FunctionTime< typename numbers::NumberTraits< RangeNumberType >::real_type >::time_type time_type
Definition: function.h:168
Functions::IncrementalFunction::IncrementalFunction
IncrementalFunction(Function< dim, RangeNumberType > &base)
Definition: incremental_function.cc:26
Functions::IncrementalFunction::delta_t
time_type delta_t
Definition: incremental_function.h:108
parallel::distributed::Vector
LinearAlgebra::distributed::Vector< Number > Vector
Definition: parallel_vector.h:148
Functions::IncrementalFunction::vector_value
virtual void vector_value(const Point< dim > &p, Vector< RangeNumberType > &values) const override
Definition: incremental_function.cc:79
Functions::IncrementalFunction::mutex
Threads::Mutex mutex
Definition: incremental_function.h:118
Functions::IncrementalFunction::values_old
Vector< RangeNumberType > values_old
Definition: incremental_function.h:113
Point< dim >
Functions::IncrementalFunction::base
Function< dim, RangeNumberType > & base
Definition: incremental_function.h:103
Function
Definition: function.h:148
Vector< RangeNumberType >