Base Class for quasi-Newton acceleration schemes. More...

#include <BaseQNAcceleration.hpp>

Inheritance diagram for precice::acceleration::BaseQNAcceleration:

Collaboration diagram for precice::acceleration::BaseQNAcceleration:

Public Member Functions
	BaseQNAcceleration (double initialRelaxation, bool forceInitialRelaxation, int maxIterationsUsed, int timeWindowsReused, int filter, double singularityLimit, std::vector< int > dataIDs, OnBoundViolation onBoundViolation, impl::PtrPreconditioner preconditioner, bool reducedTimeGrid)
	~BaseQNAcceleration () override
	Destructor, empty.
std::vector< int >	getPrimaryDataIDs () const final override
	Returns all IQN involved data IDs.
void	initialize (const DataMap &cplData) final override
	Initializes the acceleration.
void	performAcceleration (DataMap &cplData, double windowStart, double windowEnd) final override
	Performs one acceleration step.
std::vector< DataID >	checkBoundViolation (Eigen::VectorXd &data, DataMap &cplData) const
	Check bound violations caused by performing QN update.
void	onBoundViolationsClamp (Eigen::VectorXd &data, DataMap &cplData, const std::vector< DataID > &violatingIDs)
	Handles bound violations after QN update by clamping.
void	onBoundViolationsScale (Eigen::VectorXd &data, DataMap &cplData, const std::vector< DataID > &violatingIDs, Eigen::VectorXd &xUpdate)
	Handles bound violations after QN update by scaling the QN step.
void	clampToBounds (Eigen::Map< Eigen::MatrixXd > &data, const std::vector< std::optional< double > > &lowerBound, const std::vector< std::optional< double > > &upperBound)
	Clamp data to their bounds.
double	computeShorteningFactor (Eigen::Map< Eigen::MatrixXd > &data, Eigen::Map< Eigen::MatrixXd > &update, const std::vector< std::optional< double > > &lowerBound, const std::vector< std::optional< double > > &upperBound)
	calculate the shortening factor to fit the violating data to the bounds
void	iterationsConverged (const DataMap &cplData, double windowStart) final override
	Marks a iteration sequence as converged.
void	exportState (io::TXTWriter &writer) final override
	Exports the current state of the acceleration to a file.
void	importState (io::TXTReader &reader) final override
	Imports the last exported state of the acceleration from file.
int	getDeletedColumns () const
	how many QN columns were deleted in this time window
int	getDroppedColumns () const
	how many QN columns were dropped (went out of scope) in this time window
int	getLSSystemCols () const
	: computes number of cols in least squares system, i.e, number of cols in _matrixV, _matrixW, _qrV, etc.. This is only necessary if some procs do not have any nodes on the coupling interface. In this case, the matrices are not constructed and we have no information about the number of cols. This info is needed for intra-participant communication. Number of its =! _cols in general.
int	getMaxUsedIterations () const
	Get the maximum number of reused iterations.
int	getMaxUsedTimeWindows () const
	Get the maximum number of reused time windows.
void	addLogEntries (io::TXTTableWriter &writer) const override
	Adds QN-specific columns to the iteration log file.
void	writeLogEntries (io::TXTTableWriter &writer) const override
	Writes QN-specific values to the iteration log columns.
Public Member Functions inherited from precice::acceleration::Acceleration
virtual	~Acceleration ()=default

Protected Member Functions
int	getLSSystemRows () const
int	getPrimaryLSSystemRows () const
virtual void	specializedIterationsConverged (const DataMap &cplData)=0
	Marks a iteration sequence as converged.
virtual void	updateDifferenceMatrices (const DataMap &cplData)
	Updates the V, W matrices (as well as the matrices for the secondary data)
virtual void	updateCouplingData (const DataMap &cplData, double windowStart)
	Splits up QN system vector back into the waveforms in coupling data.
virtual void	applyFilter ()
	Applies the filter method for the least-squares system, defined in the configuration.
virtual void	computeQNUpdate (Eigen::VectorXd &xUpdate)=0
	Computes the quasi-Newton update using the specified pp scheme (IQNIMVJ, IQNILS)
virtual void	removeMatrixColumn (int columnIndex)
	Removes one iteration from V,W matrices and adapts _matrixCols.
void	writeInfo (const std::string &s, bool allProcs=false)
	Writes info to the _infostream (also in parallel)
