precice::time::TimeGrids Class Reference

Interface for storing the time grids in the Quasi-Newton and Aitken methods. A time grid is a ordered vector containing the time stamps from the samples in the waveform of the coupled data. More...

#include <TimeGrids.hpp>

Collaboration diagram for precice::time::TimeGrids:

Public Types
using	DataMap = std::map<int, cplscheme::PtrCouplingData>
	Map from data ID to data values.

Public Member Functions
	TimeGrids (const DataMap &cplData, std::vector< int > dataIDs, bool reduced)
	saves the current time grid of the couplig data
Eigen::VectorXd	getTimeGridAfter (int dataID, double time) const
void	moveTimeGridToNewWindow (const DataMap &cplData)

Private Attributes
logging::Logger	_log {"acceleration::WaveformTimeGrids"}
std::map< int, Eigen::VectorXd >	_timeGrids
	List of the time grid to which all the data will be interpolated to Stored in a map, since each data entry has its own time grid.

Detailed Description

Interface for storing the time grids in the Quasi-Newton and Aitken methods. A time grid is a ordered vector containing the time stamps from the samples in the waveform of the coupled data.

Definition at line 21 of file TimeGrids.hpp.

Member Typedef Documentation

DataMap

using precice::time::TimeGrids::DataMap = std::map<int, cplscheme::PtrCouplingData>

Map from data ID to data values.

Definition at line 24 of file TimeGrids.hpp.

Constructor & Destructor Documentation

TimeGrids()

precice::time::TimeGrids::TimeGrids	(	const DataMap &	cplData,
		std::vector< int >	dataIDs,
		bool	reduced )

saves the current time grid of the couplig data

Parameters

cplData
dataIDs	of which time grids we want to save
reduced	if true then only the last timestep is saved in the timeGrid otherwise all timesteps are saved in the time grid This is used in the Quasi-Newton method to toggle between the full and reduced variant detailed here

Definition at line 11 of file TimeGrids.cpp.

Here is the call graph for this function:

Member Function Documentation

getTimeGridAfter()

Eigen::VectorXd precice::time::TimeGrids::getTimeGridAfter	(	int	dataID,
		double	time ) const

Definition at line 23 of file TimeGrids.cpp.

Here is the call graph for this function:

moveTimeGridToNewWindow()

void precice::time::TimeGrids::moveTimeGridToNewWindow

(

const DataMap &

cplData

)

Definition at line 37 of file TimeGrids.cpp.

Here is the call graph for this function:

Member Data Documentation

_log

logging::Logger precice::time::TimeGrids::_log {"acceleration::WaveformTimeGrids"}

private

Definition at line 42 of file TimeGrids.hpp.

_timeGrids

std::map<int, Eigen::VectorXd> precice::time::TimeGrids::_timeGrids

private

List of the time grid to which all the data will be interpolated to Stored in a map, since each data entry has its own time grid.

Definition at line 46 of file TimeGrids.hpp.

---

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

• src/time/TimeGrids.hpp
• src/time/TimeGrids.cpp