Reference documentation for deal.II version Git d199cacc3e 2019-07-18 17:13:56 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
function_time.h
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 1999 - 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_function_time_h
17 #define dealii_function_time_h
18 
19 
20 #include <deal.II/base/config.h>
21 
22 #include <deal.II/base/exceptions.h>
23 
24 DEAL_II_NAMESPACE_OPEN
72 template <typename Number = double>
74 {
75 public:
80  FunctionTime(const Number initial_time = Number(0.0));
81 
85  virtual ~FunctionTime() = default;
86 
90  Number
91  get_time() const;
92 
96  virtual void
97  set_time(const Number new_time);
98 
102  virtual void
103  advance_time(const Number delta_t);
104 
108  using time_type = Number;
109 
110 private:
114  Number time;
115 };
116 
117 
118 
119 /*----------------------------- Inline functions ----------------------------*/
120 
121 #ifndef DOXYGEN
122 
123 template <typename Number>
124 inline Number
126 {
127  return time;
128 }
129 
130 #endif
131 DEAL_II_NAMESPACE_CLOSE
132 
133 #endif
virtual ~FunctionTime()=default
virtual void advance_time(const Number delta_t)
virtual void set_time(const Number new_time)
numbers::NumberTraits< RangeNumberType >::real_type time_type
FunctionTime(const Number initial_time=Number(0.0))
Number get_time() const