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

#include <AccelerationConfiguration.hpp>

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

Classes

struct  ConfigurationData
struct  DefaultValuesIMVJ
struct  DefaultValuesIQN
struct  UserDefinitions

Public Member Functions

 AccelerationConfiguration (const mesh::PtrMeshConfiguration &meshConfig)
PtrAcceleration getAcceleration ()
 Returns the configured coupling scheme.
void xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
 Callback method required when using xml::XMLTag.
void xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
 Callback method required when using xml::XMLTag.
void clear ()
 Removes configured acceleration.
void connectTags (xml::XMLTag &tag)
 Connect tags.
std::vector< std::string > & getNeededMeshes ()
Public Member Functions inherited from precice::xml::XMLTag::Listener
Listener & operator= (Listener &&)=delete
virtual ~Listener ()=default

Private Member Functions

void addTypeSpecificSubtags (xml::XMLTag &tag)
void addCommonIQNSubtags (xml::XMLTag &tag)

Private Attributes

logging::Logger _log {"acceleration::AccelerationConfiguration"}
const std::string TAG
const std::string TAG_RELAX
const std::string TAG_INIT_RELAX
const std::string TAG_MAX_USED_ITERATIONS
const std::string TAG_TIME_WINDOWS_REUSED
const std::string TAG_DATA
const std::string TAG_FILTER
const std::string TAG_ESTIMATEJACOBIAN
const std::string TAG_PRECONDITIONER
const std::string TAG_IMVJRESTART
const std::string ATTR_NAME
const std::string ATTR_MESH
const std::string ATTR_SCALING
const std::string ATTR_VALUE
const std::string ATTR_ENFORCE
const std::string ATTR_SINGULARITYLIMIT
const std::string ATTR_TYPE
const std::string ATTR_BUILDJACOBIAN
const std::string ATTR_REDUCEDTIMEGRIDQN
const std::string ATTR_IMVJCHUNKSIZE
const std::string ATTR_RSLS_REUSED_TIME_WINDOWS
const std::string ATTR_RSSVD_TRUNCATIONEPS
const std::string ATTR_PRECOND_NONCONST_TIME_WINDOWS
const std::string ATTR_PRECOND_UPDATE_ON_THRESHOLD
const std::string VALUE_CONSTANT
const std::string VALUE_AITKEN
const std::string VALUE_IQNILS
const std::string VALUE_IQNIMVJ
const std::string VALUE_QR1FILTER
const std::string VALUE_QR1_ABSFILTER
const std::string VALUE_QR2FILTER
const std::string VALUE_QR3FILTER
const std::string VALUE_CONSTANT_PRECONDITIONER
const std::string VALUE_VALUE_PRECONDITIONER
const std::string VALUE_RESIDUAL_PRECONDITIONER
const std::string VALUE_RESIDUAL_SUM_PRECONDITIONER
const std::string VALUE_LS_RESTART
const std::string VALUE_ZERO_RESTART
const std::string VALUE_SVD_RESTART
const std::string VALUE_SLIDE_RESTART
const std::string VALUE_NO_RESTART
const mesh::PtrMeshConfiguration _meshConfig
std::string _meshName
PtrAcceleration _acceleration
std::vector< std::string > _neededMeshes
impl::PtrPreconditioner _preconditioner
std::set< std::pair< std::string, std::string > > _uniqueDataAndMeshNames
struct precice::acceleration::AccelerationConfiguration::ConfigurationData _config
const struct precice::acceleration::AccelerationConfiguration::DefaultValuesIQN _defaultValuesIQNILS
const struct precice::acceleration::AccelerationConfiguration::DefaultValuesIMVJ _defaultValuesIQNIMVJ
const double _defaultAitkenRelaxationFactor = 0.5
struct precice::acceleration::AccelerationConfiguration::UserDefinitions _userDefinitions

Detailed Description

Definition at line 17 of file AccelerationConfiguration.hpp.

Constructor & Destructor Documentation

◆ AccelerationConfiguration()

precice::acceleration::AccelerationConfiguration::AccelerationConfiguration ( const mesh::PtrMeshConfiguration & meshConfig)

Definition at line 31 of file AccelerationConfiguration.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ addCommonIQNSubtags()

