OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
AbstractTimeDependence.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2014, Chris Rogers
3 * All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 * 1. Redistributions of source code must retain the above copyright notice,
7 * this list of conditions and the following disclaimer.
8 * 2. Redistributions in binary form must reproduce the above copyright notice,
9 * this list of conditions and the following disclaimer in the documentation
10 * and/or other materials provided with the distribution.
11 * 3. Neither the name of STFC nor the names of its contributors may be used to
12 * endorse or promote products derived from this software without specific
13 * prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef _CLASSIC_SRC_ALGORITHMS_ABSTRACTTIMEDEPENDENCE_H_
29#define _CLASSIC_SRC_ALGORITHMS_ABSTRACTTIMEDEPENDENCE_H_
30
31#include <string>
32#include <map>
33#include <memory>
34
46 // Unit tests for this class are in with PolynomialTimeDependence
47 public:
56
62 virtual double getValue(double time) = 0;
63
67 virtual double getIntegral(double time) = 0;
68
76 static std::shared_ptr<AbstractTimeDependence>
77 getTimeDependence(std::string name);
78
85 static void setTimeDependence(std::string name,
86 std::shared_ptr<AbstractTimeDependence> time_dep);
87
96 static std::string getName
97 (std::shared_ptr<AbstractTimeDependence> time_dep);
98
99 private:
100 static std::map<std::string, std::shared_ptr<AbstractTimeDependence> > td_map;
101};
102
103#endif
const std::string name
Time dependence abstraction for field parameters that vary slowly with time; for example,...
static void setTimeDependence(std::string name, std::shared_ptr< AbstractTimeDependence > time_dep)
Add a value to the lookup table.
static std::string getName(std::shared_ptr< AbstractTimeDependence > time_dep)
Get the name corresponding to a given time_dep.
static std::shared_ptr< AbstractTimeDependence > getTimeDependence(std::string name)
Look up the time dependence that has a given name.
static std::map< std::string, std::shared_ptr< AbstractTimeDependence > > td_map
virtual AbstractTimeDependence * clone()=0
Inheritable copy constructor.
virtual ~AbstractTimeDependence()
Destructor does nothing.
virtual double getValue(double time)=0
getValue(time) returns the value as a function of time.
virtual double getIntegral(double time)=0
getIntegral(time) returns the integral from 0 to time of the function.