#include <SplineTimeDependence.h>

Inheritance diagram for SplineTimeDependence:

Collaboration diagram for SplineTimeDependence:

Public Member Functions
	SplineTimeDependence (size_t splineOrder, std::vector< double > times, std::vector< double > values)
	SplineTimeDependence (const SplineTimeDependence &rhs)
	SplineTimeDependence ()
	~SplineTimeDependence ()
double	getValue (double time)
SplineTimeDependence *	clone ()
Inform &	print (Inform &os)
void	setSpline (size_t splineOrder, std::vector< double > times, std::vector< double > values)

Static Public Member Functions
static std::shared_ptr< AbstractTimeDependence >	getTimeDependence (std::string name)
static void	setTimeDependence (std::string name, std::shared_ptr< AbstractTimeDependence > time_dep)
static std::string	getName (std::shared_ptr< AbstractTimeDependence > time_dep)

Private Attributes
gsl_spline *	spline_m
gsl_interp_accel *	acc_m
size_t	splineOrder_m
std::vector< double >	times_m
std::vector< double >	values_m

Static Private Attributes
static std::map< std::string, std::shared_ptr< AbstractTimeDependence > >	td_map

Detailed Description

Time dependence that follows a spline. Interpolation is supported at linear or cubic order..

Interpolation is done using gsl_spline routines (1st or 3rd order).

Nb: I tried to use PolynomialPatch, as it is arbitrary order interpolation, but it turns out that only works for regular grids.

Definition at line 50 of file SplineTimeDependence.h.

Constructor & Destructor Documentation

◆ SplineTimeDependence() [1/3]

SplineTimeDependence::SplineTimeDependence	(	size_t	splineOrder,
		std::vector< double >	times,
		std::vector< double >	values )

Constructor

Parameters

splineOrder	the order of the spline used to fit the time dependence; either 1 (linear interpolation) or 3 (cubic spline with quadratic smoothing)
times	the times of successive elements in the time dependence
values	the values at each time step.

It is an error if times and values are not of equal length, times and values length < splineOrder + 1, or times do not increase strictly monotonically.

Definition at line 36 of file SplineTimeDependence.cpp.

References acc_m, setSpline(), and spline_m.

Referenced by clone(), and SplineTimeDependence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplineTimeDependence() [2/3]

SplineTimeDependence::SplineTimeDependence ( const SplineTimeDependence & rhs )

Copy Constructor

Definition at line 43 of file SplineTimeDependence.cpp.

References acc_m, setSpline(), spline_m, splineOrder_m, SplineTimeDependence(), times_m, and values_m.

Here is the call graph for this function:

◆ SplineTimeDependence() [3/3]

SplineTimeDependence::SplineTimeDependence ( )

Default Constructor makes a dependence of length 2 with values 0

Definition at line 48 of file SplineTimeDependence.cpp.

References acc_m, and spline_m.

Referenced by clone().

Here is the caller graph for this function:

◆ ~SplineTimeDependence()

SplineTimeDependence::~SplineTimeDependence ( )

Destructor does nothing

Definition at line 51 of file SplineTimeDependence.cpp.

References acc_m, and spline_m.

Member Function Documentation

◆ clone()

SplineTimeDependence * SplineTimeDependence::clone ( )

virtual

Inheritable copy constructor

Returns: new SplineTimeDependence.

Implements AbstractTimeDependence.

Definition at line 60 of file SplineTimeDependence.cpp.

References setSpline(), splineOrder_m, SplineTimeDependence(), SplineTimeDependence(), times_m, and values_m.

Here is the call graph for this function:

◆ getName()

std::string AbstractTimeDependence::getName ( std::shared_ptr< AbstractTimeDependence > time_dep )

staticinherited

Get the name corresponding to a given time_dep

Parameters

time_dep time dependence to lookup

Returns: name corresponding to the time dependence. Note that this just does a dumb loop over the stored map values; so O(N).

Exceptions

GeneralClassicException if time_dep is not recognised

Definition at line 50 of file AbstractTimeDependence.cpp.

References td_map.

◆ getTimeDependence()