Protected Member Functions inherited from precice::acceleration::Acceleration
void	checkDataIDs (const DataMap &cplData) const
	Checks if all dataIDs are contained in cplData.

Protected Attributes
logging::Logger	_log {"acceleration::BaseQNAcceleration"}
impl::PtrPreconditioner	_preconditioner
	Preconditioner for least-squares system if vectorial system is used.
const double	_initialRelaxation
	Constant relaxation factor used for first iteration.
const int	_maxIterationsUsed
	Maximum number of old data iterations kept.
const int	_timeWindowsReused
	Maximum number of old time windows (with data values) kept.
const std::vector< int >	_primaryDataIDs
	Data IDs of primary data to be involved in the IQN coefficient computation.
std::vector< int >	_dataIDs
	Data IDs of all coupling data.
std::vector< DataID >	_idsWithBounds
	Data IDs of all coupling data that have bounds defined.
bool	_firstIteration = true
	Indicates the first iteration, where constant relaxation is used.
bool	_firstTimeWindow = true
bool	_hasNodesOnInterface = true
OnBoundViolation	_onBoundViolation
bool	_forceInitialRelaxation
bool	_resetLS = false
	If true, the LS system has been modified (reset or recomputed) in such a way, that mere updating of matrices _Wtil, Q, R etc.. is not feasible any more and need to be recomputed.
Eigen::VectorXd	_oldPrimaryXTilde
	Solver output regarding primary data from last iteration.
Eigen::VectorXd	_oldXTilde
	Solver output from last iteration.
Eigen::VectorXd	_primaryResiduals
	Current iteration residuals of primary IQN data. Temporary.
Eigen::VectorXd	_residuals
	Current iteration residuals of IQN data. Temporary.
Eigen::MatrixXd	_matrixV
	Stores residual deltas.
Eigen::MatrixXd	_matrixW
	Stores x tilde deltas, where x tilde are values computed by solvers.
const bool	_reducedTimeGrid
	if _reducedTimeGrid = false uses the full QN-WI and if _reducedTimeGrid = true uses rQN-WI form the paper https://onlinelibrary.wiley.com/doi/10.1002/nme.6443
impl::QRFactorization	_qrV
	Stores the current QR decomposition ov _matrixV, can be updated via deletion/insertion of columns.
const int	_filter
	filter method that is used to maintain good conditioning of the least-squares system Either of two types: QR1FILTER or QR2Filter
const double	_singularityLimit
	Determines sensitivity when two matrix columns are considered equal.
std::deque< int >	_matrixCols
	Indices (of columns in W, V matrices) of 1st iterations of time windows.
std::vector< int >	_dimOffsets
	Stores the local dimensions, i.e., the offsets in _invJacobian for all processors.
std::vector< int >	_dimOffsetsPrimary
	Stores the local dimensions regarding primary data,.
std::ostringstream	_infostringstream
	write some debug/acceleration info to file
std::fstream	_infostream
int	its = 0
int	tWindows = 0

Private Member Functions
void	initializeVectorsAndPreconditioner (const DataMap &cplData, double windowStart)
	Initializes the vectors, matrices and preconditioner This has to be done after the first iteration of the first time window, since everything in the QN-algorithm is sampled to the timegrid of the first waveform.
virtual void	specializedInitializeVectorsAndPreconditioner (const DataMap &cplData)=0
	handles the initialization of matrices and vectors in the sub-classes
void	concatenateCouplingData (Eigen::VectorXd &data, Eigen::VectorXd &oldData, const DataMap &cplData, std::vector< int > dataIDs, precice::time::TimeGrids timeGrids, double windowStart) const
	Samples and concatenates the data and old data in cplData into a long vector.

Private Attributes
std::optional< time::TimeGrids >	_timeGrids
	Stores the time grids to which the primary and secondary data involved in the QN system will be interpolated to.
std::optional< time::TimeGrids >	_primaryTimeGrids
	Stores the time grids to which the primary data involved in the QN system will be interpolated to. If _reducedTimeGrids is true then this will only contain the last time stamp of the time window, see https://doi.org/10.1002/nme.6443.
Eigen::VectorXd	_primaryValues
	Concatenation of all primary data involved in the QN system.
Eigen::VectorXd	_oldPrimaryValues
	Concatenation of all old primary data involved in the QN system.
