Nektar::LibUtilities::NekSysOperators Class Reference

#include <NekSys.h>

Public Types
typedef const Array< OneD, const NekDouble >	InArrayType
typedef Array< OneD, NekDouble >	OutArrayType
typedef std::function< void(InArrayType &, OutArrayType &, const bool &)>	FunctorType1
typedef std::function< void(InArrayType &, InArrayType &, OutArrayType &, const bool &)>	FunctorType2
typedef Array< OneD, FunctorType1 >	FunctorType1Array
typedef Array< OneD, FunctorType2 >	FunctorType2Array

Public Member Functions
	NekSysOperators (void)
	NekSysOperators (const NekSysOperators &in)
NekSysOperators &	operator= (const NekSysOperators &in)
template<typename FuncPointerT , typename ObjectPointerT >
void	DefineNekSysResEval (FuncPointerT func, ObjectPointerT obj)
template<typename FuncPointerT , typename ObjectPointerT >
void	DefineNekSysLhsEval (FuncPointerT func, ObjectPointerT obj)
template<typename FuncPointerT , typename ObjectPointerT >
void	DefineNekSysPrecon (FuncPointerT func, ObjectPointerT obj)
template<typename FuncPointerT , typename ObjectPointerT >
void	DefineNekSysFixPointIte (FuncPointerT func, ObjectPointerT obj)
void	DoNekSysResEval (InArrayType &inarray, OutArrayType &outarray, const bool &flag=false) const
void	DoNekSysLhsEval (InArrayType &inarray, OutArrayType &outarray, const bool &flag=false) const
void	DoNekSysPrecon (InArrayType &inarray, OutArrayType &outarray, const bool &flag=false) const
void	DoNekSysFixPointIte (InArrayType &rhs, InArrayType &xn, OutArrayType &xn1, const bool &flag=false) const

Static Public Attributes
static const int	nfunctor1 = 3
static const int	nfunctor2 = 1

Protected Attributes
FunctorType1Array	m_functors1
FunctorType2Array	m_functors2

Detailed Description

Definition at line 53 of file NekSys.h.

Member Typedef Documentation

FunctorType1

typedef std::function<void(InArrayType &, OutArrayType &, const bool &)> Nektar::LibUtilities::NekSysOperators::FunctorType1

Definition at line 60 of file NekSys.h.

FunctorType1Array

typedef Array<OneD, FunctorType1> Nektar::LibUtilities::NekSysOperators::FunctorType1Array

Definition at line 64 of file NekSys.h.

FunctorType2

typedef std::function<void(InArrayType &, InArrayType &, OutArrayType &, const bool &)> Nektar::LibUtilities::NekSysOperators::FunctorType2

Definition at line 63 of file NekSys.h.

FunctorType2Array

typedef Array<OneD, FunctorType2> Nektar::LibUtilities::NekSysOperators::FunctorType2Array

Definition at line 65 of file NekSys.h.

InArrayType

typedef const Array<OneD, const NekDouble> Nektar::LibUtilities::NekSysOperators::InArrayType

Definition at line 56 of file NekSys.h.

OutArrayType

typedef Array<OneD, NekDouble> Nektar::LibUtilities::NekSysOperators::OutArrayType

Definition at line 57 of file NekSys.h.

Constructor & Destructor Documentation

NekSysOperators() [1/2]

Nektar::LibUtilities::NekSysOperators::NekSysOperators ( void  )

inline

Definition at line 69 of file NekSys.h.

                          : m_functors1(nfunctor1), m_functors2(nfunctor2)
    {
    }

NekSysOperators() [2/2]

Nektar::LibUtilities::NekSysOperators::NekSysOperators ( const NekSysOperators &  in )

inline

Definition at line 72 of file NekSys.h.

        : m_functors1(nfunctor1), m_functors2(nfunctor2)
    {
        for (int i = 0; i < nfunctor1; ++i)
        {
            m_functors1[i] = in.m_functors1[i];
        }
        for (int i = 0; i < nfunctor2; ++i)
        {
            m_functors2[i] = in.m_functors2[i];
        }
    }

References m_functors1, m_functors2, nfunctor1, and nfunctor2.

Member Function Documentation

DefineNekSysFixPointIte()

template<typename FuncPointerT , typename ObjectPointerT >

void Nektar::LibUtilities::NekSysOperators::DefineNekSysFixPointIte ( FuncPointerT  func, ObjectPointerT  obj  )

inline

Definition at line 121 of file NekSys.h.

    {
        m_functors2[0] =
            std::bind(func, obj, std::placeholders::_1, std::placeholders::_2,
                      std::placeholders::_3, std::placeholders::_4);
    }

References m_functors2.

DefineNekSysLhsEval()

template<typename FuncPointerT , typename ObjectPointerT >

void Nektar::LibUtilities::NekSysOperators::DefineNekSysLhsEval ( FuncPointerT  func, ObjectPointerT  obj  )

inline

Definition at line 107 of file NekSys.h.

    {
        m_functors1[1] =
            std::bind(func, obj, std::placeholders::_1, std::placeholders::_2,
                      std::placeholders::_3);
    }

References m_functors1.

Referenced by Nektar::CFSImplicit::InitialiseNonlinSysSolver(), and Nektar::MultiRegions::GlobalLinSysIterative::v_SolveLinearSystem().

