Nektar::LibUtilities::NekNonlinSys Class Reference

#include <NekNonlinSys.h>

Inheritance diagram for Nektar::LibUtilities::NekNonlinSys:

Public Member Functions
	NekNonlinSys (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vComm, const int nDimen, const NekSysKey &pKey)
	~NekNonlinSys ()
virtual void	v_SetupNekNonlinSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, const Array< OneD, const NekDouble > &pSource, const int nDir)
const Array< OneD, const NekDouble > &	GetRefSolution () const
const Array< OneD, const NekDouble > &	GetRefResidual () const
const Array< OneD, const NekDouble > &	GetRefSourceVec () const
void	SetRefResidual (const Array< OneD, const NekDouble > &in)
void	SetNekNonlinSysTolerance (const NekDouble in)
void	SetNekNonlinSysMaxIterations (const unsigned int in)
const NekLinSysIterSharedPtr &	GetLinSys ()
void	SetNonlinIterTolRelativeL2 (const NekDouble in)
void	SetLinSysRelativeTolInNonlin (const NekDouble in)
int	GetNtotLinSysIts ()
Public Member Functions inherited from Nektar::LibUtilities::NekSys
	NekSys (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vComm, const int nDimen, const NekSysKey &pKey)
void	InitObject ()
virtual	~NekSys ()
void	SetSysOperators (const NekSysOperators &in)
const NekSysOperators &	GetSysOperators ()
int	SolveSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir, const NekDouble tol=1.0E-7, const NekDouble factor=1.0)
bool	ConvergenceCheck (const int nIteration, const Array< OneD, const NekDouble > &Residual, const NekDouble tol=1.0E-7)
virtual void	v_NekSysInitialGuess (const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pguess)
void	SetFlagWarnings (bool in)

Static Public Member Functions
static NekNonlinSysSharedPtr	CreateInstance (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vComm, const int nDimen, const NekSysKey &pKey)
Static Public Member Functions inherited from Nektar::LibUtilities::NekSys
static NekSysSharedPtr	CreateInstance (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vComm, const int nDimen, const NekSysKey &pKey)

Protected Member Functions
virtual void	v_InitObject ()
Protected Member Functions inherited from Nektar::LibUtilities::NekSys
virtual int	v_SolveSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir, const NekDouble tol, const NekDouble factor)
virtual bool	v_ConvergenceCheck (const int nIteration, const Array< OneD, const NekDouble > &Residual, const NekDouble tol)

Protected Attributes
NekLinSysIterSharedPtr	m_linsol
NekDouble	m_NonlinIterTolRelativeL2
NekDouble	m_LinSysRelativeTolInNonlin
std::string	m_LinSysIterSolverType
int	m_totalIterations = 0
int	m_NtotLinSysIts = 0
Array< OneD, NekDouble >	m_Solution
Array< OneD, NekDouble >	m_Residual
Array< OneD, NekDouble >	m_DeltSltn
Array< OneD, NekDouble >	m_SourceVec
bool	m_ResidualUpdated = false
Protected Attributes inherited from Nektar::LibUtilities::NekSys
int	m_maxiter
	Maximum iterations. More...
NekDouble	m_tolerance
	Tolerance of iterative solver. More...
LibUtilities::CommSharedPtr	m_Comm
	Communicate. More...
bool	m_converged
	Whether the iteration has been converged. More...
bool	m_root
	Root if parallel. More...
bool	m_verbose
	Verbose. More...
bool	m_FlagWarnings
NekSysOperators	m_operator
	Operators. More...
int	m_SysDimen
	The dimension of the system. More...

Friends
class	MemoryManager< NekNonlinSys >

Detailed Description

Solves a nonlinear system using iterative methods.

Definition at line 57 of file NekNonlinSys.h.

Constructor & Destructor Documentation

NekNonlinSys()

Nektar::LibUtilities::NekNonlinSys::NekNonlinSys	(	const LibUtilities::SessionReaderSharedPtr &	pSession,
		const LibUtilities::CommSharedPtr &	vComm,
		const int	nDimen,
		const NekSysKey &	pKey
	)

