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 >	getPrimaryDataIDs () const =0
virtual void	initialize (const DataMap &cpldata)=0
virtual void	performAcceleration (DataMap &cpldata, double windowStart, double windowEnd)=0
virtual void	iterationsConverged (const DataMap &cpldata, double windowStart)=0
virtual void	exportState (io::TXTWriter &writer)
virtual void	importState (io::TXTReader &reader)

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
static const int	QR3FILTER = 5

Protected Member Functions
void	checkDataIDs (const DataMap &cplData) const
	Checks if all dataIDs are contained in cplData.

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

Detailed Description

Definition at line 17 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 27 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, double windowStart )

staticprotected

performs a relaxation given a relaxation factor omega

Definition at line 17 of file Acceleration.cpp.

Here is the call graph for this function:

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:

exportState()

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

inlinevirtual

Reimplemented in precice::acceleration::BaseQNAcceleration.

Definition at line 39 of file Acceleration.hpp.

getPrimaryDataIDs()

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

pure virtual

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

importState()

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

inlinevirtual

Reimplemented in precice::acceleration::BaseQNAcceleration.

Definition at line 41 of file Acceleration.hpp.

initialize()

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

pure virtual

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

iterationsConverged()

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

pure virtual

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

performAcceleration()

virtual void precice::acceleration::Acceleration::performAcceleration ( DataMap & cpldata, double windowStart, double windowEnd )

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 19 of file Acceleration.hpp.

PODFILTER

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

static

Definition at line 23 of file Acceleration.hpp.

QR1FILTER

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

static

Definition at line 20 of file Acceleration.hpp.

QR1FILTER_ABS

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

static

Definition at line 21 of file Acceleration.hpp.

QR2FILTER

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

static

Definition at line 22 of file Acceleration.hpp.

QR3FILTER

const int precice::acceleration::Acceleration::QR3FILTER = 5

static

Definition at line 24 of file Acceleration.hpp.

---

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

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