Eigen::VectorXd	_oldPrimaryResiduals
	Difference between solver input and output from last time window regarding primary data.
Eigen::VectorXd	_values
	Concatenation of all primary and secondary data involved in the QN system.
Eigen::VectorXd	_oldValues
	Concatenation of all old primary and secondary data involved in the QN system.
Eigen::MatrixXd	_matrixVBackup
	backup of the V,W and matrixCols data structures. Needed for the skipping of initial relaxation, if previous time window converged within one iteration i.e., V and W are empty – in this case restore V and W with time window t-2.
Eigen::MatrixXd	_matrixWBackup
std::deque< int >	_matrixColsBackup
int	_nbDelCols = 0
	Number of filtered out columns in this time window.
int	_nbDropCols = 0
	Number of dropped columns in this time window (old time window out of scope)

Additional Inherited Members
Public Types inherited from precice::acceleration::Acceleration
enum struct	OnBoundViolation { Ignore , Clamp , Discard , ScaleToBound }
	Options for handling bound violations. More...
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
static const int	QR3FILTER = 5
Static Protected Member Functions inherited from precice::acceleration::Acceleration
static void	applyRelaxation (double omega, DataMap &cplData, double windowStart)
	performs a relaxation given a relaxation factor omega

Detailed Description

Base Class for quasi-Newton acceleration schemes.

Definition at line 64 of file BaseQNAcceleration.hpp.

Constructor & Destructor Documentation

◆ BaseQNAcceleration()

precice::acceleration::BaseQNAcceleration::BaseQNAcceleration	(	double	initialRelaxation,
		bool	forceInitialRelaxation,
		int	maxIterationsUsed,
		int	timeWindowsReused,
		int	filter,
		double	singularityLimit,
		std::vector< int >	dataIDs,
		OnBoundViolation	onBoundViolation,
		impl::PtrPreconditioner	preconditioner,
		bool	reducedTimeGrid )

Definition at line 35 of file BaseQNAcceleration.cpp.

◆ ~BaseQNAcceleration()

precice::acceleration::BaseQNAcceleration::~BaseQNAcceleration ( )

inlineoverride

Destructor, empty.

Definition at line 81 of file BaseQNAcceleration.hpp.

Member Function Documentation

◆ addLogEntries()

void precice::acceleration::BaseQNAcceleration::addLogEntries ( io::TXTTableWriter & writer ) const

overridevirtual

Adds QN-specific columns to the iteration log file.

Reimplemented from precice::acceleration::Acceleration.

Definition at line 947 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ applyFilter()

void precice::acceleration::BaseQNAcceleration::applyFilter ( )

protectedvirtual

Applies the filter method for the least-squares system, defined in the configuration.

Definition at line 559 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ checkBoundViolation()

std::vector< DataID > precice::acceleration::BaseQNAcceleration::checkBoundViolation	(	Eigen::VectorXd &	data,
		DataMap &	cplData ) const

Check bound violations caused by performing QN update.

Definition at line 117 of file BaseQNAcceleration.cpp.

◆ clampToBounds()

void precice::acceleration::BaseQNAcceleration::clampToBounds	(	Eigen::Map< Eigen::MatrixXd > &	data,
		const std::vector< std::optional< double > > &	lowerBound,
		const std::vector< std::optional< double > > &	upperBound )

Clamp data to their bounds.

Definition at line 225 of file BaseQNAcceleration.cpp.

◆ computeQNUpdate()

virtual void precice::acceleration::BaseQNAcceleration::computeQNUpdate ( Eigen::VectorXd & xUpdate )

protectedpure virtual

Computes the quasi-Newton update using the specified pp scheme (IQNIMVJ, IQNILS)

Implemented in precice::acceleration::IQNILSAcceleration, and precice::acceleration::IQNIMVJAcceleration.

◆ computeShorteningFactor()

double precice::acceleration::BaseQNAcceleration::computeShorteningFactor	(	Eigen::Map< Eigen::MatrixXd > &	data,
		Eigen::Map< Eigen::MatrixXd > &	update,
		const std::vector< std::optional< double > > &	lowerBound,
		const std::vector< std::optional< double > > &	upperBound )

calculate the shortening factor to fit the violating data to the bounds

Definition at line 237 of file BaseQNAcceleration.cpp.

◆ concatenateCouplingData()

