Preconditioner that uses the values from the previous time window to scale the quasi-Newton system. More...

#include <ValuePreconditioner.hpp>

Inheritance diagram for precice::acceleration::impl::ValuePreconditioner:

Collaboration diagram for precice::acceleration::impl::ValuePreconditioner:

Public Member Functions
	ValuePreconditioner (int maxNonConstTimeWindows)
	~ValuePreconditioner () override=default
	Destructor, empty.
Public Member Functions inherited from precice::acceleration::impl::Preconditioner
	Preconditioner (int maxNonConstTimeWindows)
virtual	~Preconditioner ()=default
	Destructor, empty.
virtual void	initialize (std::vector< size_t > &svs)
	initialize the preconditioner
void	apply (Eigen::MatrixXd &M, bool transpose)
	Apply preconditioner to matrix.
void	revert (Eigen::MatrixXd &M, bool transpose)
	Apply inverse preconditioner to matrix.
void	apply (Eigen::MatrixXd &M)
	To transform physical values to balanced values. Matrix version.
void	apply (Eigen::VectorXd &v)
	To transform physical values to balanced values. Vector version.
void	revert (Eigen::MatrixXd &M)
	To transform balanced values back to physical values. Matrix version.
void	revert (Eigen::VectorXd &v)
	To transform balanced values back to physical values. Vector version.
void	update (bool timeWindowComplete, const Eigen::VectorXd &oldValues, const Eigen::VectorXd &res)
	Update the scaling after every FSI iteration and require a new QR decomposition (if necessary)
bool	requireNewQR ()
	returns true if a QR decomposition from scratch is necessary
void	newQRfulfilled ()
	to tell the preconditioner that QR-decomposition has been recomputed
std::vector< double > &	getWeights ()
bool	isConst ()

Private Member Functions
void	_update_ (bool timeWindowComplete, const Eigen::VectorXd &oldValues, const Eigen::VectorXd &res) override
	Update the scaling after every FSI iteration.

Private Attributes
logging::Logger	_log {"acceleration::ValuePreconditioner"}
bool	_firstTimeWindow = true

Additional Inherited Members
Protected Attributes inherited from precice::acceleration::impl::Preconditioner
std::vector< double >	_weights
	Weights used to scale the matrix V and the residual.
std::vector< double >	_invWeights
	Inverse weights (for efficiency reasons)
std::vector< size_t >	_subVectorSizes
	Sizes of each sub-vector, i.e. each coupling data.
int	_maxNonConstTimeWindows
	maximum number of non-const time windows, i.e., after this number of time windows, the preconditioner is frozen with the current weights and becomes a constant preconditioner
int	_nbNonConstTimeWindows = 0
	Counts the number of completed time windows with a non-const weighting.
bool	_requireNewQR = false
	True if a QR decomposition from scratch is necessary.
bool	_frozen = false
	True if _nbNonConstTimeWindows >= _maxNonConstTimeWindows, i.e., preconditioner is not updated any more.

Detailed Description

Preconditioner that uses the values from the previous time window to scale the quasi-Newton system.

Definition at line 11 of file ValuePreconditioner.hpp.

Constructor & Destructor Documentation

◆ ValuePreconditioner()

precice::acceleration::impl::ValuePreconditioner::ValuePreconditioner ( int maxNonConstTimeWindows )

Definition at line 10 of file ValuePreconditioner.cpp.

Here is the call graph for this function:

◆ ~ValuePreconditioner()

precice::acceleration::impl::ValuePreconditioner::~ValuePreconditioner ( )

overridedefault

Destructor, empty.

Member Function Documentation

◆ _update_()

void precice::acceleration::impl::ValuePreconditioner::_update_	(	bool	timeWindowComplete,
		const Eigen::VectorXd &	oldValues,
		const Eigen::VectorXd &	res )

overrideprivatevirtual

Update the scaling after every FSI iteration.

Parameters

[in] timeWindowComplete True if this FSI iteration also completed a time window

Implements precice::acceleration::impl::Preconditioner.

Definition at line 16 of file ValuePreconditioner.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _firstTimeWindow

bool precice::acceleration::impl::ValuePreconditioner::_firstTimeWindow = true

private

Definition at line 30 of file ValuePreconditioner.hpp.

◆ _log

logging::Logger precice::acceleration::impl::ValuePreconditioner::_log {"acceleration::ValuePreconditioner"}

private

Definition at line 21 of file ValuePreconditioner.hpp.

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

src/acceleration/impl/ValuePreconditioner.hpp
src/acceleration/impl/ValuePreconditioner.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members