Definition at line 55 of file NekNonlinSys.cpp.

    : NekSys(pSession, vComm, nDimen, pKey)
{
    std::vector<std::string> variables(1);
    variables[0]    = pSession->GetVariable(0);
    string variable = variables[0];
 
    if (pSession->DefinesGlobalSysSolnInfo(variable, "NekNonlinSysTolerance"))
    {
        m_tolerance = boost::lexical_cast<NekDouble>(
            pSession->GetGlobalSysSolnInfo(variable, "NekNonlinSysTolerance")
                .c_str());
    }
    else
    {
        pSession->LoadParameter("NekNonlinSysTolerance", m_tolerance,
            pKey.m_NekNonlinSysTolerance);
    }
 
    if (pSession->DefinesGlobalSysSolnInfo(variable,
                                           "NekNonlinSysMaxIterations"))
    {
        m_maxiter = boost::lexical_cast<int>(
            pSession
                ->GetGlobalSysSolnInfo(variable, "NekNonlinSysMaxIterations")
                .c_str());
    }
    else
    {
        pSession->LoadParameter("NekNonlinSysMaxIterations", m_maxiter, 
            pKey.m_NekNonlinSysMaxIterations);
    }
 
    if (pSession->DefinesGlobalSysSolnInfo(variable, "NonlinIterTolRelativeL2"))
    {
        m_NonlinIterTolRelativeL2 = boost::lexical_cast<int>(
            pSession->GetGlobalSysSolnInfo(variable, "NonlinIterTolRelativeL2")
                .c_str());
    }
    else
    {
        pSession->LoadParameter("NonlinIterTolRelativeL2",
            m_NonlinIterTolRelativeL2, pKey.m_NonlinIterTolRelativeL2);
    }
 
    if (pSession->DefinesGlobalSysSolnInfo(variable,
                                           "LinSysRelativeTolInNonlin"))
    {
        m_LinSysRelativeTolInNonlin = boost::lexical_cast<int>(
            pSession
                ->GetGlobalSysSolnInfo(variable, "LinSysRelativeTolInNonlin")
                .c_str());
    }
    else
    {
        pSession->LoadParameter("LinSysRelativeTolInNonlin",
            m_LinSysRelativeTolInNonlin,
            pKey.m_LinSysRelativeTolInNonlin);
    }
 
    // cout << " m_LinSysRelativeTolInNonlin = " << m_LinSysRelativeTolInNonlin << endl;
 
    m_LinSysIterSolverType = pKey.m_LinSysIterSolverTypeInNonlin;
    if (pSession->DefinesGlobalSysSolnInfo(variable, 
            "LinSysIterSolverTypeInNonlin"))
    {
        m_LinSysIterSolverType =
            pSession->GetGlobalSysSolnInfo(variable, 
            "LinSysIterSolverTypeInNonlin");
    }
    else
    {
        if (pSession->DefinesSolverInfo("LinSysIterSolverTypeInNonlin"))
        {
            m_LinSysIterSolverType =
                pSession->GetSolverInfo("LinSysIterSolverTypeInNonlin");
        }
    }
 
    ASSERTL0(LibUtilities::GetNekLinSysIterFactory().ModuleExists(
                 m_LinSysIterSolverType),
             "NekLinSysIter '" + m_LinSysIterSolverType +
                 "' is not defined.\n");
                 
    m_linsol = LibUtilities::GetNekLinSysIterFactory().CreateInstance(
        m_LinSysIterSolverType, pSession, m_Comm, m_SysDimen, pKey);
    m_linsol->SetFlagWarnings(false);
}

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::LibUtilities::GetNekLinSysIterFactory(), Nektar::LibUtilities::NekSys::m_Comm, m_linsol, m_LinSysIterSolverType, Nektar::LibUtilities::NekSysKey::m_LinSysIterSolverTypeInNonlin, m_LinSysRelativeTolInNonlin, Nektar::LibUtilities::NekSysKey::m_LinSysRelativeTolInNonlin, Nektar::LibUtilities::NekSys::m_maxiter, Nektar::LibUtilities::NekSysKey::m_NekNonlinSysMaxIterations, Nektar::LibUtilities::NekSysKey::m_NekNonlinSysTolerance, m_NonlinIterTolRelativeL2, Nektar::LibUtilities::NekSysKey::m_NonlinIterTolRelativeL2, Nektar::LibUtilities::NekSys::m_SysDimen, and Nektar::LibUtilities::NekSys::m_tolerance.