DefineNekSysPrecon()

template<typename FuncPointerT , typename ObjectPointerT >

void Nektar::LibUtilities::NekSysOperators::DefineNekSysPrecon ( FuncPointerT  func, ObjectPointerT  obj  )

inline

Definition at line 114 of file NekSys.h.

    {
        m_functors1[2] =
            std::bind(func, obj, std::placeholders::_1, std::placeholders::_2,
                      std::placeholders::_3);
    }

References m_functors1.

Referenced by Nektar::CFSImplicit::InitialiseNonlinSysSolver(), and Nektar::MultiRegions::GlobalLinSysIterative::v_SolveLinearSystem().

DefineNekSysResEval()

template<typename FuncPointerT , typename ObjectPointerT >

void Nektar::LibUtilities::NekSysOperators::DefineNekSysResEval ( FuncPointerT  func, ObjectPointerT  obj  )

inline

Definition at line 100 of file NekSys.h.

    {
        m_functors1[0] =
            std::bind(func, obj, std::placeholders::_1, std::placeholders::_2,
                      std::placeholders::_3);
    }

References m_functors1.

Referenced by Nektar::CFSImplicit::InitialiseNonlinSysSolver().

DoNekSysFixPointIte()

void Nektar::LibUtilities::NekSysOperators::DoNekSysFixPointIte ( InArrayType &  rhs, InArrayType &  xn, OutArrayType &  xn1, const bool &  flag = false  ) const

inline

Definition at line 155 of file NekSys.h.

    {
        ASSERTL1(m_functors2[0], "DoNekSysFixPointIte should be defined");
        m_functors2[0](rhs, xn, xn1, flag);
    }

References ASSERTL1, and m_functors2.

Referenced by Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_SolveSystem().

DoNekSysLhsEval()

void Nektar::LibUtilities::NekSysOperators::DoNekSysLhsEval ( InArrayType &  inarray, OutArrayType &  outarray, const bool &  flag = false  ) const

inline

Definition at line 135 of file NekSys.h.

    {
        ASSERTL1(m_functors1[1], "DoNekSysLhsEval should be defined");
        m_functors1[1](inarray, outarray, flag);
    }

References ASSERTL1, and m_functors1.

Referenced by Nektar::LibUtilities::NekLinSysIterGMRES::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), and Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart().

DoNekSysPrecon()

void Nektar::LibUtilities::NekSysOperators::DoNekSysPrecon ( InArrayType &  inarray, OutArrayType &  outarray, const bool &  flag = false  ) const

inline

Definition at line 142 of file NekSys.h.

    {
        if (m_functors1[2])
        {
            m_functors1[2](inarray, outarray, flag);
        }
        else
        {
            Vmath::Vcopy(outarray.size(), inarray, 1, outarray, 1);
        }
    }

References m_functors1, and Vmath::Vcopy().

Referenced by Nektar::LibUtilities::NekLinSysIterGMRES::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), and Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart().

DoNekSysResEval()

void Nektar::LibUtilities::NekSysOperators::DoNekSysResEval ( InArrayType &  inarray, OutArrayType &  outarray, const bool &  flag = false  ) const

inline

Definition at line 128 of file NekSys.h.

    {
        ASSERTL1(m_functors1[0], "DoNekSysResEval should be defined");
        m_functors1[0](inarray, outarray, flag);
    }

References ASSERTL1, and m_functors1.

Referenced by Nektar::LibUtilities::NekNonlinSysNewton::v_SetupNekNonlinSystem(), and Nektar::LibUtilities::NekNonlinSysNewton::v_SolveSystem().

operator=()

NekSysOperators& Nektar::LibUtilities::NekSysOperators::operator= ( const NekSysOperators &  in )

inline

Definition at line 85 of file NekSys.h.

    {
        for (int i = 0; i < nfunctor1; ++i)
        {
            m_functors1[i] = in.m_functors1[i];
        }
        for (int i = 0; i < nfunctor2; ++i)
        {
            m_functors2[i] = in.m_functors2[i];
        }
 
        return *this;
    }

References m_functors1, m_functors2, nfunctor1, and nfunctor2.

Member Data Documentation

m_functors1

FunctorType1Array Nektar::LibUtilities::NekSysOperators::m_functors1

protected

Definition at line 183 of file NekSys.h.

Referenced by DefineNekSysLhsEval(), DefineNekSysPrecon(), DefineNekSysResEval(), DoNekSysLhsEval(), DoNekSysPrecon(), DoNekSysResEval(), NekSysOperators(), and operator=().

m_functors2

FunctorType2Array Nektar::LibUtilities::NekSysOperators::m_functors2

protected

Definition at line 184 of file NekSys.h.

Referenced by DefineNekSysFixPointIte(), DoNekSysFixPointIte(), NekSysOperators(), and operator=().

nfunctor1

const int Nektar::LibUtilities::NekSysOperators::nfunctor1 = 3

static

Definition at line 66 of file NekSys.h.

Referenced by NekSysOperators(), and operator=().

nfunctor2

const int Nektar::LibUtilities::NekSysOperators::nfunctor2 = 1

static

Definition at line 67 of file NekSys.h.

Referenced by NekSysOperators(), and operator=().