function_time.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 1999 - 2020 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_function_time_h
#define dealii_function_time_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
 
DEAL_II_NAMESPACE_OPEN
template <typename Number = double>
class FunctionTime
{
public:
  FunctionTime(const Number initial_time = Number(0.0));
 
  virtual ~FunctionTime() = default;
 
  Number
  get_time() const;
 
  virtual void
  set_time(const Number new_time);
 
  virtual void
  advance_time(const Number delta_t);
 
  using time_type = Number;
 
private:
  Number time;
};
 
 
 
/*----------------------------- Inline functions ----------------------------*/
 
#ifndef DOXYGEN
 
template <typename Number>
inline Number
FunctionTime<Number>::get_time() const
{
  return time;
}
 
#endif
DEAL_II_NAMESPACE_CLOSE
 
#endif