Nektar++
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Nektar::LibUtilities::NekSys Class Reference

#include <NekSys.h>

Inheritance diagram for Nektar::LibUtilities::NekSys:
[legend]

Public Member Functions

 NekSys (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)
 
virtual ~NekSys ()=default
 
void InitObject ()
 
int SolveSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir=0)
 
const NekSysOperators & GetSysOperators ()
 
void SetSysOperators (const NekSysOperators &in)
 
void SetFlagWarnings (bool in)
 
void SetRhsMagnitude (const NekDouble mag)
 

Static Public Member Functions

static NekSysSharedPtr CreateInstance (const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)
 

Protected Member Functions

virtual void v_InitObject ()
 
virtual void v_SetSysOperators (const NekSysOperators &in)
 
virtual int v_SolveSystem (const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir)
 

Protected Attributes

LibUtilities::CommSharedPtr m_rowComm
 
bool m_converged
 
bool m_root
 
bool m_verbose
 
bool m_FlagWarnings
 
int m_SysDimen
 
NekSysOperators m_operator
 
NekDouble m_rhs_magnitude = NekConstants::kNekUnsetDouble
 

Friends

class MemoryManager< NekSys >
 Support creation through MemoryManager.
 

Detailed Description

Solves a nonlinear or linear system.

Definition at line 244 of file NekSys.h.

Constructor & Destructor Documentation

◆ NekSys()

Nektar::LibUtilities::NekSys::NekSys ( const LibUtilities::SessionReaderSharedPtr &  pSession,
const LibUtilities::CommSharedPtr &  vRowComm,
const int  nDimen,
const NekSysKey &  pKey 
)

Definition at line 46 of file NekSys.cpp.

49{
50 m_rowComm = vRowComm;
51 m_root = m_rowComm->GetRank() == 0;
52 m_FlagWarnings = true;
53 m_verbose = pSession->DefinesCmdLineArgument("verbose");
54 m_converged = false;
55 m_SysDimen = nDimen;
56}
Nektar::LibUtilities::NekSys::m_rowComm
LibUtilities::CommSharedPtr m_rowComm
Definition NekSys.h:299

References m_converged, m_FlagWarnings, m_root, m_rowComm, m_SysDimen, and m_verbose.

◆ ~NekSys()

virtual Nektar::LibUtilities::NekSys::~NekSys ( )
virtualdefault

Member Function Documentation

◆ CreateInstance()

static NekSysSharedPtr Nektar::LibUtilities::NekSys::CreateInstance ( const LibUtilities::SessionReaderSharedPtr &  pSession,
const LibUtilities::CommSharedPtr &  vRowComm,
const int  nDimen,
const NekSysKey &  pKey 
)
inlinestatic

Definition at line 250 of file NekSys.h.

254 {
255 NekSysSharedPtr p = MemoryManager<NekSys>::AllocateSharedPtr(
256 pSession, vRowComm, nDimen, pKey);
257 return p;
258 }
Nektar::MemoryManager::AllocateSharedPtr
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
Definition NekMemoryManager.hpp:166
Nektar::LibUtilities::NekSysSharedPtr
std::shared_ptr< NekSys > NekSysSharedPtr
Definition NekSys.h:242
Nektar::UnitTests::p
std::vector< double > p(NPUPPER)

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

◆ GetSysOperators()

const NekSysOperators & Nektar::LibUtilities::NekSys::GetSysOperators ( )
inline

Definition at line 278 of file NekSys.h.

279 {
280 return m_operator;
281 }
Nektar::LibUtilities::NekSys::m_operator
NekSysOperators m_operator
Definition NekSys.h:306

References m_operator.

◆ InitObject()

void Nektar::LibUtilities::NekSys::InitObject ( )
inline

Definition at line 266 of file NekSys.h.

267 {
268 v_InitObject();
269 }
Nektar::LibUtilities::NekSys::v_InitObject
virtual void v_InitObject()
Definition NekSys.h:310

References v_InitObject().

◆ SetFlagWarnings()

void Nektar::LibUtilities::NekSys::SetFlagWarnings ( bool  in)
inline

Definition at line 288 of file NekSys.h.

289 {
290 m_FlagWarnings = in;
291 }

References m_FlagWarnings.

◆ SetRhsMagnitude()

void Nektar::LibUtilities::NekSys::SetRhsMagnitude ( const NekDouble  mag)
inline

Definition at line 293 of file NekSys.h.

294 {
295 m_rhs_magnitude = mag;
296 }

References m_rhs_magnitude.

◆ SetSysOperators()

void Nektar::LibUtilities::NekSys::SetSysOperators ( const NekSysOperators &  in)
inline

Definition at line 283 of file NekSys.h.

284 {
285 v_SetSysOperators(in);
286 }
Nektar::LibUtilities::NekSys::v_SetSysOperators
virtual void v_SetSysOperators(const NekSysOperators &in)
Definition NekSys.h:314

References v_SetSysOperators().

◆ SolveSystem()

int Nektar::LibUtilities::NekSys::SolveSystem ( const int  nGlobal,
const Array< OneD, const NekDouble > &  pInput,
Array< OneD, NekDouble > &  pOutput,
const int  nDir = 0 
)
inline

Definition at line 271 of file NekSys.h.

