preCICE v3.1.1
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
precice::acceleration::ConstantRelaxationAcceleration Class Reference

#include <ConstantRelaxationAcceleration.hpp>

Inheritance diagram for precice::acceleration::ConstantRelaxationAcceleration:
[legend]
Collaboration diagram for precice::acceleration::ConstantRelaxationAcceleration:
[legend]

Public Member Functions

 ConstantRelaxationAcceleration (double relaxation, std::vector< int > dataIDs)
 
virtual std::vector< int > getDataIDs () const override
 
virtual void initialize (const DataMap &cplData) override
 
virtual void performAcceleration (DataMap &cplData) override
 
virtual void iterationsConverged (const DataMap &cplData) override
 
- Public Member Functions inherited from precice::acceleration::Acceleration
virtual ~Acceleration ()=default
 
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)
 

Private Attributes

logging::Logger _log {"acceleration::ConstantRelaxationAcceleration"}
 
double _relaxation
 
std::vector< int > _dataIDs
 

Additional Inherited Members

- Public Types inherited from precice::acceleration::Acceleration
using DataMap = std::map<int, cplscheme::PtrCouplingData>
 Map from data ID to data values.
 
- Static Public Attributes inherited from precice::acceleration::Acceleration
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 inherited from precice::acceleration::Acceleration
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 inherited from precice::acceleration::Acceleration
static void applyRelaxation (double omega, DataMap &cplData)
 performs a relaxation given a relaxation factor omega
 

Detailed Description

Definition at line 13 of file ConstantRelaxationAcceleration.hpp.

Constructor & Destructor Documentation

◆ ConstantRelaxationAcceleration()

precice::acceleration::ConstantRelaxationAcceleration::ConstantRelaxationAcceleration ( double relaxation,
std::vector< int > dataIDs )

Definition at line 15 of file ConstantRelaxationAcceleration.cpp.

Member Function Documentation

◆ getDataIDs()

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

◆ initialize()

void precice::acceleration::ConstantRelaxationAcceleration::initialize ( const DataMap & cplData)
overridevirtual

Implements precice::acceleration::Acceleration.

Definition at line 27 of file ConstantRelaxationAcceleration.cpp.

Here is the call graph for this function:

◆ iterationsConverged()

virtual void precice::acceleration::ConstantRelaxationAcceleration::iterationsConverged ( const DataMap & cplData)
inlineoverridevirtual

◆ performAcceleration()

void precice::acceleration::ConstantRelaxationAcceleration::performAcceleration ( DataMap & cplData)
overridevirtual

Implements precice::acceleration::Acceleration.

Definition at line 32 of file ConstantRelaxationAcceleration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _dataIDs

std::vector<int> precice::acceleration::ConstantRelaxationAcceleration::_dataIDs
private

Definition at line 37 of file ConstantRelaxationAcceleration.hpp.

◆ _log

logging::Logger precice::acceleration::ConstantRelaxationAcceleration::_log {"acceleration::ConstantRelaxationAcceleration"}
private

Definition at line 33 of file ConstantRelaxationAcceleration.hpp.

◆ _relaxation

double precice::acceleration::ConstantRelaxationAcceleration::_relaxation
private

Definition at line 35 of file ConstantRelaxationAcceleration.hpp.


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