~NekNonlinSys()

Nektar::LibUtilities::NekNonlinSys::~NekNonlinSys

(

)

Definition at line 152 of file NekNonlinSys.cpp.

{
}

Member Function Documentation

CreateInstance()

static NekNonlinSysSharedPtr Nektar::LibUtilities::NekNonlinSys::CreateInstance ( const LibUtilities::SessionReaderSharedPtr &  pSession, const LibUtilities::CommSharedPtr &  vComm, const int  nDimen, const NekSysKey &  pKey  )

inlinestatic

Definition at line 61 of file NekNonlinSys.h.

    {
        NekNonlinSysSharedPtr p =
            MemoryManager<NekNonlinSys>::AllocateSharedPtr(pSession, vComm,
                                                           nDimen, pKey);
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

GetLinSys()

const NekLinSysIterSharedPtr& Nektar::LibUtilities::NekNonlinSys::GetLinSys ( )

inline

Definition at line 122 of file NekNonlinSys.h.

    {
        return m_linsol;
    }

References m_linsol.

GetNtotLinSysIts()

int Nektar::LibUtilities::NekNonlinSys::GetNtotLinSysIts ( )

inline

Definition at line 137 of file NekNonlinSys.h.

    {
        return m_NtotLinSysIts;
    }

References m_NtotLinSysIts.

GetRefResidual()

const Array<OneD, const NekDouble>& Nektar::LibUtilities::NekNonlinSys::GetRefResidual ( ) const

inline

Definition at line 88 of file NekNonlinSys.h.

    {
        return m_Residual;
    }

References m_Residual.

GetRefSolution()

const Array<OneD, const NekDouble>& Nektar::LibUtilities::NekNonlinSys::GetRefSolution ( ) const

inline

Definition at line 82 of file NekNonlinSys.h.

    {
        return m_Solution;
    }

References m_Solution.

GetRefSourceVec()

const Array<OneD, const NekDouble>& Nektar::LibUtilities::NekNonlinSys::GetRefSourceVec ( ) const

inline

Definition at line 94 of file NekNonlinSys.h.

    {
        return m_SourceVec;
    }

References m_SourceVec.

SetLinSysRelativeTolInNonlin()

void Nektar::LibUtilities::NekNonlinSys::SetLinSysRelativeTolInNonlin ( const NekDouble  in )

inline

Definition at line 132 of file NekNonlinSys.h.

    {
        m_LinSysRelativeTolInNonlin = in;
    }

References m_LinSysRelativeTolInNonlin.

SetNekNonlinSysMaxIterations()

void Nektar::LibUtilities::NekNonlinSys::SetNekNonlinSysMaxIterations ( const unsigned int  in )

inline

Definition at line 115 of file NekNonlinSys.h.

    {
        m_maxiter = in;
    }

References Nektar::LibUtilities::NekSys::m_maxiter.

SetNekNonlinSysTolerance()

void Nektar::LibUtilities::NekNonlinSys::SetNekNonlinSysTolerance ( const NekDouble  in )

inline

Definition at line 110 of file NekNonlinSys.h.

    {
        m_tolerance = in;
    }

References Nektar::LibUtilities::NekSys::m_tolerance.

SetNonlinIterTolRelativeL2()

void Nektar::LibUtilities::NekNonlinSys::SetNonlinIterTolRelativeL2 ( const NekDouble  in )

inline

Definition at line 127 of file NekNonlinSys.h.

    {
        m_NonlinIterTolRelativeL2 = in;
    }

References m_NonlinIterTolRelativeL2.

SetRefResidual()

void Nektar::LibUtilities::NekNonlinSys::SetRefResidual ( const Array< OneD, const NekDouble > &  in )

inline

Definition at line 100 of file NekNonlinSys.h.

    {
        ASSERTL0(in.size() == m_SysDimen, 
            "SetRefResidual dimension not correct");
        Vmath::Vcopy(m_SysDimen, in, 1, m_Residual, 1);
        
        m_ResidualUpdated = true;
    }

References ASSERTL0, m_Residual, m_ResidualUpdated, Nektar::LibUtilities::NekSys::m_SysDimen, and Vmath::Vcopy().

v_InitObject()

void Nektar::LibUtilities::NekNonlinSys::v_InitObject ( )

protectedvirtual

Reimplemented from Nektar::LibUtilities::NekSys.

Reimplemented in Nektar::LibUtilities::NekNonlinSysNewton.

Definition at line 147 of file NekNonlinSys.cpp.

{
    NekSys::v_InitObject();
}

References Nektar::LibUtilities::NekSys::v_InitObject().

v_SetupNekNonlinSystem()

void Nektar::LibUtilities::NekNonlinSys::v_SetupNekNonlinSystem ( const int  nGlobal, const Array< OneD, const NekDouble > &  pInput, const Array< OneD, const NekDouble > &  pSource, const int  nDir  )

virtual

Reimplemented in Nektar::LibUtilities::NekNonlinSysNewton.

Definition at line 156 of file NekNonlinSys.cpp.

{
    boost::ignore_unused(nGlobal, pInput, pSource, nDir);
    NEKERROR(ErrorUtil::efatal, "v_SetupNekNonlinSystem not defined");
}

References Nektar::ErrorUtil::efatal, and NEKERROR.

Friends And Related Function Documentation

MemoryManager< NekNonlinSys >

friend class MemoryManager< NekNonlinSys >

friend

Definition at line 55 of file NekNonlinSys.h.

Member Data Documentation

m_DeltSltn

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSys::m_DeltSltn

protected

Definition at line 156 of file NekNonlinSys.h.

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

m_linsol

NekLinSysIterSharedPtr Nektar::LibUtilities::NekNonlinSys::m_linsol

protected

Definition at line 143 of file NekNonlinSys.h.

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

m_LinSysIterSolverType

std::string Nektar::LibUtilities::NekNonlinSys::m_LinSysIterSolverType

protected

Definition at line 148 of file NekNonlinSys.h.

Referenced by NekNonlinSys().

m_LinSysRelativeTolInNonlin

NekDouble Nektar::LibUtilities::NekNonlinSys::m_LinSysRelativeTolInNonlin

protected

Definition at line 146 of file NekNonlinSys.h.

Referenced by Nektar::LibUtilities::NekNonlinSysNewton::CalcInexactNewtonForcing(), NekNonlinSys(), and SetLinSysRelativeTolInNonlin().

m_NonlinIterTolRelativeL2

NekDouble Nektar::LibUtilities::NekNonlinSys::m_NonlinIterTolRelativeL2

protected

Definition at line 145 of file NekNonlinSys.h.

Referenced by NekNonlinSys(), SetNonlinIterTolRelativeL2(), and Nektar::LibUtilities::NekNonlinSysNewton::v_ConvergenceCheck().

m_NtotLinSysIts

int Nektar::LibUtilities::NekNonlinSys::m_NtotLinSysIts = 0

protected

Definition at line 151 of file NekNonlinSys.h.

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

m_Residual

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSys::m_Residual

protected

Definition at line 155 of file NekNonlinSys.h.

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

m_ResidualUpdated

bool Nektar::LibUtilities::NekNonlinSys::m_ResidualUpdated = false

protected

Definition at line 159 of file NekNonlinSys.h.

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

m_Solution

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSys::m_Solution

protected

Definition at line 154 of file NekNonlinSys.h.

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

m_SourceVec

Array<OneD, NekDouble> Nektar::LibUtilities::NekNonlinSys::m_SourceVec

protected

Definition at line 157 of file NekNonlinSys.h.

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

m_totalIterations

int Nektar::LibUtilities::NekNonlinSys::m_totalIterations = 0

protected

Definition at line 150 of file NekNonlinSys.h.