KASKADE 7 development version
Public Types | Public Member Functions | List of all members
Kaskade::SDCUtilOneNorm< Vector, Norm > Class Template Reference

#include <util.hh>

Detailed Description

template<class Vector, class Norm>
class Kaskade::SDCUtilOneNorm< Vector, Norm >

Definition at line 315 of file util.hh.

Inheritance diagram for Kaskade::SDCUtilOneNorm< Vector, Norm >:
Kaskade::SDCUtil< Vector, Norm >

Public Types

using field_type = typename Vector::value_type
 
using RealVector = Dune::DynamicVector< double >
 
using RealMatrix = Dune::DynamicMatrix< double >
 

Public Member Functions

virtual RealVector const & computeAlphaVec (RealVector const &timePts, RealMatrix const &integrationMatrix, std::vector< Vector > const &yPrev, std::vector< Vector > const &yCurrent, std::vector< Vector > const &yNext)
 
virtual ~SDCUtilOneNorm ()
 
field_type sdcContractionFactor (std::vector< Vector > const &yPrev, std::vector< Vector > const &yCurrent, std::vector< Vector > const &yNext, Norm &norm)
 

Member Typedef Documentation

◆ field_type

template<class Vector , class Norm >
using Kaskade::SDCUtilOneNorm< Vector, Norm >::field_type = typename Vector::value_type

Definition at line 318 of file util.hh.

◆ RealMatrix

template<class Vector , class Norm >
using Kaskade::SDCUtilOneNorm< Vector, Norm >::RealMatrix = Dune::DynamicMatrix<double>

Definition at line 320 of file util.hh.

◆ RealVector

template<class Vector , class Norm >
using Kaskade::SDCUtilOneNorm< Vector, Norm >::RealVector = Dune::DynamicVector<double>

Definition at line 319 of file util.hh.

Constructor & Destructor Documentation

◆ ~SDCUtilOneNorm()

template<class Vector , class Norm >
virtual Kaskade::SDCUtilOneNorm< Vector, Norm >::~SDCUtilOneNorm ( )
inlinevirtual

Definition at line 360 of file util.hh.

Member Function Documentation

◆ computeAlphaVec()

template<class Vector , class Norm >
virtual RealVector const & Kaskade::SDCUtilOneNorm< Vector, Norm >::computeAlphaVec ( RealVector const &  timePts,
RealMatrix const &  integrationMatrix,
std::vector< Vector > const &  yPrev,
std::vector< Vector > const &  yCurrent,
std::vector< Vector > const &  yNext 
)
inlinevirtual
Parameters
timePts: Represents a vector of time points
integrationMatrix
yPrev
yCurrent
yNext
Returns

Implements Kaskade::SDCUtil< Vector, Norm >.

Definition at line 332 of file util.hh.

◆ sdcContractionFactor()

template<class Vector , class Norm >
Vector::value_type Kaskade::SDCUtil< Vector, Norm >::sdcContractionFactor ( std::vector< Vector > const &  yPrev,
std::vector< Vector > const &  yCurrent,
std::vector< Vector > const &  yNext,
Norm norm 
)
inherited

This function computes an estimate of the SDC contraction factor ( \( \rho \)) given three consecutive iterations of \( y \) and depends on the given norm. The estimate of \( \rho \) is given by:

\begin{eqnarray*} \rho & = & \frac{\|y^{[j+1]} - y^{[j]}\|}{\|y^{[j]} - y^{[j-1]}\| + \|y^{[j+1]} - y^{[j]}\|} \end{eqnarray*}

Parameters
[in]yPreva Vector denoting previous iterate of \( y \).
[in]yCurrenta Vector denoting current iterate of \( y \).
[in]yNexta Vector denoting next iterate of \( y \) as obtained from SDC iteration step.
[in]norman object of abstract base class type Norm, where we can provide the specific norm we consider for a problem.
Returns
\( \rho \) an estimate of the SDC contraction factor. Return type is Vector::field_type

Definition at line 466 of file util.hh.

Referenced by Kaskade::SDCUtilOneNorm< Vector, Norm >::computeAlphaVec().


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