#include <Storage.hpp>

Collaboration diagram for precice::time::Storage:

Public Member Functions
	Storage ()
	Stores data samples in time and provides corresponding convenience functions.

Storage &	operator= (const Storage &other)
	Copy assignment operator to assign Storage to this Storage.

void	setSampleAtTime (double time, const Sample &sample)
	Store Sample at a specific time.

void	setAllSamples (const Sample &sample)
	Overrides all existing samples.

void	setInterpolationDegree (int interpolationDegree)

int	getInterpolationDegree () const

double	maxStoredTime () const
	Get maximum time that is stored in this Storage.

const Sample &	getSampleAtOrAfter (double before) const
	Returns the Sample at time following "before" contained in this Storage.

const Sample &	getSampleAtEnd () const
	Returns the last Sample contained in this Storage.

Eigen::VectorXd	getTimes () const
	Get all normalized dts stored in this Storage sorted ascending.

auto	stamples () const
	Get the stamples.

auto	stamples ()

bool	empty () const

const time::Stample &	last () const

std::pair< Eigen::VectorXd, Eigen::MatrixXd >	getTimesAndValues () const
	Get all normalized dts and values in ascending order (with respect to normalized dts)

int	nTimes () const
	Number of stored times.

int	nDofs () const
	Number of Dofs for each values.

void	move ()
	Move this Storage by deleting all stamples except the one at the end of the window.

void	trim ()
	Trims this Storage by deleting all values except values associated with the window start.

void	clear ()
	Clears this Storage by deleting all values.

void	clearExceptLast ()

void	trimBefore (double time)

void	trimAfter (double time)

SampleResult	sample (double time) const
	Need to use interpolation for the case with changing time grids.

Eigen::MatrixXd	sampleGradients (double time) const

Private Member Functions
int	computeUsedDegree (int requestedDegree, int numberOfAvailableSamples) const
	Computes which degree may be used for interpolation.

Private Attributes
std::vector< Stample >	_stampleStorage
	Stores Stamples on the current window.

logging::Logger	_log {"time::Storage"}

int	_degree

std::optional< math::Bspline >	_bspline

Detailed Description

Definition at line 13 of file Storage.hpp.

Constructor & Destructor Documentation

◆ Storage()

precice::time::Storage::Storage ( )

Stores data samples in time and provides corresponding convenience functions.

The Storage must be initialized before it can be used. Then values can be stored in the Storage. It is only allowed to store samples with increasing times. Overwriting existing samples or writing samples with a time smaller then the maximum stored time is forbidden. The Storage is considered complete, when a sample for the end of the current window is provided. Then one can only sample from the storage. To add further samples one needs to trim the storage or move to the next time window first.

This Storage is used in the context of Waveform relaxation where samples in time are provided.

Definition at line 12 of file Storage.cpp.

Member Function Documentation

◆ clear()

void precice::time::Storage::clear ( )

Clears this Storage by deleting all values.

Definition at line 117 of file Storage.cpp.

◆ clearExceptLast()

void precice::time::Storage::clearExceptLast ( )

Definition at line 126 of file Storage.cpp.

◆ computeUsedDegree()

int precice::time::Storage::computeUsedDegree	(	int	requestedDegree,
		int	numberOfAvailableSamples ) const

private

Computes which degree may be used for interpolation.

Actual degree of interpolating B-spline is determined by number of stored samples and maximum degree defined by the user. Example: If only two samples are available, the maximum degree we may use is 1, even if the user demands degree 2.

Parameters

requestedDegree	B-spline degree requested by the user.
numberOfAvailableSamples	Samples available for interpolation.

Returns: B-spline degree that may be used.

Definition at line 240 of file Storage.cpp.

Here is the call graph for this function:

◆ empty()

bool precice::time::Storage::empty ( ) const

Definition at line 176 of file Storage.cpp.

◆ getInterpolationDegree()

int precice::time::Storage::getInterpolationDegree ( ) const

Definition at line 68 of file Storage.cpp.

◆ getSampleAtEnd()

const Sample & precice::time::Storage::getSampleAtEnd ( ) const

Returns the last Sample contained in this Storage.

Returns: Last Sample in this Storage

Definition at line 245 of file Storage.cpp.

◆ getSampleAtOrAfter()

const Sample & precice::time::Storage::getSampleAtOrAfter ( double before ) const

Returns the Sample at time following "before" contained in this Storage.

The stored normalized dt is larger or equal than "before". If "before" is a normalized dt stored in this Storage, this function returns the Sample at "before"

Parameters

before a double, where we want to find a normalized dt that comes directly after this one

Returns: Sample in this Storage at or directly after "before"

Definition at line 155 of file Storage.cpp.

Here is the call graph for this function:

◆ getTimes()

Eigen::VectorXd precice::time::Storage::getTimes ( ) const

Get all normalized dts stored in this Storage sorted ascending.

Returns: Eigen::VectorXd containing all stored normalized dts in ascending order.

Definition at line 167 of file Storage.cpp.

Here is the call graph for this function:

◆ getTimesAndValues()

std::pair< Eigen::VectorXd, Eigen::MatrixXd > precice::time::Storage::getTimesAndValues ( ) const