274 {
275 return v_SolveSystem(nGlobal, pInput, pOutput, nDir);
276 }
Nektar::LibUtilities::NekSys::v_SolveSystem
virtual int v_SolveSystem(const int nGlobal, const Array< OneD, const NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const int nDir)
Definition NekSys.h:319

References v_SolveSystem().

◆ v_InitObject()

virtual void Nektar::LibUtilities::NekSys::v_InitObject ( )
inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::NekLinSysIter, Nektar::LibUtilities::NekLinSysIterCG, Nektar::LibUtilities::NekLinSysIterCGLoc, Nektar::LibUtilities::NekLinSysIterFixedpointJacobi, Nektar::LibUtilities::NekLinSysIterGMRES, Nektar::LibUtilities::NekLinSysIterGMRESLoc, Nektar::LibUtilities::NekNonlinSysIter, and Nektar::LibUtilities::NekNonlinSysIterNewton.

Definition at line 310 of file NekSys.h.

311 {
312 }

Referenced by InitObject(), Nektar::LibUtilities::NekLinSysIter::v_InitObject(), and Nektar::LibUtilities::NekNonlinSysIter::v_InitObject().

◆ v_SetSysOperators()

virtual void Nektar::LibUtilities::NekSys::v_SetSysOperators ( const NekSysOperators &  in)
inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::NekNonlinSysIter.

Definition at line 314 of file NekSys.h.

315 {
316 m_operator = in;
317 }

References m_operator.

Referenced by SetSysOperators(), and Nektar::LibUtilities::NekNonlinSysIter::v_SetSysOperators().

◆ v_SolveSystem()

virtual int Nektar::LibUtilities::NekSys::v_SolveSystem ( const int  nGlobal,
const Array< OneD, const NekDouble > &  pInput,
Array< OneD, NekDouble > &  pOutput,
const int  nDir 
)
inlineprotectedvirtual

Reimplemented in Nektar::LibUtilities::NekLinSysIterCG, Nektar::LibUtilities::NekLinSysIterCGLoc, Nektar::LibUtilities::NekLinSysIterFixedpointJacobi, Nektar::LibUtilities::NekLinSysIterGMRES, Nektar::LibUtilities::NekNonlinSysIterNewton, and Nektar::LibUtilities::NekLinSysIterGMRESLoc.

Definition at line 319 of file NekSys.h.

324 {
325 ASSERTL0(false, "LinSysIterSolver NOT CORRECT.");
326 return 0;
327 }
ASSERTL0
#define ASSERTL0(condition, msg)
Definition ErrorUtil.hpp:216

References ASSERTL0.

Referenced by SolveSystem().

Friends And Related Symbol Documentation

◆ MemoryManager< NekSys >

friend class MemoryManager< NekSys >
friend

Support creation through MemoryManager.

Definition at line 237 of file NekSys.h.

Member Data Documentation

◆ m_converged

bool Nektar::LibUtilities::NekSys::m_converged
protected

Definition at line 300 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekNonlinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), NekSys(), Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_SolveSystem(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_FlagWarnings

bool Nektar::LibUtilities::NekSys::m_FlagWarnings
protected

Definition at line 303 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), NekSys(), SetFlagWarnings(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_operator

NekSysOperators Nektar::LibUtilities::NekSys::m_operator
protected

Definition at line 306 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterGMRES::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), GetSysOperators(), Nektar::LibUtilities::NekLinSysIter::Set_Rhs_Magnitude(), v_SetSysOperators(), Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_SolveSystem(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_rhs_magnitude

NekDouble Nektar::LibUtilities::NekSys::m_rhs_magnitude = NekConstants::kNekUnsetDouble
protected

Definition at line 308 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekNonlinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIter::Set_Rhs_Magnitude(), SetRhsMagnitude(), Nektar::LibUtilities::NekLinSysIterFixedpointJacobi::v_DoIterate(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_root

bool Nektar::LibUtilities::NekSys::m_root
protected

Definition at line 301 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), NekSys(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_rowComm

LibUtilities::CommSharedPtr Nektar::LibUtilities::NekSys::m_rowComm
protected

Definition at line 299 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekNonlinSysIter::ConvergenceCheck(), Nektar::LibUtilities::NekLinSysIterGMRES::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoArnoldi(), Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGmresRestart(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGmresRestart(), Nektar::LibUtilities::NekNonlinSysIter::NekNonlinSysIter(), NekSys(), and Nektar::LibUtilities::NekLinSysIter::Set_Rhs_Magnitude().

◆ m_SysDimen

int Nektar::LibUtilities::NekSys::m_SysDimen
protected

Definition at line 304 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekNonlinSysIter::NekNonlinSysIter(), NekSys(), Nektar::LibUtilities::NekLinSysIter::SetUniversalUniqueMap(), Nektar::LibUtilities::NekNonlinSysIter::v_InitObject(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

◆ m_verbose

bool Nektar::LibUtilities::NekSys::m_verbose
protected

Definition at line 302 of file NekSys.h.

Referenced by Nektar::LibUtilities::NekLinSysIterCGLoc::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterCG::DoConjugateGradient(), Nektar::LibUtilities::NekLinSysIterGMRESLoc::DoGMRES(), Nektar::LibUtilities::NekLinSysIterGMRES::DoGMRES(), NekSys(), and Nektar::LibUtilities::NekNonlinSysIterNewton::v_SolveSystem().

Generated on Sun Nov 9 2025 20:17:05 for Nektar++ by doxygen 1.9.8