precice::acceleration::Acceleration Class Reference

#include <Acceleration.hpp>

Inheritance diagram for precice::acceleration::Acceleration:

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

Public Member Functions
virtual	~Acceleration ()=default
virtual std::vector< int >	getDataIDs () const =0
virtual void	initialize (const DataMap &cpldata)=0
virtual void	performAcceleration (DataMap &cpldata)=0
virtual void	iterationsConverged (const DataMap &cpldata)=0
virtual void	exportState (io::TXTWriter &writer)
virtual void	importState (io::TXTReader &reader)
virtual int	getDeletedColumns () const
	Gives the number of QN columns that where filtered out (i.e. deleted) in this time window.
virtual int	getDroppedColumns () const
	Gives the number of QN columns that went out of scope in this time window.
virtual int	getLSSystemCols () const
	Gives the number of current QN columns (LS = least squares)

Static Public Attributes
static const int	NOFILTER = 0
static const int	QR1FILTER = 1
static const int	QR1FILTER_ABS = 2
static const int	QR2FILTER = 3
static const int	PODFILTER = 4

Protected Member Functions
void	checkDataIDs (const DataMap &cplData) const
	Checks if all dataIDs are contained in cplData.
void	concatenateCouplingData (const DataMap &cplData, const std::vector< DataID > &dataIDs, Eigen::VectorXd &targetValues, Eigen::VectorXd &targetOldValues) const
	Concatenates all coupling data involved into a single vector.

Static Protected Member Functions
static void	applyRelaxation (double omega, DataMap &cplData)
	performs a relaxation given a relaxation factor omega

Detailed Description

Definition at line 20 of file Acceleration.hpp.

Member Typedef Documentation

DataMap

using precice::acceleration::Acceleration::DataMap = std::map<int, cplscheme::PtrCouplingData>

Map from data ID to data values.

Definition at line 29 of file Acceleration.hpp.

Constructor & Destructor Documentation

~Acceleration()

virtual precice::acceleration::Acceleration::~Acceleration ( )

virtualdefault

Member Function Documentation

applyRelaxation()

void precice::acceleration::Acceleration::applyRelaxation ( double omega, DataMap & cplData )

staticprotected

performs a relaxation given a relaxation factor omega

Definition at line 17 of file Acceleration.cpp.

checkDataIDs()

void precice::acceleration::Acceleration::checkDataIDs ( const DataMap & cplData ) const

protected

Checks if all dataIDs are contained in cplData.

Definition at line 7 of file Acceleration.cpp.

Here is the call graph for this function:

concatenateCouplingData()

void precice::acceleration::Acceleration::concatenateCouplingData ( const DataMap & cplData, const std::vector< DataID > & dataIDs, Eigen::VectorXd & targetValues, Eigen::VectorXd & targetOldValues ) const

protected

Concatenates all coupling data involved into a single vector.

Definition at line 46 of file Acceleration.cpp.

Here is the call graph for this function:

exportState()

virtual void precice::acceleration::Acceleration::exportState ( io::TXTWriter & writer )

inlinevirtual

Reimplemented in precice::acceleration::BaseQNAcceleration.

Definition at line 41 of file Acceleration.hpp.

getDataIDs()

virtual std::vector< int > precice::acceleration::Acceleration::getDataIDs ( ) const

pure virtual

Implemented in precice::acceleration::AitkenAcceleration, precice::acceleration::BaseQNAcceleration, and precice::acceleration::ConstantRelaxationAcceleration.

getDeletedColumns()

virtual int precice::acceleration::Acceleration::getDeletedColumns ( ) const

inlinevirtual

Gives the number of QN columns that where filtered out (i.e. deleted) in this time window.

Reimplemented in precice::acceleration::BaseQNAcceleration.

Definition at line 46 of file Acceleration.hpp.

getDroppedColumns()

virtual int precice::acceleration::Acceleration::getDroppedColumns ( ) const

inlinevirtual

Gives the number of QN columns that went out of scope in this time window.

Reimplemented in precice::acceleration::BaseQNAcceleration.

Definition at line 52 of file Acceleration.hpp.

getLSSystemCols()

virtual int precice::acceleration::Acceleration::getLSSystemCols ( ) const

inlinevirtual

Gives the number of current QN columns (LS = least squares)

Reimplemented in precice::acceleration::BaseQNAcceleration.

Definition at line 58 of file Acceleration.hpp.

importState()

virtual void precice::acceleration::Acceleration::importState ( io::TXTReader & reader )

inlinevirtual

Reimplemented in precice::acceleration::BaseQNAcceleration.

Definition at line 43 of file Acceleration.hpp.

initialize()

virtual void precice::acceleration::Acceleration::initialize ( const DataMap & cpldata )

pure virtual

Implemented in precice::acceleration::AitkenAcceleration, precice::acceleration::BaseQNAcceleration, precice::acceleration::IQNILSAcceleration, precice::acceleration::IQNIMVJAcceleration, and precice::acceleration::ConstantRelaxationAcceleration.

iterationsConverged()

virtual void precice::acceleration::Acceleration::iterationsConverged ( const DataMap & cpldata )

pure virtual

Implemented in precice::acceleration::AitkenAcceleration, precice::acceleration::BaseQNAcceleration, and precice::acceleration::ConstantRelaxationAcceleration.

performAcceleration()

virtual void precice::acceleration::Acceleration::performAcceleration ( DataMap & cpldata )

pure virtual

Implemented in precice::acceleration::AitkenAcceleration, precice::acceleration::BaseQNAcceleration, and precice::acceleration::ConstantRelaxationAcceleration.

Member Data Documentation

NOFILTER

const int precice::acceleration::Acceleration::NOFILTER = 0

static

Definition at line 22 of file Acceleration.hpp.

PODFILTER

const int precice::acceleration::Acceleration::PODFILTER = 4

static

Definition at line 26 of file Acceleration.hpp.

QR1FILTER

const int precice::acceleration::Acceleration::QR1FILTER = 1

static

Definition at line 23 of file Acceleration.hpp.

QR1FILTER_ABS

const int precice::acceleration::Acceleration::QR1FILTER_ABS = 2

static

Definition at line 24 of file Acceleration.hpp.

QR2FILTER

const int precice::acceleration::Acceleration::QR2FILTER = 3

static

Definition at line 25 of file Acceleration.hpp.

---

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

• src/acceleration/Acceleration.hpp
• src/acceleration/Acceleration.cpp