Get all normalized dts and values in ascending order (with respect to normalized dts)

Returns: std::pair<Eigen::VectorXd, Eigen::MatrixXd> containing all stored times and values in ascending order (with respect to normalized dts).

Definition at line 187 of file Storage.cpp.

Here is the call graph for this function:

◆ last()

const time::Stample & precice::time::Storage::last ( ) const

Definition at line 181 of file Storage.cpp.

◆ maxStoredTime()

double precice::time::Storage::maxStoredTime ( ) const

Get maximum time that is stored in this Storage.

Returns: the maximum time from this Storage

Definition at line 73 of file Storage.cpp.

◆ move()

void precice::time::Storage::move ( )

Move this Storage by deleting all stamples except the one at the end of the window.

Definition at line 93 of file Storage.cpp.

Here is the call graph for this function:

◆ nDofs()

int precice::time::Storage::nDofs ( ) const

Number of Dofs for each values.

Returns: int number of dofs

Definition at line 87 of file Storage.cpp.

◆ nTimes()

int precice::time::Storage::nTimes ( ) const

Number of stored times.

Returns: int number of stored times

Definition at line 82 of file Storage.cpp.

◆ operator=()

Storage & precice::time::Storage::operator= ( const Storage & other )

Copy assignment operator to assign Storage to this Storage.

Parameters

other Storage

Returns: Storage&

Definition at line 17 of file Storage.cpp.

Here is the call graph for this function:

◆ sample()

SampleResult precice::time::Storage::sample ( double time ) const

Need to use interpolation for the case with changing time grids.

Parameters

time	a double, where we want to sample the waveform

Returns: Eigen::VectorXd values in this Storage at or directly after "before"

Definition at line 198 of file Storage.cpp.

Here is the call graph for this function:

◆ sampleGradients()

Eigen::MatrixXd precice::time::Storage::sampleGradients ( double time ) const

Definition at line 228 of file Storage.cpp.

Here is the call graph for this function:

◆ setAllSamples()

void precice::time::Storage::setAllSamples ( const Sample & sample )

Overrides all existing samples.

This keeps time stamps, but overwrites all samples with a given one. Required in reinitialization

Parameters

sample new sample value

Definition at line 52 of file Storage.cpp.

Here is the call graph for this function:

◆ setInterpolationDegree()

void precice::time::Storage::setInterpolationDegree ( int interpolationDegree )

Definition at line 59 of file Storage.cpp.

◆ setSampleAtTime()

void precice::time::Storage::setSampleAtTime	(	double	time,
		const Sample &	sample )

Store Sample at a specific time.

It is only allowed to store a Sample in time that comes after a Sample that was already stored. Therefore, time has to be larger than maxStoredTime. The function trim() should be used before providing new samples.

Parameters

time	the time associated with the sample
sample	stored sample

Definition at line 27 of file Storage.cpp.

Here is the call graph for this function:

◆ stamples() [1/2]

auto precice::time::Storage::stamples ( )

inline

Definition at line 98 of file Storage.hpp.

◆ stamples() [2/2]

auto precice::time::Storage::stamples ( ) const

inline

Get the stamples.

Returns: boost range of stamples

Definition at line 93 of file Storage.hpp.

◆ trim()

void precice::time::Storage::trim ( )

Trims this Storage by deleting all values except values associated with the window start.

Definition at line 105 of file Storage.cpp.

◆ trimAfter()

void precice::time::Storage::trimAfter ( double time )

Definition at line 146 of file Storage.cpp.

Here is the call graph for this function:

◆ trimBefore()

void precice::time::Storage::trimBefore ( double time )

Definition at line 137 of file Storage.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _bspline

std::optional<math::Bspline> precice::time::Storage::_bspline

mutableprivate

Definition at line 167 of file Storage.hpp.

◆ _degree

int precice::time::Storage::_degree

private

Definition at line 165 of file Storage.hpp.

◆ _log

logging::Logger precice::time::Storage::_log {"time::Storage"}

mutableprivate

Definition at line 163 of file Storage.hpp.

◆ _stampleStorage

std::vector<Stample> precice::time::Storage::_stampleStorage

private

Stores Stamples on the current window.

Definition at line 161 of file Storage.hpp.

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

src/time/Storage.hpp
src/time/Storage.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Storage()

Member Function Documentation

◆ clear()

◆ clearExceptLast()

◆ computeUsedDegree()

◆ empty()

◆ getInterpolationDegree()

◆ getSampleAtEnd()

◆ getSampleAtOrAfter()

◆ getTimes()

◆ getTimesAndValues()

◆ last()

◆ maxStoredTime()

◆ move()

◆ nDofs()

◆ nTimes()

◆ operator=()

◆ sample()

◆ sampleGradients()

◆ setAllSamples()

◆ setInterpolationDegree()

◆ setSampleAtTime()

◆ stamples() [1/2]

◆ stamples() [2/2]

◆ trim()

◆ trimAfter()

◆ trimBefore()

Member Data Documentation

◆ _bspline

◆ _degree

◆ _log

◆ _stampleStorage