void precice::acceleration::AccelerationConfiguration::addCommonIQNSubtags ( xml::XMLTag & tag)
private

Definition at line 361 of file AccelerationConfiguration.cpp.

Here is the call graph for this function:

◆ addTypeSpecificSubtags()

void precice::acceleration::AccelerationConfiguration::addTypeSpecificSubtags ( xml::XMLTag & tag)
private

Definition at line 404 of file AccelerationConfiguration.cpp.

Here is the call graph for this function:

◆ clear()

void precice::acceleration::AccelerationConfiguration::clear ( )

Removes configured acceleration.

Definition at line 353 of file AccelerationConfiguration.cpp.

◆ connectTags()

void precice::acceleration::AccelerationConfiguration::connectTags ( xml::XMLTag & tag)

Connect tags.

Definition at line 83 of file AccelerationConfiguration.cpp.

Here is the call graph for this function:

◆ getAcceleration()

PtrAcceleration precice::acceleration::AccelerationConfiguration::getAcceleration ( )

Returns the configured coupling scheme.

Definition at line 138 of file AccelerationConfiguration.cpp.

◆ getNeededMeshes()

std::vector< std::string > & precice::acceleration::AccelerationConfiguration::getNeededMeshes ( )
inline

Definition at line 36 of file AccelerationConfiguration.hpp.

◆ xmlEndTagCallback()

void precice::acceleration::AccelerationConfiguration::xmlEndTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & callingTag )
overridevirtual

Callback method required when using xml::XMLTag.

Implements precice::xml::XMLTag::Listener.

Definition at line 249 of file AccelerationConfiguration.cpp.

Here is the call graph for this function:

◆ xmlTagCallback()

void precice::acceleration::AccelerationConfiguration::xmlTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & callingTag )
overridevirtual

Callback method required when using xml::XMLTag.

Implements precice::xml::XMLTag::Listener.

Definition at line 143 of file AccelerationConfiguration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _acceleration

PtrAcceleration precice::acceleration::AccelerationConfiguration::_acceleration
private

Definition at line 93 of file AccelerationConfiguration.hpp.

◆ _config

struct precice::acceleration::AccelerationConfiguration::ConfigurationData precice::acceleration::AccelerationConfiguration::_config
private

◆ _defaultAitkenRelaxationFactor

const double precice::acceleration::AccelerationConfiguration::_defaultAitkenRelaxationFactor = 0.5
private

Definition at line 150 of file AccelerationConfiguration.hpp.

◆ _defaultValuesIQNILS

const struct precice::acceleration::AccelerationConfiguration::DefaultValuesIQN precice::acceleration::AccelerationConfiguration::_defaultValuesIQNILS
private

◆ _defaultValuesIQNIMVJ

const struct precice::acceleration::AccelerationConfiguration::DefaultValuesIMVJ precice::acceleration::AccelerationConfiguration::_defaultValuesIQNIMVJ
private

◆ _log

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

Definition at line 42 of file AccelerationConfiguration.hpp.

◆ _meshConfig

const mesh::PtrMeshConfiguration precice::acceleration::AccelerationConfiguration::_meshConfig
private

Definition at line 88 of file AccelerationConfiguration.hpp.

◆ _meshName

std::string precice::acceleration::AccelerationConfiguration::_meshName
private

Definition at line 90 of file AccelerationConfiguration.hpp.

◆ _neededMeshes

std::vector<std::string> precice::acceleration::AccelerationConfiguration::_neededMeshes
private

Definition at line 95 of file AccelerationConfiguration.hpp.

◆ _preconditioner

impl::PtrPreconditioner precice::acceleration::AccelerationConfiguration::_preconditioner
private

Definition at line 97 of file AccelerationConfiguration.hpp.

◆ _uniqueDataAndMeshNames

std::set<std::pair<std::string, std::string> > precice::acceleration::AccelerationConfiguration::_uniqueDataAndMeshNames
private

Definition at line 99 of file AccelerationConfiguration.hpp.

◆ _userDefinitions

struct precice::acceleration::AccelerationConfiguration::UserDefinitions precice::acceleration::AccelerationConfiguration::_userDefinitions
private

