Multiscale Universal Interface  2.0
A Concurrent Framework for Coupling Heterogeneous Solvers
mui::algo_aitken< CONFIG > Class Template Reference

#include <algo_aitken.h>

Public Types

using REAL = typename CONFIG::REAL
 
using INT = typename CONFIG::INT
 
using time_type = typename CONFIG::time_type
 
using iterator_type = typename CONFIG::iterator_type
 
using point_type = typename CONFIG::point_type
 

Public Member Functions

 algo_aitken (REAL under_relaxation_factor=1.0, REAL under_relaxation_factor_max=1.0, MPI_Comm local_comm=MPI_COMM_NULL, std::vector< std::pair< point_type, REAL >> pts_vlu_init=std::vector< std::pair< point_type, REAL >>(), REAL res_l2_norm_nm1=0.0)
 
template<typename OTYPE >
OTYPE relaxation (std::pair< time_type, iterator_type > t, point_type focus, OTYPE filtered_value) const
 
REAL get_under_relaxation_factor (time_type t_single)
 
REAL get_under_relaxation_factor (time_type t, iterator_type it)
 
REAL get_residual_L2_Norm (time_type t_single)
 
REAL get_residual_L2_Norm (time_type t, iterator_type it)
 

Protected Attributes

const REAL init_under_relaxation_factor_
 
const REAL under_relaxation_factor_max_
 
MPI_Comm local_mpi_comm_world_
 
iterator_type minimum_iterator_
 
std::vector< std::pair< std::pair< time_type, iterator_type >, REAL > > under_relaxation_factor_
 
std::vector< std::pair< std::pair< time_type, iterator_type >, std::pair< INT, REAL > > > residual_l2_norm_
 
std::vector< std::pair< std::pair< time_type, iterator_type >, std::vector< std::pair< point_type, REAL > > > > pts_time_value_
 
std::vector< std::pair< std::pair< time_type, iterator_type >, std::vector< std::pair< point_type, REAL > > > > pts_time_res_
 

Member Typedef Documentation

◆ INT

template<typename CONFIG = default_config>
using mui::algo_aitken< CONFIG >::INT = typename CONFIG::INT

◆ iterator_type

template<typename CONFIG = default_config>
using mui::algo_aitken< CONFIG >::iterator_type = typename CONFIG::iterator_type

◆ point_type

template<typename CONFIG = default_config>
using mui::algo_aitken< CONFIG >::point_type = typename CONFIG::point_type

◆ REAL

template<typename CONFIG = default_config>
using mui::algo_aitken< CONFIG >::REAL = typename CONFIG::REAL

◆ time_type

template<typename CONFIG = default_config>
using mui::algo_aitken< CONFIG >::time_type = typename CONFIG::time_type

Constructor & Destructor Documentation

◆ algo_aitken()

template<typename CONFIG = default_config>
mui::algo_aitken< CONFIG >::algo_aitken ( REAL  under_relaxation_factor = 1.0,
REAL  under_relaxation_factor_max = 1.0,
MPI_Comm  local_comm = MPI_COMM_NULL,
std::vector< std::pair< point_type, REAL >>  pts_vlu_init = std::vector<std::pair<point_typeREAL>>(),
REAL  res_l2_norm_nm1 = 0.0 
)
inline

Member Function Documentation

◆ get_residual_L2_Norm() [1/2]

template<typename CONFIG = default_config>
REAL mui::algo_aitken< CONFIG >::get_residual_L2_Norm ( time_type  t,
iterator_type  it 
)
inline

◆ get_residual_L2_Norm() [2/2]

template<typename CONFIG = default_config>
REAL mui::algo_aitken< CONFIG >::get_residual_L2_Norm ( time_type  t_single)
inline

◆ get_under_relaxation_factor() [1/2]

template<typename CONFIG = default_config>
REAL mui::algo_aitken< CONFIG >::get_under_relaxation_factor ( time_type  t,
iterator_type  it 
)
inline

◆ get_under_relaxation_factor() [2/2]

template<typename CONFIG = default_config>
REAL mui::algo_aitken< CONFIG >::get_under_relaxation_factor ( time_type  t_single)
inline

◆ relaxation()

template<typename CONFIG = default_config>
template<typename OTYPE >
OTYPE mui::algo_aitken< CONFIG >::relaxation ( std::pair< time_type, iterator_type t,
point_type  focus,
OTYPE  filtered_value 
) const
inline

Member Data Documentation

◆ init_under_relaxation_factor_

template<typename CONFIG = default_config>
const REAL mui::algo_aitken< CONFIG >::init_under_relaxation_factor_
protected

◆ local_mpi_comm_world_

template<typename CONFIG = default_config>
MPI_Comm mui::algo_aitken< CONFIG >::local_mpi_comm_world_
protected

◆ minimum_iterator_

template<typename CONFIG = default_config>
iterator_type mui::algo_aitken< CONFIG >::minimum_iterator_
protected

◆ pts_time_res_

template<typename CONFIG = default_config>
std::vector<std::pair<std::pair<time_type,iterator_type>,std::vector<std::pair<point_type, REAL> > > > mui::algo_aitken< CONFIG >::pts_time_res_
mutableprotected

◆ pts_time_value_

template<typename CONFIG = default_config>
std::vector<std::pair<std::pair<time_type,iterator_type>,std::vector<std::pair<point_type, REAL> > > > mui::algo_aitken< CONFIG >::pts_time_value_
mutableprotected

◆ residual_l2_norm_

template<typename CONFIG = default_config>
std::vector<std::pair<std::pair<time_type,iterator_type>,std::pair<INT, REAL> > > mui::algo_aitken< CONFIG >::residual_l2_norm_
mutableprotected

◆ under_relaxation_factor_

template<typename CONFIG = default_config>
std::vector<std::pair<std::pair<time_type,iterator_type>, REAL> > mui::algo_aitken< CONFIG >::under_relaxation_factor_
mutableprotected

◆ under_relaxation_factor_max_

template<typename CONFIG = default_config>
const REAL mui::algo_aitken< CONFIG >::under_relaxation_factor_max_
protected

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