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

Abstract base class of various norms. More...

#include <norm.hh>

Detailed Description

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

Abstract base class of various norms.

This class represents a generic base class for an arbitrary norm of a vector of X's. It also implements certain functions necessary for integrate function in EulerSDC and are dependent on the norm in use.

Vector is usually a vector of type Dune::FieldVector and Matrix is of type Dune::FieldMatrix respectively.

Definition at line 58 of file norm.hh.

Inheritance diagram for Kaskade::Norm< Vector >:
Kaskade::MaxNorm< Vector > Kaskade::OneNorm< Vector >

Public Types

using field_type = typename Vector::value_type
 

Public Member Functions

virtual field_type value (std::vector< Vector > const &vecs)=0
 
virtual ~Norm ()
 

Member Typedef Documentation

◆ field_type

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

Definition at line 61 of file norm.hh.

Constructor & Destructor Documentation

◆ ~Norm()

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

Definition at line 74 of file norm.hh.

Member Function Documentation

◆ value()

template<class Vector >
virtual field_type Kaskade::Norm< Vector >::value ( std::vector< Vector > const &  vecs)
pure virtual
Parameters
vecs: the member function value takes in a vector of Vectors and computes its norm.
Returns
It returns the norm, which is usually of type double.

Implemented in Kaskade::OneNorm< Vector >, and Kaskade::MaxNorm< Vector >.

Referenced by Kaskade::normVecDiff(), and Kaskade::SDCUtil< Vector, Norm >::sdcContractionFactor().


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