◆ ATTR_BUILDJACOBIAN

const std::string precice::acceleration::AccelerationConfiguration::ATTR_BUILDJACOBIAN
private

Definition at line 62 of file AccelerationConfiguration.hpp.

◆ ATTR_ENFORCE

const std::string precice::acceleration::AccelerationConfiguration::ATTR_ENFORCE
private

Definition at line 59 of file AccelerationConfiguration.hpp.

◆ ATTR_IMVJCHUNKSIZE

const std::string precice::acceleration::AccelerationConfiguration::ATTR_IMVJCHUNKSIZE
private

Definition at line 64 of file AccelerationConfiguration.hpp.

◆ ATTR_MESH

const std::string precice::acceleration::AccelerationConfiguration::ATTR_MESH
private

Definition at line 56 of file AccelerationConfiguration.hpp.

◆ ATTR_NAME

const std::string precice::acceleration::AccelerationConfiguration::ATTR_NAME
private

Definition at line 55 of file AccelerationConfiguration.hpp.

◆ ATTR_PRECOND_NONCONST_TIME_WINDOWS

const std::string precice::acceleration::AccelerationConfiguration::ATTR_PRECOND_NONCONST_TIME_WINDOWS
private

Definition at line 67 of file AccelerationConfiguration.hpp.

◆ ATTR_PRECOND_UPDATE_ON_THRESHOLD

const std::string precice::acceleration::AccelerationConfiguration::ATTR_PRECOND_UPDATE_ON_THRESHOLD
private

Definition at line 68 of file AccelerationConfiguration.hpp.

◆ ATTR_REDUCEDTIMEGRIDQN

const std::string precice::acceleration::AccelerationConfiguration::ATTR_REDUCEDTIMEGRIDQN
private

Definition at line 63 of file AccelerationConfiguration.hpp.

◆ ATTR_RSLS_REUSED_TIME_WINDOWS

const std::string precice::acceleration::AccelerationConfiguration::ATTR_RSLS_REUSED_TIME_WINDOWS
private

Definition at line 65 of file AccelerationConfiguration.hpp.

◆ ATTR_RSSVD_TRUNCATIONEPS

const std::string precice::acceleration::AccelerationConfiguration::ATTR_RSSVD_TRUNCATIONEPS
private

Definition at line 66 of file AccelerationConfiguration.hpp.

◆ ATTR_SCALING

const std::string precice::acceleration::AccelerationConfiguration::ATTR_SCALING
private

Definition at line 57 of file AccelerationConfiguration.hpp.

◆ ATTR_SINGULARITYLIMIT

const std::string precice::acceleration::AccelerationConfiguration::ATTR_SINGULARITYLIMIT
private

Definition at line 60 of file AccelerationConfiguration.hpp.

◆ ATTR_TYPE

const std::string precice::acceleration::AccelerationConfiguration::ATTR_TYPE
private

Definition at line 61 of file AccelerationConfiguration.hpp.

◆ ATTR_VALUE

const std::string precice::acceleration::AccelerationConfiguration::ATTR_VALUE
private

Definition at line 58 of file AccelerationConfiguration.hpp.

◆ TAG

const std::string precice::acceleration::AccelerationConfiguration::TAG
private

Definition at line 44 of file AccelerationConfiguration.hpp.

◆ TAG_DATA

const std::string precice::acceleration::AccelerationConfiguration::TAG_DATA
private

Definition at line 49 of file AccelerationConfiguration.hpp.

◆ TAG_ESTIMATEJACOBIAN

const std::string precice::acceleration::AccelerationConfiguration::TAG_ESTIMATEJACOBIAN
private

Definition at line 51 of file AccelerationConfiguration.hpp.

◆ TAG_FILTER

const std::string precice::acceleration::AccelerationConfiguration::TAG_FILTER
private

Definition at line 50 of file AccelerationConfiguration.hpp.

◆ TAG_IMVJRESTART

const std::string precice::acceleration::AccelerationConfiguration::TAG_IMVJRESTART
private

Definition at line 53 of file AccelerationConfiguration.hpp.

◆ TAG_INIT_RELAX