void precice::acceleration::BaseQNAcceleration::concatenateCouplingData	(	Eigen::VectorXd &	data,
		Eigen::VectorXd &	oldData,
		const DataMap &	cplData,
		std::vector< int >	dataIDs,
		precice::time::TimeGrids	timeGrids,
		double	windowStart ) const

private

Samples and concatenates the data and old data in cplData into a long vector.

Definition at line 828 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ exportState()

void precice::acceleration::BaseQNAcceleration::exportState ( io::TXTWriter & writer )

finaloverridevirtual

Exports the current state of the acceleration to a file.

Reimplemented from precice::acceleration::Acceleration.

Definition at line 749 of file BaseQNAcceleration.cpp.

◆ getDeletedColumns()

int precice::acceleration::BaseQNAcceleration::getDeletedColumns ( ) const

how many QN columns were deleted in this time window

Definition at line 759 of file BaseQNAcceleration.cpp.

◆ getDroppedColumns()

int precice::acceleration::BaseQNAcceleration::getDroppedColumns ( ) const

how many QN columns were dropped (went out of scope) in this time window

Definition at line 764 of file BaseQNAcceleration.cpp.

◆ getLSSystemCols()

int precice::acceleration::BaseQNAcceleration::getLSSystemCols ( ) const

: computes number of cols in least squares system, i.e, number of cols in _matrixV, _matrixW, _qrV, etc.. This is only necessary if some procs do not have any nodes on the coupling interface. In this case, the matrices are not constructed and we have no information about the number of cols. This info is needed for intra-participant communication. Number of its =! _cols in general.

Definition at line 769 of file BaseQNAcceleration.cpp.

◆ getLSSystemRows()

int precice::acceleration::BaseQNAcceleration::getLSSystemRows ( ) const

protected

Definition at line 793 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ getMaxUsedIterations()

int precice::acceleration::BaseQNAcceleration::getMaxUsedIterations ( ) const

Get the maximum number of reused iterations.

Definition at line 783 of file BaseQNAcceleration.cpp.

◆ getMaxUsedTimeWindows()

int precice::acceleration::BaseQNAcceleration::getMaxUsedTimeWindows ( ) const

Get the maximum number of reused time windows.

Definition at line 788 of file BaseQNAcceleration.cpp.

◆ getPrimaryDataIDs()

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

inlinefinaloverridevirtual

Returns all IQN involved data IDs.

Implements precice::acceleration::Acceleration.

Definition at line 94 of file BaseQNAcceleration.hpp.

◆ getPrimaryLSSystemRows()

int precice::acceleration::BaseQNAcceleration::getPrimaryLSSystemRows ( ) const

protected

Definition at line 801 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ importState()

void precice::acceleration::BaseQNAcceleration::importState ( io::TXTReader & reader )

finaloverridevirtual

Imports the last exported state of the acceleration from file.

Is empty at the moment!!!

Reimplemented from precice::acceleration::Acceleration.

Definition at line 754 of file BaseQNAcceleration.cpp.

◆ initialize()

void precice::acceleration::BaseQNAcceleration::initialize ( const DataMap & cplData )

finaloverridevirtual

Initializes the acceleration.

: Initializes all the needed variables and data

initialize()

autotoc_md0

Implements precice::acceleration::Acceleration.

Definition at line 82 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ initializeVectorsAndPreconditioner()

void precice::acceleration::BaseQNAcceleration::initializeVectorsAndPreconditioner	(	const DataMap &	cplData,
		double	windowStart )

private

Initializes the vectors, matrices and preconditioner This has to be done after the first iteration of the first time window, since everything in the QN-algorithm is sampled to the timegrid of the first waveform.

make dimensions public to all procs, last entry _dimOffsets[IntraComm::getSize()] holds the global dimension, global,n

provide vertex offset information for all processors mesh->getVertexOffsets() provides an array that stores the number of mesh vertices on each processor This information needs to be gathered for all meshes. To get the number of respective unknowns of a specific processor we need to multiply the number of vertices with the dimensionality of the vector-valued data for each coupling data.

Definition at line 852 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ iterationsConverged()

void precice::acceleration::BaseQNAcceleration::iterationsConverged	(	const DataMap &	cplData,
		double	windowStart )

finaloverridevirtual

Marks a iteration sequence as converged.

: Is called when the convergence criterion for the coupling is fulfilled and finalizes the quasi Newton acceleration. Stores new differences in F and C, clears or