std::shared_ptr< AbstractTimeDependence > AbstractTimeDependence::getTimeDependence ( std::string name )

staticinherited

Look up the time dependence that has a given name

Parameters

name	name of the time dependence

Returns: shared_ptr to the appropriate time dependence.

Exceptions

GeneralClassicException if name is not recognised

Definition at line 36 of file AbstractTimeDependence.cpp.

References td_map.

◆ getValue()

double SplineTimeDependence::getValue ( double time )

inlinevirtual

Return the value of the spline at a given time

Parameters

time	time at which the spline is referenced. If time is off either end of the spline, the last few values are used to extrapolate past the end of the spline.

Implements AbstractTimeDependence.

Definition at line 119 of file SplineTimeDependence.h.

References acc_m, spline_m, and times_m.

◆ print()

Inform & SplineTimeDependence::print ( Inform & os )

Print summary information about the time dependence

Parameters

os	"Inform" stream to which the information is printed.

Definition at line 66 of file SplineTimeDependence.cpp.

References spline_m, splineOrder_m, and times_m.

Referenced by operator<<().

Here is the caller graph for this function:

◆ setSpline()

void SplineTimeDependence::setSpline	(	size_t	splineOrder,
		std::vector< double >	times,
		std::vector< double >	values )

Set the spline, deleting any existing spline data

Definition at line 76 of file SplineTimeDependence.cpp.

References acc_m, spline_m, times_m, and values_m.

Referenced by clone(), SplineTimeDependence(), and SplineTimeDependence().

Here is the caller graph for this function:

◆ setTimeDependence()

void AbstractTimeDependence::setTimeDependence	(	std::string	name,
		std::shared_ptr< AbstractTimeDependence >	time_dep )

staticinherited

Add a value to the lookup table

Parameters

name	name of the time dependence. If name already exists in the map, it is overwritten with the new value.
time_dep	shared_ptr to the time dependence.

Definition at line 45 of file AbstractTimeDependence.cpp.

References td_map.

Member Data Documentation

◆ acc_m

gsl_interp_accel* SplineTimeDependence::acc_m

private

Definition at line 106 of file SplineTimeDependence.h.

Referenced by getValue(), setSpline(), SplineTimeDependence(), SplineTimeDependence(), SplineTimeDependence(), and ~SplineTimeDependence().

◆ spline_m

gsl_spline* SplineTimeDependence::spline_m

private

Definition at line 105 of file SplineTimeDependence.h.

Referenced by getValue(), print(), setSpline(), SplineTimeDependence(), SplineTimeDependence(), SplineTimeDependence(), and ~SplineTimeDependence().

◆ splineOrder_m

size_t SplineTimeDependence::splineOrder_m

private

Definition at line 107 of file SplineTimeDependence.h.

Referenced by clone(), print(), and SplineTimeDependence().

◆ td_map

std::map< std::string, std::shared_ptr< AbstractTimeDependence > > AbstractTimeDependence::td_map

staticprivateinherited

Initial value:

=

std::map<std::string, std::shared_ptr<AbstractTimeDependence> >()

Definition at line 95 of file AbstractTimeDependence.h.

Referenced by getName(), getTimeDependence(), and setTimeDependence().

◆ times_m

std::vector<double> SplineTimeDependence::times_m

private

Definition at line 108 of file SplineTimeDependence.h.

Referenced by clone(), getValue(), print(), setSpline(), and SplineTimeDependence().

◆ values_m

std::vector<double> SplineTimeDependence::values_m

private

Definition at line 109 of file SplineTimeDependence.h.

Referenced by clone(), setSpline(), and SplineTimeDependence().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SplineTimeDependence() [1/3]

◆ SplineTimeDependence() [2/3]

◆ SplineTimeDependence() [3/3]

◆ ~SplineTimeDependence()

Member Function Documentation

◆ clone()

◆ getName()

◆ getTimeDependence()

◆ getValue()

◆ print()

◆ setSpline()

◆ setTimeDependence()

Member Data Documentation

◆ acc_m

◆ spline_m

◆ splineOrder_m

◆ td_map

◆ times_m

◆ values_m