const std::string precice::acceleration::AccelerationConfiguration::TAG_INIT_RELAX
private

Definition at line 46 of file AccelerationConfiguration.hpp.

◆ TAG_MAX_USED_ITERATIONS

const std::string precice::acceleration::AccelerationConfiguration::TAG_MAX_USED_ITERATIONS
private

Definition at line 47 of file AccelerationConfiguration.hpp.

◆ TAG_PRECONDITIONER

const std::string precice::acceleration::AccelerationConfiguration::TAG_PRECONDITIONER
private

Definition at line 52 of file AccelerationConfiguration.hpp.

◆ TAG_RELAX

const std::string precice::acceleration::AccelerationConfiguration::TAG_RELAX
private

Definition at line 45 of file AccelerationConfiguration.hpp.

◆ TAG_TIME_WINDOWS_REUSED

const std::string precice::acceleration::AccelerationConfiguration::TAG_TIME_WINDOWS_REUSED
private

Definition at line 48 of file AccelerationConfiguration.hpp.

◆ VALUE_AITKEN

const std::string precice::acceleration::AccelerationConfiguration::VALUE_AITKEN
private

Definition at line 71 of file AccelerationConfiguration.hpp.

◆ VALUE_CONSTANT

const std::string precice::acceleration::AccelerationConfiguration::VALUE_CONSTANT
private

Definition at line 70 of file AccelerationConfiguration.hpp.

◆ VALUE_CONSTANT_PRECONDITIONER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_CONSTANT_PRECONDITIONER
private

Definition at line 78 of file AccelerationConfiguration.hpp.

◆ VALUE_IQNILS

const std::string precice::acceleration::AccelerationConfiguration::VALUE_IQNILS
private

Definition at line 72 of file AccelerationConfiguration.hpp.

◆ VALUE_IQNIMVJ

const std::string precice::acceleration::AccelerationConfiguration::VALUE_IQNIMVJ
private

Definition at line 73 of file AccelerationConfiguration.hpp.

◆ VALUE_LS_RESTART

const std::string precice::acceleration::AccelerationConfiguration::VALUE_LS_RESTART
private

Definition at line 82 of file AccelerationConfiguration.hpp.

◆ VALUE_NO_RESTART

const std::string precice::acceleration::AccelerationConfiguration::VALUE_NO_RESTART
private

Definition at line 86 of file AccelerationConfiguration.hpp.

◆ VALUE_QR1_ABSFILTER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_QR1_ABSFILTER
private

Definition at line 75 of file AccelerationConfiguration.hpp.

◆ VALUE_QR1FILTER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_QR1FILTER
private

Definition at line 74 of file AccelerationConfiguration.hpp.

◆ VALUE_QR2FILTER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_QR2FILTER
private

Definition at line 76 of file AccelerationConfiguration.hpp.

◆ VALUE_QR3FILTER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_QR3FILTER
private

Definition at line 77 of file AccelerationConfiguration.hpp.

◆ VALUE_RESIDUAL_PRECONDITIONER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_RESIDUAL_PRECONDITIONER
private

Definition at line 80 of file AccelerationConfiguration.hpp.

◆ VALUE_RESIDUAL_SUM_PRECONDITIONER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_RESIDUAL_SUM_PRECONDITIONER
private

Definition at line 81 of file AccelerationConfiguration.hpp.

◆ VALUE_SLIDE_RESTART

const std::string precice::acceleration::AccelerationConfiguration::VALUE_SLIDE_RESTART
private

Definition at line 85 of file AccelerationConfiguration.hpp.

◆ VALUE_SVD_RESTART

const std::string precice::acceleration::AccelerationConfiguration::VALUE_SVD_RESTART
private

Definition at line 84 of file AccelerationConfiguration.hpp.

◆ VALUE_VALUE_PRECONDITIONER

const std::string precice::acceleration::AccelerationConfiguration::VALUE_VALUE_PRECONDITIONER
private

Definition at line 79 of file AccelerationConfiguration.hpp.

◆ VALUE_ZERO_RESTART

const std::string precice::acceleration::AccelerationConfiguration::VALUE_ZERO_RESTART
private

Definition at line 83 of file AccelerationConfiguration.hpp.

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