Since convergence measurements are done outside the acceleration, this method has to be used to signalize convergence to the acceleration.

iterationsConverged()

updates F and C according to the number of reused time windows

Sample all the data to the corresponding time grid in _timeGrids and concatenate everything into a long vector timeGrids are stored using std::optional, thus the .value() to get the actual object

pending deletion (after first iteration of next time window Using the matrices from the old time window for the first iteration is better than doing underrelaxation as first iteration of every time window

Implements precice::acceleration::Acceleration.

Definition at line 617 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ onBoundViolationsClamp()

void precice::acceleration::BaseQNAcceleration::onBoundViolationsClamp	(	Eigen::VectorXd &	data,
		DataMap &	cplData,
		const std::vector< DataID > &	violatingIDs )

Handles bound violations after QN update by clamping.

Definition at line 151 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ onBoundViolationsScale()

void precice::acceleration::BaseQNAcceleration::onBoundViolationsScale	(	Eigen::VectorXd &	data,
		DataMap &	cplData,
		const std::vector< DataID > &	violatingIDs,
		Eigen::VectorXd &	xUpdate )

Handles bound violations after QN update by scaling the QN step.

Definition at line 176 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ performAcceleration()

void precice::acceleration::BaseQNAcceleration::performAcceleration	(	DataMap &	cplData,
		double	windowStart,
		double	windowEnd )

finaloverridevirtual

Performs one acceleration step.

: performs one iteration of the quasi Newton acceleration.

Has to be called after every implicit coupling iteration.

performAcceleration()

autotoc_md2

Sample all the data to the corresponding time grid in _timeGrids and concatenate everything into a long vector timeGrids are stored using std::optional, thus the .value() to get the actual object

update the difference matrices V,W includes: scaling of values computation of residuals appending the difference matrices

=== update and apply preconditioner ===

The preconditioner is only applied to the matrix V and the columns that are inserted into the QR-decomposition of V.

compute quasi-Newton update PRECONDITION: All objects are unscaled, except the matrices within the QR-dec of V. Thus, the pseudo inverse needs to be reverted before using it.

Implements precice::acceleration::Acceleration.

Definition at line 364 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ removeMatrixColumn()

void precice::acceleration::BaseQNAcceleration::removeMatrixColumn ( int columnIndex )

protectedvirtual

Removes one iteration from V,W matrices and adapts _matrixCols.

: removes a column from the least squares system, i. e., from the matrices W and V

removeMatrixColumn()

autotoc_md4

Reimplemented in precice::acceleration::IQNILSAcceleration, and precice::acceleration::IQNIMVJAcceleration.

Definition at line 721 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ specializedInitializeVectorsAndPreconditioner()

virtual void precice::acceleration::BaseQNAcceleration::specializedInitializeVectorsAndPreconditioner ( const DataMap & cplData )

privatepure virtual

handles the initialization of matrices and vectors in the sub-classes

called by the initializeVectorsAndPreconditioner method in the BaseQNAcceleration class

Implemented in precice::acceleration::IQNILSAcceleration, and precice::acceleration::IQNIMVJAcceleration.

◆ specializedIterationsConverged()

virtual void precice::acceleration::BaseQNAcceleration::specializedIterationsConverged ( const DataMap & cplData )

protectedpure virtual

Marks a iteration sequence as converged.

called by the iterationsConverged() method in the BaseQNAcceleration class handles the acceleration specific action after the convergence of one iteration

Implemented in precice::acceleration::IQNILSAcceleration, and precice::acceleration::IQNIMVJAcceleration.

◆ updateCouplingData()

void precice::acceleration::BaseQNAcceleration::updateCouplingData	(	const DataMap &	cplData,
		double	windowStart )

protectedvirtual

Splits up QN system vector back into the waveforms in coupling data.

Definition at line 581 of file BaseQNAcceleration.cpp.

◆ updateDifferenceMatrices()

void precice::acceleration::BaseQNAcceleration::updateDifferenceMatrices ( const DataMap & cplData )

protectedvirtual

Updates the V, W matrices (as well as the matrices for the secondary data)

: computes the current residual and stores it, computes the differences and

updateDifferenceMatrices()

updates the difference matrices F and C.

Reimplemented in precice::acceleration::IQNILSAcceleration, and precice::acceleration::IQNIMVJAcceleration.

Definition at line 266 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ writeInfo()

void precice::acceleration::BaseQNAcceleration::writeInfo	(	const std::string &	s,
		bool	allProcs = false )

protected

Writes info to the _infostream (also in parallel)

Definition at line 809 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

◆ writeLogEntries()

void precice::acceleration::BaseQNAcceleration::writeLogEntries ( io::TXTTableWriter & writer ) const

overridevirtual

Writes QN-specific values to the iteration log columns.

Reimplemented from precice::acceleration::Acceleration.

Definition at line 954 of file BaseQNAcceleration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _dataIDs

std::vector<int> precice::acceleration::BaseQNAcceleration::_dataIDs

protected

Data IDs of all coupling data.

Definition at line 200 of file BaseQNAcceleration.hpp.

◆ _dimOffsets

std::vector<int> precice::acceleration::BaseQNAcceleration::_dimOffsets

protected

Stores the local dimensions, i.e., the offsets in _invJacobian for all processors.

Definition at line 280 of file BaseQNAcceleration.hpp.

◆ _dimOffsetsPrimary

std::vector<int> precice::acceleration::BaseQNAcceleration::_dimOffsetsPrimary

protected

Stores the local dimensions regarding primary data,.

Definition at line 284 of file BaseQNAcceleration.hpp.

◆ _filter

const int precice::acceleration::BaseQNAcceleration::_filter

protected

filter method that is used to maintain good conditioning of the least-squares system Either of two types: QR1FILTER or QR2Filter

Definition at line 258 of file BaseQNAcceleration.hpp.

◆ _firstIteration

bool precice::acceleration::BaseQNAcceleration::_firstIteration = true

protected

Indicates the first iteration, where constant relaxation is used.

Definition at line 206 of file BaseQNAcceleration.hpp.

◆ _firstTimeWindow

bool precice::acceleration::BaseQNAcceleration::_firstTimeWindow = true

protected

Definition at line 211 of file BaseQNAcceleration.hpp.

◆ _forceInitialRelaxation

bool precice::acceleration::BaseQNAcceleration::_forceInitialRelaxation

protected

Definition at line 224 of file BaseQNAcceleration.hpp.

◆ _hasNodesOnInterface

bool precice::acceleration::BaseQNAcceleration::_hasNodesOnInterface = true

protected

Definition at line 216 of file BaseQNAcceleration.hpp.

◆ _idsWithBounds

std::vector<DataID> precice::acceleration::BaseQNAcceleration::_idsWithBounds

protected

Data IDs of all coupling data that have bounds defined.

Definition at line 203 of file BaseQNAcceleration.hpp.

◆ _infostream

std::fstream precice::acceleration::BaseQNAcceleration::_infostream

protected

Definition at line 288 of file BaseQNAcceleration.hpp.

◆ _infostringstream

std::ostringstream precice::acceleration::BaseQNAcceleration::_infostringstream

protected

write some debug/acceleration info to file

Definition at line 287 of file BaseQNAcceleration.hpp.

◆ _initialRelaxation

const double precice::acceleration::BaseQNAcceleration::_initialRelaxation

protected

Constant relaxation factor used for first iteration.

Definition at line 188 of file BaseQNAcceleration.hpp.

◆ _log

logging::Logger precice::acceleration::BaseQNAcceleration::_log {"acceleration::BaseQNAcceleration"}

protected

Definition at line 182 of file BaseQNAcceleration.hpp.

◆ _matrixCols

std::deque<int> precice::acceleration::BaseQNAcceleration::_matrixCols

protected

Indices (of columns in W, V matrices) of 1st iterations of time windows.

When old time windows are reused (_timeWindowsReused > 0), the indices of the first iteration of each time window needs to be stored, such that, e.g., all iterations of the last time window, or one specific iteration that leads to a singular matrix in the QR decomposition can be removed and tracked.

Definition at line 275 of file BaseQNAcceleration.hpp.

◆ _matrixColsBackup

std::deque<int> precice::acceleration::BaseQNAcceleration::_matrixColsBackup

private

Definition at line 364 of file BaseQNAcceleration.hpp.

◆ _matrixV

Eigen::MatrixXd precice::acceleration::BaseQNAcceleration::_matrixV

protected

Stores residual deltas.

Definition at line 244 of file BaseQNAcceleration.hpp.

◆ _matrixVBackup

Eigen::MatrixXd precice::acceleration::BaseQNAcceleration::_matrixVBackup

private

backup of the V,W and matrixCols data structures. Needed for the skipping of initial relaxation, if previous time window converged within one iteration i.e., V and W are empty – in this case restore V and W with time window t-2.

Definition at line 362 of file BaseQNAcceleration.hpp.

◆ _matrixW

Eigen::MatrixXd precice::acceleration::BaseQNAcceleration::_matrixW

protected

Stores x tilde deltas, where x tilde are values computed by solvers.

Definition at line 247 of file BaseQNAcceleration.hpp.

◆ _matrixWBackup

Eigen::MatrixXd precice::acceleration::BaseQNAcceleration::_matrixWBackup

private

Definition at line 363 of file BaseQNAcceleration.hpp.

◆ _maxIterationsUsed

const int precice::acceleration::BaseQNAcceleration::_maxIterationsUsed

protected

Maximum number of old data iterations kept.

Definition at line 191 of file BaseQNAcceleration.hpp.

◆ _nbDelCols

int precice::acceleration::BaseQNAcceleration::_nbDelCols = 0

private

Number of filtered out columns in this time window.

Definition at line 367 of file BaseQNAcceleration.hpp.

◆ _nbDropCols

int precice::acceleration::BaseQNAcceleration::_nbDropCols = 0

private

Number of dropped columns in this time window (old time window out of scope)

Definition at line 370 of file BaseQNAcceleration.hpp.

◆ _oldPrimaryResiduals

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_oldPrimaryResiduals

private

Difference between solver input and output from last time window regarding primary data.

Definition at line 350 of file BaseQNAcceleration.hpp.

◆ _oldPrimaryValues

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_oldPrimaryValues

private

Concatenation of all old primary data involved in the QN system.

Definition at line 347 of file BaseQNAcceleration.hpp.

◆ _oldPrimaryXTilde

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_oldPrimaryXTilde

protected

Solver output regarding primary data from last iteration.

Definition at line 232 of file BaseQNAcceleration.hpp.

◆ _oldValues

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_oldValues

private

Concatenation of all old primary and secondary data involved in the QN system.

Definition at line 356 of file BaseQNAcceleration.hpp.

◆ _oldXTilde

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_oldXTilde

protected

Solver output from last iteration.

Definition at line 235 of file BaseQNAcceleration.hpp.

◆ _onBoundViolation

OnBoundViolation precice::acceleration::BaseQNAcceleration::_onBoundViolation

protected

Definition at line 218 of file BaseQNAcceleration.hpp.

◆ _preconditioner

impl::PtrPreconditioner precice::acceleration::BaseQNAcceleration::_preconditioner

protected

Preconditioner for least-squares system if vectorial system is used.

Definition at line 185 of file BaseQNAcceleration.hpp.

◆ _primaryDataIDs

const std::vector<int> precice::acceleration::BaseQNAcceleration::_primaryDataIDs

protected

Data IDs of primary data to be involved in the IQN coefficient computation.

Definition at line 197 of file BaseQNAcceleration.hpp.

◆ _primaryResiduals

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_primaryResiduals

protected

Current iteration residuals of primary IQN data. Temporary.

Definition at line 238 of file BaseQNAcceleration.hpp.

◆ _primaryTimeGrids

std::optional<time::TimeGrids> precice::acceleration::BaseQNAcceleration::_primaryTimeGrids

private

Stores the time grids to which the primary data involved in the QN system will be interpolated to. If _reducedTimeGrids is true then this will only contain the last time stamp of the time window, see https://doi.org/10.1002/nme.6443.

Definition at line 341 of file BaseQNAcceleration.hpp.

◆ _primaryValues

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_primaryValues

private

Concatenation of all primary data involved in the QN system.

Definition at line 344 of file BaseQNAcceleration.hpp.

◆ _qrV

impl::QRFactorization precice::acceleration::BaseQNAcceleration::_qrV

protected

Stores the current QR decomposition ov _matrixV, can be updated via deletion/insertion of columns.

Definition at line 253 of file BaseQNAcceleration.hpp.

◆ _reducedTimeGrid

const bool precice::acceleration::BaseQNAcceleration::_reducedTimeGrid

protected

if _reducedTimeGrid = false uses the full QN-WI and if _reducedTimeGrid = true uses rQN-WI form the paper https://onlinelibrary.wiley.com/doi/10.1002/nme.6443

Definition at line 250 of file BaseQNAcceleration.hpp.

◆ _resetLS

bool precice::acceleration::BaseQNAcceleration::_resetLS = false

protected

If true, the LS system has been modified (reset or recomputed) in such a way, that mere updating of matrices _Wtil, Q, R etc.. is not feasible any more and need to be recomputed.

Definition at line 229 of file BaseQNAcceleration.hpp.

◆ _residuals

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_residuals

protected

Current iteration residuals of IQN data. Temporary.

Definition at line 241 of file BaseQNAcceleration.hpp.

◆ _singularityLimit

const double precice::acceleration::BaseQNAcceleration::_singularityLimit

protected

Determines sensitivity when two matrix columns are considered equal.

When during the QR decomposition of the V matrix a pivot element smaller than the singularity limit is found, the matrix is considered to be singular and the corresponding (older) iteration is removed.

Definition at line 266 of file BaseQNAcceleration.hpp.

◆ _timeGrids

std::optional<time::TimeGrids> precice::acceleration::BaseQNAcceleration::_timeGrids

private

Stores the time grids to which the primary and secondary data involved in the QN system will be interpolated to.

Definition at line 337 of file BaseQNAcceleration.hpp.

◆ _timeWindowsReused

const int precice::acceleration::BaseQNAcceleration::_timeWindowsReused

protected

Maximum number of old time windows (with data values) kept.

Definition at line 194 of file BaseQNAcceleration.hpp.

◆ _values

Eigen::VectorXd precice::acceleration::BaseQNAcceleration::_values

private

Concatenation of all primary and secondary data involved in the QN system.

Definition at line 353 of file BaseQNAcceleration.hpp.

◆ its

int precice::acceleration::BaseQNAcceleration::its = 0

protected

Definition at line 319 of file BaseQNAcceleration.hpp.

◆ tWindows

int precice::acceleration::BaseQNAcceleration::tWindows = 0

protected

Definition at line 319 of file BaseQNAcceleration.hpp.

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

src/acceleration/BaseQNAcceleration.hpp
src/acceleration/BaseQNAcceleration.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseQNAcceleration()

◆ ~BaseQNAcceleration()

Member Function Documentation

◆ addLogEntries()

◆ applyFilter()

◆ checkBoundViolation()

◆ clampToBounds()

◆ computeQNUpdate()

◆ computeShorteningFactor()

◆ concatenateCouplingData()

◆ exportState()

◆ getDeletedColumns()

◆ getDroppedColumns()

◆ getLSSystemCols()

◆ getLSSystemRows()

◆ getMaxUsedIterations()

◆ getMaxUsedTimeWindows()

◆ getPrimaryDataIDs()

◆ getPrimaryLSSystemRows()

◆ importState()

◆ initialize()

autotoc_md0

◆ initializeVectorsAndPreconditioner()

◆ iterationsConverged()

updates F and C according to the number of reused time windows

◆ onBoundViolationsClamp()

◆ onBoundViolationsScale()

◆ performAcceleration()

autotoc_md2

◆ removeMatrixColumn()

autotoc_md4

◆ specializedInitializeVectorsAndPreconditioner()

◆ specializedIterationsConverged()

◆ updateCouplingData()

◆ updateDifferenceMatrices()

updates the difference matrices F and C.

◆ writeInfo()

◆ writeLogEntries()

Member Data Documentation

◆ _dataIDs

◆ _dimOffsets

◆ _dimOffsetsPrimary

◆ _filter

◆ _firstIteration

◆ _firstTimeWindow

◆ _forceInitialRelaxation

◆ _hasNodesOnInterface

◆ _idsWithBounds

◆ _infostream

◆ _infostringstream

◆ _initialRelaxation

◆ _log

◆ _matrixCols

◆ _matrixColsBackup

◆ _matrixV

◆ _matrixVBackup

◆ _matrixW

◆ _matrixWBackup

◆ _maxIterationsUsed

◆ _nbDelCols

◆ _nbDropCols

◆ _oldPrimaryResiduals

◆ _oldPrimaryValues

◆ _oldPrimaryXTilde

◆ _oldValues

◆ _oldXTilde

◆ _onBoundViolation

◆ _preconditioner

◆ _primaryDataIDs

◆ _primaryResiduals

◆ _primaryTimeGrids

◆ _primaryValues